1a Invoices Request
post
/api/v1/export/invoices
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
Header Parameters
-
Authentification(required):
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
-
AccountCode: string
Account code of subcontract item being invoicedExample:
-
Amount: string
Portion of Tax Amount per Tax PercentExample:
-
ApprovalDate: string
Date the invoice was approved in TPMExample:
10162014
-
ApproverUserName: string
TPM user id of final approverExample:
1713374gc
-
BankCode: string
Bank code from ERP that will be used to pay the invoiceExample:
null
-
CategoryCode: string
Category CodeExample:
-
CISDeduction: string
CIS deduction amountExample:
0.00
-
CISDeductionPercent: string
CIS deduction percentageExample:
null
-
DateCreated: string
When the invoice contract record is created, and the invoice contract record is created when the subcontractor is invited to the drawExample:
10162014
-
DefaultPaymentForm: string
Payment Method setup ( ACH, etc..)Example:
ACH
-
DiscountDate: string
Discount DateExample:
null
-
DrawDate: string
TPM draw's due dateExample:
10192014
-
DrawNumber: string
TPM Draw NumberExample:
1
-
EppEnrolled: string
EPP Status of the subcontractExample:
false
-
EppInvoiced: string
True if invoice will be paid through EPPExample:
false
-
FullAndFinal: string
Indicates if full and final InvoiceExample:
false
-
InvoiceDate: string
TPM draw's period end dateExample:
11152014
-
InvoiceGrossAmount: string
Approved Gross Amount of InvoiceExample:
5000.00
-
InvoiceModifiedFlag: string
True if invoice was modified since last exportExample:
false
-
InvoiceRetentionHeld: string
Approved invoice retention held amountExample:
500.00
-
InvoiceStatus: string
Status of invoice of 1 equals approvedExample:
1
-
ItemGrossAmount: string
Gross AmountExample:
2400.00
-
ItemMaterialStored: string
Stored Material amountExample:
0.00
-
ItemPhaseCode: string
Component Phase CodeExample:
123
-
ItemPhaseCodeDescription: string
Prime SOV phase code descriptionExample:
GeneralConst
-
ItemRetentionHeld: string
Retention held amountExample:
250.00
-
ItemTaxAmount: string
Tax AmountExample:
0.00
-
MainJobNumber: string
Job NumberExample:
1713374gc
-
ModifiedInvoiceNumber: string
Invoice Number with latest RevisionExample:
1
-
PaymentDueDate: string
Payment due date if indicatedExample:
null
-
Percentage: string
Tax percentExample:
-
PercentComplete: string
Indicates total percentage completeExample:
2.50
-
ProjectName: string
Job NameExample:
1713374gc
-
Quantity: string
QuantityExample:
2400.0000
-
RetentionIndicator: string
R indicates the invoice has retention requestedExample:
-
RetentionReleaseTaxAmount: string
Tax amount on retention release portion of invoiceExample:
0.00
-
RevisionNumber: string
Revision ID of invoiceExample:
-
SelfBilling: string
False or true ( true applicable for UK)Example:
false
-
SubcontractItemNumber: string
Item number of line being invoicedExample:
-
SubcontractNumber: string
Subcontract NumberExample:
3
-
SubcontractorName: string
Name of SubcontractorExample:
swssub1
-
SubInvoiceNumber: string
Invoice NumberExample:
1
-
SubJobNumber: string
Sub job numberExample:
-
SubmittedGrossAmount: string
Gross amount requested by subcontractorExample:
0.00
-
SubmittedMaterialStored: string
Stored material amount originally requested by subcontractorExample:
0.00
-
SubmittedRetentionHeld: string
Retention held amount originally requested by subcontractorExample:
0.00
-
SubmittedRetentionRelease: string
Retention Release originally requested by subcontractorExample:
0.00
-
TaskSequence: string
Unique ID (deprecated)Example:
-
TaxAmount: string
Tax AmountExample:
0.00
-
TaxCode: string
Tax CodeExample:
-
TaxDistribution: string
Example:
null
-
UnitOfMeasure: string
Unit of measurementExample:
each
-
UnitPrice: string
Unit PriceExample:
1.000000
-
VaultedDocumentDate: string
Date sub signed InvoiceExample:
10162014
-
VendorID: string
Vendor IDExample:
-
WorkLiableForCISDeduction: string
Portion of the invoice that is liable for CIS deductionsExample:
0.00
Response
Supported Media Types
- application/json
200 Response
The job was successfully created.
Root Schema : schema
Type:
Show Source
object
-
URI: string
Endpoint for export record retrievalExample:
https://services.texturacorp.com/ebis/api/v1/export/invoices/82
Examples
Default Response
Links
- Production URL
-
https://services.texturacorp.com/ebis/api/v1/export/invoices
- Test URL
-
https://usint1.textura.oraclecloud.com/ebis/api/v1/export/invoices