Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041351024.8 MB

21d41189c461

Purchase orders

Update purchase order

The Update purchase order endpoint updates an existing purchase order for a given company's connection.

Purchase orders represent a business's intent to purchase goods or services from a supplier.

Integration-specific behavior

Required data may vary by integration. To see what data to post, first call Get create/update purchase order model.

put/companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId}

Query parameters

timeoutInMinutesinteger

Time limit for the push operation to complete before it is timed out.

forceUpdateboolean

When updating data in the destination platform Codat checks the sourceModifiedDate against the lastupdated date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to true then the update will override this check.

Request body

idstring

Identifier for the purchase order, unique for the company in the accounting software.

purchaseOrderNumberstring nullable

Friendly reference for the purchase order, commonly generated by the accounting software.

issueDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

paymentDueDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

expectedDeliveryDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

deliveryDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

notestring nullable

Any additional information associated with the purchase order.

shipToShipTo — unresolved $ref
supplierRefSupplierRef — unresolved $ref
statusPurchaseOrderStatus — unresolved $ref
currencyCurrency — unresolved $ref
currencyRateCurrencyRate — unresolved $ref
lineItemsPurchaseOrderLineItem[] nullable— unresolved $ref

Array of line items.

totalDiscountnumber

Total value of any discounts applied to the purchase order.

subTotalnumber

Total amount of the purchase order, including discounts but excluding tax.

totalTaxAmountnumber

Total amount of tax included in the purchase order.

totalAmountnumber

Total amount of the purchase order, including discounts and tax.

modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

Example request

{
  "id": "7e2380af-b51f-4393-92d7-6ff0382da26c",
  "purchaseOrderNumber": "89443280",
  "issueDate": "2020-10-24T00:00:00Z",
  "deliveryDate": "2021-02-02T00:00:00Z",
  "expectedDeliveryDate": "2021-01-29T00:00:00Z",
  "paymentDueDate": "2021-09-13T00:00:00Z",
  "note": "purchaseorder with 1 line items, totalling 1138.5",
  "supplierRef": {
    "id": "7ff6add1-b0e7-496f-b655-48e20c8fdb2e",
    "supplierName": "Carlton Innovations"
  },
  "shipTo": {
    "contact": {
      "name": "Carlton Innovations",
      "email": "sales@carltoninnov.com",
      "phone": ""
    },
    "address": {
      "type": "Billing",
      "line1": "1 Carolyns Circle",
      "line2": "",
      "city": "Dallas",
      "region": "Texas",
      "country": "USA",
      "postalCode": "511210"
    }
  },
  "status": "Closed",
  "currency": "GBP",
  "currencyRate": 1,
  "lineItems": [
    {
      "description": "Electric Eye purchase",
      "accountRef": {
        "id": "13931cbf-ea06-4d6e-9538-a8457fa66011",
        "name": "Cost of Goods Sold"
      },
      "itemRef": {
        "id": "9409d23d-1011-432e-98a4-591fcd8d5404",
        "name": "ACME Electric Eye"
      },
      "trackingCategoryRefs": [],
      "unitAmount": 115,
      "quantity": 9,
      "discountAmount": 0,
      "discountPercentage": 0,
      "subTotal": 1035,
      "taxAmount": 103.5,
      "taxRateRef": {
        "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498",
        "name": "ACME Sales Tax (10%)"
      },
      "totalAmount": 1138.5
    }
  ],
  "totalDiscount": 0,
  "subTotal": 1035,
  "totalTaxAmount": 103.5,
  "totalAmount": 1138.5,
  "createdBy": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@codat.io"
  },
  "modifiedDate": "2020-11-17T21:11:20Z",
  "sourceModifiedDate": "2020-10-25T06:37:33Z"
}

Response

Success

changesPushOperationChange[] nullable— unresolved $ref

Contains a single entry that communicates which record has changed and the manner in which it changed.

dataType'accountTransactions' | 'balanceSheet' | 'bankAccounts' | 'bankTransactions' | 'billCreditNotes' | 'billPayments' | 'bills' | 'cashFlowStatement' | 'chartOfAccounts' | 'company' | 'creditNotes' | 'customers' | 'directCosts' | 'directIncomes' | 'invoices' | 'itemReceipts' | 'items' | 'journalEntries' | 'journals' | 'paymentMethods' | 'payments' | 'profitAndLoss' | 'purchaseOrders' | 'salesOrders' | 'suppliers' | 'taxRates' | 'trackingCategories' | 'transfers' | 'banking-accountBalances' | 'banking-accounts' | 'banking-transactionCategories' | 'banking-transactions' | 'commerce-companyInfo' | 'commerce-customers' | 'commerce-disputes' | 'commerce-locations' | 'commerce-orders' | 'commerce-paymentMethods' | 'commerce-payments' | 'commerce-productCategories' | 'commerce-products' | 'commerce-taxComponents' | 'commerce-transactions'

Available data types

companyIdSchema required— unresolved $ref
pushOperationKeystring uuid required

A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.

dataConnectionKeySchema required— unresolved $ref
requestedOnUtcstring required

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

completedOnUtcstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required— unresolved $ref
errorMessagestring nullable

A message about the error.

validationValidation — unresolved $ref
statusCodeinteger required

Push status code.