2 Document Meta Data Request
post
/api/v1/document-meta
Organizations in the owner seat of a project are able to export documents via this API. This API provides the entire list of available documents, depending on the parameters specified by the user. These documents can extend over multiple projects. 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.
- Invoice
- Sworn Statement
- Lien Waiver
- Conditional Lien Waiver
Request
Header Parameters
-
Authentification(required): string
The protocol for the API requires a valid username and password for TPM.
Supported Media Types
- application/json
- application/json
Root Schema : schema
Type:
Show Source
object
-
documentFromDate: string
Allow to specify the from date in the date range to pull documents based on draw end date. If documentToDate is specified than this field cannot be null or empty. Date needs to be formatted as YYYY-MM-DD.Example:
2022-09-01
-
documentToDate: string
Allow to specify the to date in the date range, to pull documents based on the draw end dates. If documentFromDate is specificed, than this field cannot be null or empty. Date needs to be formated as YYYY-MM-DD.Example:
2023-03-01
-
documentTypes:
If not provided, provides all types. Types include: invoice, swornstatement, invoicecover, condlw, uncondlw, uploadeduncondlw, uploadedcondlw, masiapproval, coattach, icattach, workinvoice, paymentschedule.Example:
-
includeExported: boolean
Defaults to false. If set to true, the user must provide, at least, projectNumber as a field. If the user does not, the API returns with an error.Example:
true
-
includeUnapprovedDoc: boolean
If set to true, will allow for the inclusion of draw documents prior to being approved by the owner.Example:
true
-
invoiceNumber: string
If submitted must be provided in conjunction with vendor id and project number.Example:
-
projectNumber: string
TPM project number.Example:
AT100
-
vendorID: string
Must be provided if using the invoice number and project number fields.Example:
brch002
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Root Schema : schema
Type:
Show Source
object
-
date_created: string
File creation date.Example:
2020-05-08T10:30:10Z
-
document_id: number
Unique identifier representing a specific document in the database table determined by type.Example:
250010
-
document_resource_uri: string
Document resource URL. Used in the retrieval of documents.Example:
/api/v1/documents/document-file/250010/invoice-id/22530
-
document_type: string
Type of document for export.Example:
invoice
-
draw_number: number
TPM draw number.Example:
1
-
draw_period_to: string
Example:
2022-03-27T00:00:00Z
-
generated_by_org: string
Organization that document originated from.Example:
aggc22
-
generated_by_org_type: string
Type of organizationExample:
GC
-
invoice_contract_id: number
Example:
120000
-
invoice_number: string
Example:
1
-
mime_type: string
Example:
application/pdf
-
project_number: string
Example:
p-8000700
-
vendor_id: string
Endpoint for export record retrieval.Example:
brch002
Examples
Default Response
Links to working URLs
Links
- Production URL
-
https://services.texturacorp.com/ebis/api/v1/document-meta
- Test URL
-
https://usint1.textura.oraclecloud.com/ebis/api/v1/document-meta