2a Subcontracts Update
post
/api/v1/import/update-contracts
A successful import will update an existing subcontract in Textura. This API will not make any changes to the value of the subcontract or the number of components, it is intended for the updating of certain attributes on a subcontract in Textura. Example uses for this API:
- Updating the retention percent on a subcontract or components
- Updating the description of a component
- Updating the cost code orcategory or a component
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountCode: string
Cost code / WBS code.
-
CategoryCode: string
Cost type / Category.
-
ComponentAmount: string
Base amount for the component amount line item.
-
ComponentDescription: string
Component description.
-
ComponentRetentionPercent: string
Line-level retention for this component. Allowed retention percentage for this sov line, default to header record value if there is only one retention rate on this subcontract.
-
ComponentType: string
Enumeration values for this field are WORK, MATERIAL, ONSITE, OFFSITE and STANDARD. The ComponentType options MUST be lower-case and not be left as an empty string. Default is null if the ComponentType is omitted value automatically will be set to STANDARD.
-
ConstructionActDueDateOffset: string
International workflow only. Default is null.
-
ContractDate(required): number
(timestamp)
Maximum Length:
6
Date contract was created on ERP System [format: mmddyyyy].Example:10152020
-
ContractDescription(required): string
Maximum Length:
3500
Short description of the work.Example:North Stair Concrete
-
ContractNumber(required): string
Maximum Length:
500
Subcontract or Purchase Order Number.Example:17011S057
-
DefaultPaymentForm: string
The default value will be ACH if omitted alternative option is MANUAL CHECK. Default is null.
-
DefaultRetentionPercent(required): number
Minimum Length:
2
Maximum Length:14
The default retention amount at the subcontract level, usually 10%Example:10
-
DiscountPercent(required): number
Minimum Length:
4
Maximum Length:14
Applicable discount percentage.Example:0
-
DiscountWindow(required): number
Minimum Length:
4
Maximum Length:14
Number of days after invoice approval required to be eligible for discount.Example:0
-
DoNotExceed: number
Minimum Length:
2
Maximum Length:14
Maximum amount a subcontractor can bill on the subcontract. International workflow only.Example:0
-
MainJobNumber(required): string
Maximum Length:
300
The project/job this subcontract is written against.Example:01-17011
-
PhaseCode: string
Phase code from the prime contract schedule of values. Used to automatically assign detail line to a phase code on the prime contract???s schedule of value used to create owner invoices.
-
SelfBilling: string
International workflow only. Default is false.
-
SubcontractAmount(required): number
Minimum Length:
2
Maximum Length:14
The total dollar value of the subcontract.Example:45850
-
SubcontractItemNumber: string
Component item number. Will be used to post invoices against the specific subcontract line.
-
SubJobNumber: string
Maximum Length:
60
The project/job this subcontract is written against.Example:17011
-
TaskSequence: string
Task sequence.
-
TaxCode: string
Tax code to be used on invoices / payments. Each tax code should represent a specific tax rate.
-
UnitofMeasure: string
Unit of measurement
-
UnitPrice: string
Defaults to 1 if subcontract will not use unit billing.
-
UnitQuantity: string
Item quantity. Defaults to the same value as ComponentAmount if subcontract will not use unit billing.
-
VendorId: string
Maximum Length:
200
The subcontractor's (vendor) ID.Example:RON095
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
The job was successfully created.
Root Schema : schema
Type:
Show Source
object
-
URI: string
Endpoint for job-audit retrievalExample:
https://services.texturacorp.com/ebis/api/v1/import/update-contracts/3
Examples
Default Response
Links to working URLs
Links
- Production URL
-
https://services.texturacorp.com/ebis/api/v1/import/update-contracts
- Test URL
-
https://usint1.textura.oraclecloud.com/ebis/api/v1/import/update-contracts