PATCH /rest/v1.0/purchase_order_contracts/{id}

Update a Purchase Order Contract.

Servers

Path parameters

Name Type Required Description
id Integer Yes

ID

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
run_configurable_validations Boolean No

If true, validations are run for the corresponding Configurable Field Set.

Default value: false

Request body fields

Name Type Required Description
project_id Integer Yes

Unique identifier for the project.

attachments[] Array No

Purchase Order Contract attachments. To upload attachments you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

purchase_order_contract Object Yes

Purchase Order Contract object

purchase_order_contract.executed Boolean No

Executed status

purchase_order_contract.payment_terms String No

Payment terms

purchase_order_contract.description String No

Description

purchase_order_contract.invoice_contact_user_ids[] Array No

IDs of users in the project directory (see the Project Users endpoint). The users with these IDs will be added as invoice contacts if they belong to the same vendor as the contract vendor. Invoice contacts are the points of contact for subcontractor invoices.

purchase_order_contract.currency_iso_code String No

Currency ISO code; It'll be accepted only when multicurrency phase two feature flag is enabled.

purchase_order_contract.origin_data String No

Origin data

purchase_order_contract.drawing_revision_ids[] Array No

Drawing Revisions to attach to the response

purchase_order_contract.origin_code String No

Origin code

purchase_order_contract.custom_field_%{custom_field_definition_id} No

Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries.

purchase_order_contract.retainage_percent String No

Retainage percent

purchase_order_contract.ship_to_address String No

Ship to address

purchase_order_contract.assignee_id Integer No

Assignee ID

purchase_order_contract.origin_id String No

Origin ID

purchase_order_contract.title String No

Title

purchase_order_contract.approval_letter_date String No

Approval letter date

purchase_order_contract.contract_date String No

Contract date

purchase_order_contract.file_version_ids[] Array No

File Versions to attach to the response

purchase_order_contract.vendor_id Integer No

Vendor ID

purchase_order_contract.currency_exchange_rate Number No

Exchange rate from contract currency to project currency; It'll be accepted only when multicurrency phase two feature flag is enabled and user has the granular permission to edit the contract exchange rate.

purchase_order_contract.image_ids[] Array No

Images to attach to the response

purchase_order_contract.delivery_date String No

Delivery date

purchase_order_contract.number String No

Number

purchase_order_contract.letter_of_intent_date String No

Letter of intent date

purchase_order_contract.upload_ids[] Array No

Uploads to attach to the response

purchase_order_contract.status String No

Status

Possible values:

  • "Processing"
  • "Draft"
  • "Closed"
  • "Approved"
  • "Partially Received"
  • "Received"
  • "Submitted"
purchase_order_contract.returned_date String No

Returned date

purchase_order_contract.issued_on_date String No

Issued on

purchase_order_contract.form_ids[] Array No

Forms to attach to the response

purchase_order_contract.ship_via String No

Ship via

purchase_order_contract.accounting_method String No

Accounting method. If not provided on create action, defaults to Project Configuration.

Possible values:

  • "unit"
  • "amount"
purchase_order_contract.execution_date String No

Execution date

purchase_order_contract.private Boolean No

Enable/Disable private status

purchase_order_contract.bill_to_address String No

Bill to address

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.