Jump to

• Request
• Response

1a Subcontract Change Orders

post

/api/v1/import/changeorders

A change order is a restatement or expansion of the terms of an existing subcontract. A change order must reference an existing parent subcontract. Change orders are composed of a header record and one or more component or detail items. A change order request may contain multiple change orders. If a change order does not exist on a subcontract, Textura will create a new change order. If a change order exists on a subcontract, and the change order has not been completed (accepted by the subcontractor), Textura will replace the existing change order.

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.

  Example: 017833.00
• AutoCreateSov: string
  Auto-create SOV lines for existing components (and avoid manual allocation for subs)

  Example: False
• CategoryCode: string
  Cost type / Category.

  Example: SUB
• ChangeOrderDate(required): string
  Maximum Length: 200

  Change Order Date.

  Example: 03012015
• ChangeOrderDescription: string
  Maximum Length: 200

  Change Order Description.

  Example: Add for basement
• ChangeOrderId: string
  Unique string provided in change order (variation) export feed from TPM

  Example: 0001*1
• ChangeOrderNumber(required): string
  Maximum Length: 200

  Change Order Number.

  Example: 00004
• ChangeOrderSource: string
  Only used when exporting change order / variation requests from TPM into ERP

  Example: Textura
• ChangeOrderStatus: string
  0 -Unapproved, 1-Approved, 2 -Rejected

  Example: 1
• ChangeOrderTitle: string
  Maximum Length: 300

  Title of the Change Order, often just trade description

  Example:
• ChangeOrderType: string
  Send ???True??? to create this CO as a hidden changeorder, do not include the field or send ???false??? to create a normal CO

  Example: False
• ComponentAmount(required): string
  Base amount for the component amount line item.

  Example: 327.00
• ComponentDescription: string
  Component description.

  Example: Stakeholder Sleeves
• ComponentRetentionPercent(required): 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.

  Example: 10
• ContractNumber(required): string
  Maximum Length: 500

  Subcontract or Purchase Order Number.

  Example: 0001
• DoNotExceed: string
  Maximum amount a subcontractor can bill on the subcontract. International workflow only.

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

  The project/job this subcontract is written against.

  Example: 24290012
• 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.

  Example: 017833
• SubcontractItemNumber(required): string
  If item number already exists in Textura it will add the amount as a change order amount, otherwiseit will create a new line

  Example: 5
• SubJobNumber: string
  Maximum Length: 60

  The project/job this subcontract is written against.

  Example: 00001
• TaskSequence: string
  Task sequence.

  Example: 0
• 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

  Example: EA
• UnitPrice(required): string
  Defaults to 1 if subcontract will not use unit billing.

  Example: 1
• UnitQuantity(required): string
  Item quantity. Defaults to the same value as ComponentAmount if subcontract will not use unit billing.

  Example: 3102.00
• VendorId(required): string
  Maximum Length: 200

  Master Vendor ID for the AP entry

  Example: 100

{
    "required":[
        "VendorId",
        "ContractNumber",
        "ChangeOrderNumber",
        "ChangeOrderDate",
        "MainJobNumber",
        "SubcontractItemNumber",
        "ComponentAmount",
        "ComponentRetentionPercent",
        "UnitofMeasure",
        "UnitQuantity",
        "UnitPrice"
    ],
    "type":"object",
    "properties":{
        "VendorId":{
            "type":"string",
            "description":"Master Vendor ID for the AP entry",
            "maxLength":200,
            "example":"100",
            "nullable":false
        },
        "ContractNumber":{
            "type":"string",
            "description":"Subcontract or Purchase Order Number.",
            "maxLength":500,
            "example":"0001",
            "nullable":false
        },
        "ChangeOrderNumber":{
            "type":"string",
            "description":"Change Order Number.",
            "maxLength":200,
            "example":"00004",
            "nullable":false
        },
        "ChangeOrderDate":{
            "type":"string",
            "description":"Change Order Date.",
            "maxLength":200,
            "example":"03012015",
            "nullable":false
        },
        "ChangeOrderDescription":{
            "type":"string",
            "description":"Change Order Description.",
            "maxLength":200,
            "example":"Add for basement",
            "nullable":true
        },
        "MainJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":300,
            "example":"24290012",
            "nullable":false
        },
        "ChangeOrderTitle":{
            "type":"string",
            "description":"Title of the Change Order, often just trade description",
            "maxLength":300,
            "example":"",
            "nullable":true
        },
        "ChangeOrderId":{
            "type":"string",
            "description":"Unique string provided in change order (variation) export feed from TPM",
            "example":"0001*1",
            "nullable":true
        },
        "ChangeOrderStatus":{
            "type":"string",
            "description":"0 -Unapproved, 1-Approved, 2 -Rejected",
            "example":"1",
            "nullable":true
        },
        "ChangeOrderSource":{
            "type":"string",
            "description":"Only used when exporting change order / variation requests from TPM into ERP",
            "example":"Textura",
            "nullable":true
        },
        "AutoCreateSov":{
            "type":"string",
            "description":"Auto-create SOV lines for existing components (and avoid manual allocation for subs)",
            "example":"False",
            "nullable":true
        },
        "ChangeOrderType":{
            "type":"string",
            "description":"Send ???True??? to create this CO as a hidden changeorder, do not include the field or send ???false??? to create a normal CO",
            "example":"False",
            "nullable":true
        },
        "DoNotExceed":{
            "type":"string",
            "description":"Maximum amount a subcontractor can bill on the subcontract. International workflow only.",
            "example":"",
            "nullable":true
        },
        "SubJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":60,
            "example":"00001",
            "nullable":true
        },
        "SubcontractItemNumber":{
            "type":"string",
            "description":"If item number already exists in Textura it will add the amount as a change order amount, otherwiseit will create a new line",
            "example":"5",
            "nullable":false
        },
        "ComponentAmount":{
            "type":"string",
            "description":"Base amount for the component amount line item.",
            "example":"327.00",
            "nullable":false
        },
        "ComponentDescription":{
            "type":"string",
            "description":"Component description.",
            "example":"Stakeholder Sleeves",
            "nullable":true
        },
        "AccountCode":{
            "type":"string",
            "description":"Cost code / WBS code.",
            "example":"017833.00",
            "nullable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Cost type / Category.",
            "example":"SUB",
            "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.",
            "example":"10",
            "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
        },
        "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.",
            "example":"017833",
            "nullable":true
        },
        "UnitofMeasure":{
            "type":"string",
            "description":"Unit of measurement",
            "example":"EA",
            "nullable":false
        },
        "UnitQuantity":{
            "type":"string",
            "description":"Item quantity. Defaults to the same value as ComponentAmount if subcontract will not use unit billing.",
            "example":"3102.00",
            "nullable":false
        },
        "TaskSequence":{
            "type":"string",
            "description":"Task sequence.",
            "example":"0",
            "nullable":true
        },
        "UnitPrice":{
            "type":"string",
            "description":"Defaults to 1 if subcontract will not use unit billing.",
            "example":"1",
            "nullable":false
        }
    }
}

Examples

Select an example Create subcontract Change Orders

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/changeorders/7

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

Examples

Select an example Change orders response Change orders response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/import/changeorders

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/import/changeorders

Back to Top