Jump to

• Request
• Response

3 Document File Request

post

/api/v1/document-file

Organizations in the owner seat of a project are able to export documents via this API. The Document-meta API provides a listing of available documents for export, depending on parameters specified. This API allows for individual export of those available documents. Documents available to the Owner:

• GC documents - all documents signed on TPM, including invoice attachments, are available when the invoice is fully approved.
• Subcontractor documents - all documents signed on TPM, including invoice attachments, are available when the GC invoice is fully approved and Open Book is enabled.

This API can support the export of different document types. These document types can be specified in the request sent to the API. The following are examples of document types to be exported, if selected:

• Invoice
• Sworn Statement
• Lien Waiver
• Conditional Lien Waiver

This API allows the user to export the documents, using the URI provided by the Document-meta API. To view what documents are available for export, refer to the Document-meta API. If the user would like to export all available documents in a consolidated export, then the Export Documents API may offer a better option.

Request

Header Parameters

• Authentification(required):
  The protocol for the API requires a valid username and password for TPM.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Type: object

Show Source

• document_resource_uri: string
  The document URI must be contained within the payload in order to pull the file from the API

  Example: /api/v1/documents/document-file/250010/invoice-id/20110

{
    "type":"object",
    "properties":{
        "document_resource_uri":{
            "type":"string",
            "description":"The document URI must be contained within the payload in order to pull the file from the API",
            "example":"/api/v1/documents/document-file/250010/invoice-id/20110",
            "nullable":true
        }
    }
}

Examples

Select an example Document-file response

Back to Top

Response

Supported Media Types

• application/json

200 Response

The document is included in response.

Examples

Select an example Document-file response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/document-file

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/document-file

Back to Top