Jump to

• Request
• Response

1b Invoices Response

get

/api/v1/export/invoices/{jobID}

This API will provide the export of approved invoices. Textura has two methods of sending invoices that are requesting the release of previously held retention:

• In a separate invoice that only contains the retention released amounts. This invoice would use the client standard invoice number format but with an R appended to end of the string. A separate invoice, without the R, would be created to represent the progress billing portion of this invoice.
• As part of the same invoice record using the InvoiceRetentionRelease and ItemRetentionRelease fields.

A successful response will provide a uri that can be used to grab export data. User must send a GET request to the uri, with the proper credentials.

Request

Path Parameters

• jobID(required): integer(int64)
  Unique identifier of the job number.

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The job was successfully created.

Body ()

Root Schema : export-invoices

Type: object

Show Source

• AccountCode: string
  Account code of subcontract item being invoiced

  Example:
• Amount: string
  Portion of Tax Amount per Tax Percent

  Example:
• ApprovalDate: string
  Date the invoice was approved in TPM

  Example: 10162014
• ApproverUserName: string
  TPM user id of final approver

  Example: 1713374gc
• BankCode: string
  Bank code from ERP that will be used to pay the invoice

  Example: null
• CategoryCode: string
  Category Code

  Example:
• CISDeduction: string
  CIS deduction amount

  Example: 0.00
• CISDeductionPercent: string
  CIS deduction percentage

  Example: null
• DateCreated: string
  When the invoice contract record is created, and the invoice contract record is created when the subcontractor is invited to the draw

  Example: 10162014
• DefaultPaymentForm: string
  Payment Method setup ( ACH, etc..)

  Example: ACH
• DiscountDate: string
  Discount Date

  Example: null
• DrawDate: string
  TPM draw's due date

  Example: 10192014
• DrawNumber: string
  TPM Draw Number

  Example: 1
• EppEnrolled: string
  EPP Status of the subcontract

  Example: false
• EppInvoiced: string
  True if invoice will be paid through EPP

  Example: false
• FullAndFinal: string
  Indicates if full and final Invoice

  Example: false
• InvoiceDate: string
  TPM draw's period end date

  Example: 11152014
• InvoiceGrossAmount: string
  Approved Gross Amount of Invoice

  Example: 5000.00
• InvoiceModifiedFlag: string
  True if invoice was modified since last export

  Example: false
• InvoiceRetentionHeld: string
  Approved invoice retention held amount

  Example: 500.00
• InvoiceStatus: string
  Status of invoice of 1 equals approved

  Example: 1
• ItemGrossAmount: string
  Gross Amount

  Example: 2400.00
• ItemMaterialStored: string
  Stored Material amount

  Example: 0.00
• ItemPhaseCode: string
  Component Phase Code

  Example: 123
• ItemPhaseCodeDescription: string
  Prime SOV phase code description

  Example: GeneralConst
• ItemRetentionHeld: string
  Retention held amount

  Example: 250.00
• ItemTaxAmount: string
  Tax Amount

  Example: 0.00
• MainJobNumber: string
  Job Number

  Example: 1713374gc
• ModifiedInvoiceNumber: string
  Invoice Number with latest Revision

  Example: 1
• PaymentDueDate: string
  Payment due date if indicated

  Example: null
• Percentage: string
  Tax percent

  Example:
• PercentComplete: string
  Indicates total percentage complete

  Example: 2.50
• ProjectName: string
  Job Name

  Example: 1713374gc
• Quantity: string
  Quantity

  Example: 2400.0000
• RetentionIndicator: string
  R indicates the invoice has retention requested

  Example:
• RetentionReleaseTaxAmount: string
  Tax amount on retention release portion of invoice

  Example: 0.00
• RevisionNumber: string
  Revision ID of invoice

  Example:
• SelfBilling: string
  False or true ( true applicable for UK)

  Example: false
• SubcontractItemNumber: string
  Item number of line being invoiced

  Example:
• SubcontractNumber: string
  Subcontract Number

  Example: 3
• SubcontractorName: string
  Name of Subcontractor

  Example: swssub1
• SubInvoiceNumber: string
  Invoice Number

  Example: 1
• SubJobNumber: string
  Sub job number

  Example:
• SubmittedGrossAmount: string
  Gross amount requested by subcontractor

  Example: 0.00
• SubmittedMaterialStored: string
  Stored material amount originally requested by subcontractor

  Example: 0.00
• SubmittedRetentionHeld: string
  Retention held amount originally requested by subcontractor

  Example: 0.00
