Jump to

• Request
• Response

1a Subcontracts

post

/api/v1/import/insert-contracts

This API allows the user to import subcontract(s), using a unique combination of the parameters: ContractNumber, VendorID, and MainJobNumber. If the subcontract does not exist in Texura, Textura will create a new subcontract with the specified values. If the subcontract does exist in Textura and if the subcontract has not been completed (accepted by the subcontractors), the existing subcontract will be replaced with the subcontract import data.There are certain pre-conditions for a successful transaction:

• General Contractor is assigned to an SWS accounting package
• The Project has a unique internal project number set on the project
• General Contractor has not invited any subs for the projecty
• The REST Client payload or import file is prepared and ready for import

A URI is sent as a response to a succesful import POST. Sending a GET to the URI, provides the user with an audit file for the import. For an example of a more detailed payload, see the example section below.

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

• 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

{
    "required":[
        "ContractDate",
        "ContractDescription",
        "ContractNumber",
        "DefaultRetentionPercent",
        "MainJobNumber",
        "SubcontractAmount",
        "DiscountPercent",
        "DiscountWindow"
    ],
    "type":"object",
    "properties":{
        "ContractDate":{
            "type":"number",
            "description":"Date contract was created on ERP System [format: mmddyyyy].",
            "maxLength":6,
            "format":"timestamp",
            "example":10152020,
            "nullable":false
        },
        "ContractDescription":{
            "type":"string",
            "description":"Short description of the work.",
            "maxLength":3500,
            "example":"North Stair Concrete",
            "nullable":false
        },
        "ContractNumber":{
            "type":"string",
            "description":"Subcontract or Purchase Order Number.",
            "maxLength":500,
            "example":"17011S057",
            "nullable":false
        },
        "DefaultRetentionPercent":{
            "type":"number",
            "description":"The default retention amount at the subcontract level, usually 10%",
            "minLength":2,
            "maxLength":14,
            "example":10,
            "nullable":false
        },
        "MainJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":300,
            "example":"01-17011",
            "nullable":false
        },
        "SubcontractAmount":{
            "type":"number",
            "description":"The total dollar value of the subcontract.",
            "minLength":2,
            "maxLength":14,
            "example":45850,
            "nullable":false
        },
        "SubJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":60,
            "example":"17011",
            "nullable":true
        },
        "VendorId":{
            "type":"string",
            "description":"The subcontractor's (vendor) ID.",
            "maxLength":200,
            "example":"RON095",
            "nullable":true
        },
        "DiscountPercent":{
            "type":"number",
            "description":"Applicable discount percentage.",
            "minLength":4,
            "maxLength":14,
            "example":0,
            "nullable":false
        },
        "DiscountWindow":{
            "type":"number",
            "description":"Number of days after invoice approval required to be eligible for discount.",
            "minLength":4,
            "maxLength":14,
            "example":0,
            "nullable":false
        },
        "DoNotExceed":{
            "type":"number",
            "description":"Maximum amount a subcontractor can bill on the subcontract. International workflow only.",
            "minLength":2,
            "maxLength":14,
            "example":0,
            "nullable":true
        },
        "AccountCode":{
            "type":"string",
            "description":"Cost code / WBS code.",
            "nullable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Cost type / Category.",
            "nullable":true
        },
        "ComponentAmount":{
            "type":"string",
            "description":"Base amount for the component amount line item.",
            "nullable":true
        },
        "ComponentDescription":{
            "type":"string",
            "description":"Component description.",
            "nullable":true
        },
        "ComponentRetentionPercent":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SubcontractItemNumber":{
            "type":"string",
            "description":"Component item number. Will be used to post invoices against the specific subcontract line.",
            "nullable":true
        },
        "TaxCode":{
            "type":"string",
            "description":"Tax code to be used on invoices / payments. Each tax code should represent a specific tax rate.",
            "nullable":true
        },
        "PhaseCode":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "UnitofMeasure":{
            "type":"string",
            "description":"Unit of measurement",
            "nullable":true
        },
        "TaskSequence":{
            "type":"string",
            "description":"Task sequence.",
            "nullable":true
        },
        "UnitQuantity":{
            "type":"string",
            "description":"Item quantity. Defaults to the same value as ComponentAmount if subcontract will not use unit billing.",
            "nullable":true
        },
        "UnitPrice":{
            "type":"string",
            "description":"Defaults to 1 if subcontract will not use unit billing.",
            "nullable":true
        },
        "ComponentType":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "DefaultPaymentForm":{
            "type":"string",
            "description":"The default value will be ACH if omitted alternative option is MANUAL CHECK. Default is null.",
            "nullable":true
        },
        "SelfBilling":{
            "type":"string",
            "description":"International workflow only. Default is false.",
            "nullable":true
        },
        "ConstructionActDueDateOffset":{
            "type":"string",
            "description":"International workflow only. Default is null.",
            "nullable":true
        }
    }
}

Examples

Select an example Create Subcontracts

Back to Top

Response

Supported Media Types

• application/json

200 Response

The job was successfully created.

Body ()

Root Schema : schema

Type: object

Show Source

• URI: string
  Endpoint for job-audit retrieval

  Example: https://services.texturacorp.com/ebis/api/v1/import/insert-contracts/61

{
    "type":"object",
    "properties":{
        "URI":{
            "type":"string",
            "description":"Endpoint for job-audit retrieval",
            "example":"https://services.texturacorp.com/ebis/api/v1/import/insert-contracts/61",
            "nullable":true
        }
    }
}

Examples

Select an example Insert-contracts response Insert-contracts response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/import/insert-contracts

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/import/insert-contracts

Back to Top