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 Project. In order for subcontracts to be created, a project must exist prior to subcontract creation. 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.

The successful import of a subcontract involves a structured approach that consists of two key elements: subcontract specifications and subcontract component specifications. Subcontract specifications outline the general requirements and terms associated with identifying the subcontract to be made, while subcontract component specifications provide more detailed budgetline information for the subcontract. When navigating the parameters associated with this API, it is important to recognize that the components parameter is an array that contains multiple sub-parameters. This array is allows the user to define budgetline information as well as detail unit billing information. For further clarification on the components parameter and general payload syntax, users are encouraged to review the request body section and to refer to the payload examples.

Request

Header Parameters

• Authentification(required): string
  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

• Components(required): array Components
  Subcontract components.
• 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

  Denotes the identification number of the contract, for a project.

  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 amount withheld until project completion or authorization, known as retention, in the form of a percentage. Typically this value is around 10%.

  Example: 10
• DiscountPercent(required): number
  Minimum Length: 4

  Maximum Length: 14

  Applicable discount percentage.

  Example: 0
• DiscountWindow: number
  Minimum Length: 4

  Maximum Length: 14

  Number of days after invoice approval required to be eligible for discount.

  Example: 0
• DiscountWindowType: number
  0 defines a window within N business days, 1 defines the window before Nth day of next month

  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 that the imported subcontract will be written into.

  Example: 01-17011
• PayWhenPaidGracePeriod: number
  A value that can be set to offset the payment due date.
• 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
• SubJobNumber: string
  Maximum Length: 60

  This denotes the identification number of the subcontract or purchase order number, for a project.

  Example: 17011
• VendorId: string
  Maximum Length: 200

  A subcontractor can be assigned a Vendor ID for subcontracts, allowing for easier identification in subcontract usage.

  Example: RON095

{
    "required":[
        "ContractDate",
        "ContractDescription",
        "ContractNumber",
        "DefaultRetentionPercent",
        "MainJobNumber",
        "SubcontractAmount",
        "DiscountPercent",
        "Components"
    ],
    "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":"Denotes the identification number of the contract, for a project.",
            "maxLength":"500",
            "example":"17011S057",
            "nullable":false
        },
        "DefaultRetentionPercent":{
            "type":"number",
            "description":"The default amount withheld until project completion or authorization, known as retention, in the form of a percentage. Typically this value is around 10%.",
            "minLength":"2",
            "maxLength":"14",
            "example":"10",
            "nullable":false
        },
        "MainJobNumber":{
            "type":"string",
            "description":"The project that the imported subcontract will be written into.",
            "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":"This denotes the identification number of the subcontract or purchase order number, for a project.",
            "maxLength":"60",
            "example":"17011",
            "nullable":true
        },
        "VendorId":{
            "type":"string",
            "description":"A subcontractor can be assigned a Vendor ID for subcontracts, allowing for easier identification in subcontract usage.",
            "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
        },
        "DiscountWindowType":{
            "type":"number",
            "description":"0 defines a window within N business days, 1 defines the window before Nth day of next month",
            "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
        },
        "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
        },
        "PayWhenPaidGracePeriod":{
            "type":"number",
            "description":"A value that can be set to offset the payment due date.",
            "nullable":true
        },
        "Components":{
            "type":"array",
            "description":"Subcontract components.",
            "items":{
                "$ref":"#/components/schemas/Components"
            }
        }
    }
}

Nested Schema : Components

Type: array

Subcontract components.

Show Source

• Array of: object Components

{
    "type":"array",
    "description":"Subcontract components.",
    "items":{
        "$ref":"#/components/schemas/Components"
    }
}

Nested Schema : Components

Type: object

Show Source

• AccountCode: string
  Cost code / WBS code.
• CategoryCode: string
  A code used to categorize cost elements within a project.
• ComponentAmount(required): string
  Base amount for the subcontract component amount line item.
• ComponentDescription(required): string
  Subcontract 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.
• ContractNumber(required): string
  Maximum Length: 500

  Denotes the identification number of the contract, for a project.

  Example: 17011S057
• MainJobNumber(required): string
  Maximum Length: 300

  The project that the imported subcontract will be written into.

  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 schedule of value used to create owner invoices.
• SubcontractItemNumber: string
  Subcontract component item number. Will be used to post invoices against the specific subcontract line.
• SubJobNumber: string
  Maximum Length: 60

  This denotes the identification number of the subcontract or purchase order number, for a project.

  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(required): string
  Unit of measurement for the component. These can be any category of measurement, but if the user keeps this value blank the value will default to EACH.
• UnitPrice: string
  Price set for each unit, per unit measurement. If the subcontract does not use unit billing, this price defaults to the value of 1.
• UnitQuantity: string
  Quantity of the units for unit billing. If the subcontract does not use unit billing, the value defaults to the same value as ComponentAmount.
• VendorId: string
  Maximum Length: 200

  A subcontractor can be assigned a Vendor ID for subcontracts, allowing for easier identification in subcontract usage.

  Example: RON095

{
    "required":[
        "ComponentAmount",
        "ContractNumber",
        "ComponentDescription",
        "MainJobNumber",
        "UnitOfMeasure"
    ],
    "type":"object",
    "properties":{
        "SubJobNumber":{
            "type":"string",
            "description":"This denotes the identification number of the subcontract or purchase order number, for a project.",
            "maxLength":"60",
            "example":"17011",
            "nullable":true
        },
        "VendorId":{
            "type":"string",
            "description":"A subcontractor can be assigned a Vendor ID for subcontracts, allowing for easier identification in subcontract usage.",
            "maxLength":"200",
            "example":"RON095",
            "nullable":true
        },
        "ContractNumber":{
            "type":"string",
            "description":"Denotes the identification number of the contract, for a project.",
            "maxLength":"500",
            "example":"17011S057",
            "nullable":false
        },
        "SubcontractItemNumber":{
            "type":"string",
            "description":"Subcontract component item number. Will be used to post invoices against the specific subcontract line.",
            "nullable":true
        },
        "ComponentAmount":{
            "type":"string",
            "description":"Base amount for the subcontract component amount line item.",
            "nullable":true
        },
        "ComponentDescription":{
            "type":"string",
            "description":"Subcontract component description.",
            "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
        },
        "MainJobNumber":{
            "type":"string",
            "description":"The project that the imported subcontract will be written into.",
            "maxLength":"300",
            "example":"01-17011",
            "nullable":false
        },
        "TaxCode":{
            "type":"string",
            "description":"Tax code to be used on invoices / payments. Each tax code should represent a specific tax rate.",
            "nullable":true
        },
        "UnitQuantity":{
            "type":"string",
            "description":"Quantity of the units for unit billing. If the subcontract does not use unit billing, the value defaults to the same value as ComponentAmount.",
            "nullable":true
        },
        "UnitPrice":{
            "type":"string",
            "description":"Price set for each unit, per unit measurement. If the subcontract does not use unit billing, this price defaults to the value of 1.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measurement for the component. These can be any category of measurement, but if the user keeps this value blank the value will default to EACH.",
            "nullable":true
        },
        "AccountCode":{
            "type":"string",
            "description":"Cost code / WBS code.",
            "nullable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"A code used to categorize cost elements within a project.",
            "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
        },
        "TaskSequence":{
            "type":"string",
            "description":"Task sequence.",
            "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 schedule of value used to create owner invoices.",
            "nullable":true
        }
    }
}

Examples

Select an example Create subcontracts request

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 Production Server: Create subcontracts response Test Server: Create subcontracts 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