• SubmittedRetentionRelease: string
  Retention Release originally requested by subcontractor

  Example: 0.00
• TaskSequence: string
  Unique ID (deprecated)

  Example:
• TaxAmount: string
  Tax Amount

  Example: 0.00
• TaxCode: string
  Tax Code

  Example:
• TaxDistribution: string
  Example: null
• UnitOfMeasure: string
  Unit of measurement

  Example: each
• UnitPrice: string
  Unit Price

  Example: 1.000000
• VaultedDocumentDate: string
  Date sub signed Invoice

  Example: 10162014
• VendorID: string
  Vendor ID

  Example:
• WorkLiableForCISDeduction: string
  Portion of the invoice that is liable for CIS deductions

  Example: 0.00

{
    "type":"object",
    "properties":{
        "InvoiceGrossAmount":{
            "type":"string",
            "description":"Approved Gross Amount of Invoice",
            "example":"5000.00",
            "nullable":true
        },
        "TaxAmount":{
            "type":"string",
            "description":"Tax Amount",
            "example":"0.00",
            "nullable":true
        },
        "SubmittedGrossAmount":{
            "type":"string",
            "description":"Gross amount requested by subcontractor",
            "example":"0.00",
            "nullable":true
        },
        "ApproverUserName":{
            "type":"string",
            "description":"TPM user id of final approver",
            "example":"1713374gc",
            "nullable":true
        },
        "InvoiceStatus":{
            "type":"string",
            "description":"Status of invoice of 1 equals approved",
            "example":"1",
            "nullable":true
        },
        "EppEnrolled":{
            "type":"string",
            "description":"EPP Status of the subcontract",
            "example":"false",
            "nullable":true
        },
        "RetentionIndicator":{
            "type":"string",
            "description":"R indicates the invoice has retention requested",
            "example":"",
            "nullable":true
        },
        "DrawNumber":{
            "type":"string",
            "description":"TPM Draw Number",
            "example":"1",
            "nullable":true
        },
        "FullAndFinal":{
            "type":"string",
            "description":"Indicates if full and final Invoice",
            "example":"false",
            "nullable":true
        },
        "PercentComplete":{
            "type":"string",
            "description":"Indicates total percentage complete",
            "example":"2.50",
            "nullable":true
        },
        "SubmittedRetentionRelease":{
            "type":"string",
            "description":"Retention Release originally requested by subcontractor",
            "example":"0.00",
            "nullable":true
        },
        "InvoiceModifiedFlag":{
            "type":"string",
            "description":"True if invoice was modified since last export",
            "example":"false",
            "nullable":true
        },
        "ModifiedInvoiceNumber":{
            "type":"string",
            "description":"Invoice Number with latest Revision",
            "example":"1",
            "nullable":true
        },
        "PaymentDueDate":{
            "type":"string",
            "description":"Payment due date if indicated",
            "example":"null",
            "nullable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"TPM draw's period end date",
            "example":"11152014",
            "nullable":true
        },
        "SubmittedRetentionHeld":{
            "type":"string",
            "description":"Retention held amount originally requested by subcontractor",
            "example":"0.00",
            "nullable":true
        },
        "VendorID":{
            "type":"string",
            "description":"Vendor ID",
            "example":"",
            "nullable":true
        },
        "InvoiceRetentionHeld":{
            "type":"string",
            "description":"Approved invoice retention held amount",
            "example":"500.00",
            "nullable":true
        },
        "SubcontractorName":{
            "type":"string",
            "description":"Name of Subcontractor",
            "example":"swssub1",
            "nullable":true
        },
        "CISDeduction":{
            "type":"string",
            "description":"CIS deduction amount",
            "example":"0.00",
            "nullable":true
        },
        "RevisionNumber":{
            "type":"string",
            "description":"Revision ID of invoice",
            "example":"",
            "nullable":true
        },
        "EppInvoiced":{
            "type":"string",
            "description":"True if invoice will be paid through EPP",
            "example":"false",
            "nullable":true
        },
        "DrawDate":{
            "type":"string",
            "description":"TPM draw's due date",
            "example":"10192014",
            "nullable":true
        },
        "ApprovalDate":{
            "type":"string",
            "description":"Date the invoice was approved in TPM",
            "example":"10162014",
            "nullable":true
        },
        "SubmittedMaterialStored":{
            "type":"string",
            "description":"Stored material amount originally requested by subcontractor",
            "example":"0.00",
            "nullable":true
        },
        "CISDeductionPercent":{
            "type":"string",
            "description":"CIS deduction percentage",
            "example":"null",
            "nullable":true
        },
        "RetentionReleaseTaxAmount":{
            "type":"string",
            "description":"Tax amount on retention release portion of invoice",
            "example":"0.00",
            "nullable":true
        },
        "MainJobNumber":{
            "type":"string",
            "description":"Job Number",
            "example":"1713374gc",
            "nullable":true
        },
        "ProjectName":{
            "type":"string",
            "description":"Job Name",
            "example":"1713374gc",
            "nullable":true
        },
        "DateCreated":{
            "type":"string",
            "description":"When the invoice contract record is created, and the invoice contract record is created when the subcontractor is invited to the draw",
            "example":"10162014",
            "nullable":true
        },
        "BankCode":{
            "type":"string",
            "description":"Bank code from ERP that will be used to pay the invoice",
            "example":"null",
            "nullable":true
        },
        "SubcontractNumber":{
            "type":"string",
            "description":"Subcontract Number",
            "example":"3",
            "nullable":true
        },
        "SubInvoiceNumber":{
            "type":"string",
            "description":"Invoice Number",
            "example":"1",
            "nullable":true
        },
        "WorkLiableForCISDeduction":{
            "type":"string",
            "description":"Portion of the invoice that is liable for CIS deductions",
            "example":"0.00",
            "nullable":true
        },
        "DefaultPaymentForm":{
            "type":"string",
            "description":"Payment Method setup ( ACH, etc..)",
            "example":"ACH",
            "nullable":true
        },
        "SelfBilling":{
            "type":"string",
            "description":"False or true ( true applicable for UK)",
            "example":"false",
            "nullable":true
        },
        "VaultedDocumentDate":{
            "type":"string",
            "description":"Date sub signed Invoice",
            "example":"10162014",
            "nullable":true
        },
        "Amount":{
            "type":"string",
            "description":"Portion of Tax Amount per Tax Percent",
            "example":"",
            "nullable":true
        },
        "Percentage":{
            "type":"string",
            "description":"Tax percent",
            "example":"",
            "nullable":true
        },
        "TaxCode":{
            "type":"string",
            "description":"Tax Code",
            "example":"",
            "nullable":true
        },
        "TaxDistribution":{
            "type":"string",
            "description":"",
            "example":"null",
            "nullable":true
        },
        "AccountCode":{
            "type":"string",
            "description":"Account code of subcontract item being invoiced",
            "example":"",
            "nullable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measurement",
            "example":"each",
            "nullable":true
        },
        "ItemMaterialStored":{
            "type":"string",
            "description":"Stored Material amount",
            "example":"0.00",
            "nullable":true
        },
        "ItemRetentionHeld":{
            "type":"string",
            "description":"Retention held amount",
            "example":"250.00",
            "nullable":true
        },
        "SubcontractItemNumber":{
            "type":"string",
            "description":"Item number of line being invoiced",
            "example":"",
            "nullable":true
        },
        "ItemPhaseCodeDescription":{
            "type":"string",
            "description":"Prime SOV phase code description",
            "example":"GeneralConst",
            "nullable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Category Code",
            "example":"",
            "nullable":true
        },
        "TaskSequence":{
            "type":"string",
            "description":"Unique ID (deprecated)",
            "example":"",
            "nullable":true
        },
        "ItemGrossAmount":{
            "type":"string",
            "description":"Gross Amount",
            "example":"2400.00",
            "nullable":true
        },
        "DiscountDate":{
            "type":"string",
            "description":"Discount Date",
            "example":"null",
            "nullable":true
        },
        "ItemTaxAmount":{
            "type":"string",
            "description":"Tax Amount",
            "example":"0.00",
            "nullable":true
        },
        "SubJobNumber":{
            "type":"string",
            "description":"Sub job number",
            "example":"",
            "nullable":true
        },
        "ItemPhaseCode":{
            "type":"string",
            "description":"Component Phase Code",
            "example":"123",
            "nullable":true
        },
        "UnitPrice":{
            "type":"string",
            "description":"Unit Price",
            "example":"1.000000",
            "nullable":true
        },
        "Quantity":{
            "type":"string",
            "description":"Quantity",
            "example":"2400.0000",
            "nullable":true
        }
    }
}

Examples

Select an example Export invoices response

202 Response

Accepted. Encountered when the requestor has asked for request export data or an audit log, but the request is still in process.

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/export/invoices/{jobID}

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/export/invoices/{jobID}

Back to Top