Jump to

• Request
• Response

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.

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

A successful request to this API will provide a listing of available documents for export. To export these records, individually, the user must use the Document-file 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

• 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

{
    "type":"object",
    "properties":{
        "projectNumber":{
            "type":"string",
            "description":"TPM project number.",
            "example":"AT100",
            "nullable":true
        },
        "invoiceNumber":{
            "type":"string",
            "description":"If submitted must be provided in conjunction with vendor id and project number.",
            "example":"",
            "nullable":true
        },
        "vendorID":{
            "type":"string",
            "description":"Must be provided if using the invoice number and project number fields.",
            "example":"brch002",
            "nullable":true
        },
        "includeExported":{
            "type":"boolean",
            "description":"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,
            "nullable":true
        },
        "documentTypes":{
            "description":"If not provided, provides all types. Types include: invoice, swornstatement, invoicecover, condlw, uncondlw, uploadeduncondlw, uploadedcondlw, masiapproval, coattach, icattach, workinvoice, paymentschedule.",
            "example":"",
            "nullable":true
        },
        "documentFromDate":{
            "type":"string",
            "description":"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",
            "nullable":true
        },
        "documentToDate":{
            "type":"string",
            "description":"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",
            "nullable":true
        },
        "includeUnapprovedDoc":{
            "type":"boolean",
            "description":"If set to true, will allow for the inclusion of draw documents prior to being approved by the owner.",
            "example":true,
            "nullable":true
        }
    }
}

Examples

Select an example Look at available documents

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• 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 organization

  Example: 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

{
    "type":"object",
    "properties":{
        "date_created":{
            "type":"string",
            "description":"File creation date.",
            "example":"2020-05-08T10:30:10Z",
            "nullable":true
        },
        "document_id":{
            "type":"number",
            "description":"Unique identifier representing a specific document in the database table determined by type.",
            "example":250010,
            "nullable":true
        },
        "document_resource_uri":{
            "type":"string",
            "description":"Document resource URL. Used in the retrieval of documents.",
            "example":"/api/v1/documents/document-file/250010/invoice-id/22530",
            "nullable":true
        },
        "document_type":{
            "type":"string",
            "description":"Type of document for export.",
            "example":"invoice",
            "nullable":true
        },
        "draw_number":{
            "type":"number",
            "description":"TPM draw number.",
            "example":1,
            "nullable":true
        },
        "draw_period_to":{
            "type":"string",
            "description":"",
            "example":"2022-03-27T00:00:00Z",
            "nullable":true
        },
        "generated_by_org":{
            "type":"string",
            "description":"Organization that document originated from.",
            "example":"aggc22",
            "nullable":true
        },
        "generated_by_org_type":{
            "type":"string",
            "description":"Type of organization",
            "example":"GC",
            "nullable":true
        },
        "invoice_contract_id":{
            "type":"number",
            "description":"",
            "example":120000,
            "nullable":true
        },
        "invoice_number":{
            "type":"string",
            "description":"",
            "example":"1",
            "nullable":true
        },
        "mime_type":{
            "type":"string",
            "description":"",
            "example":"application/pdf",
            "nullable":true
        },
        "project_number":{
            "type":"string",
            "description":"",
            "example":"p-8000700",
            "nullable":true
        },
        "vendor_id":{
            "type":"string",
            "description":"Endpoint for export record retrieval.",
            "example":"brch002",
            "nullable":true
        }
    }
}

Examples

Select an example Document-meta response

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

Back to Top