Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

PurchaseOrders

Create an purchase order

Create a new purchase order (required scope finance:write)

post/v1/finance/purchaseOrders

Headers

Customer-Idinteger required

The customer identifier

Request body

jobIdinteger nullable

The unique identifier of the job associated with this purchase order, if applicable

jobGroupIdinteger nullable

The unique identifier of the job group associated with this purchase order, if applicable

contactIdinteger nullable

The unique identifier of the contact associated with this purchase order. Will reference the job or job group contact if not provided

seriesIdinteger nullable

The unique identifier of the purchase order series. Required if you have PO Series setup, otherwise it must be omitted

createdAtstring date-time nullable

The dateTime the purchase order was created. If null, will default to the current dateTime

referencestring nullable

The reference of the purchase order. If null, will default to an auto-generated reference

currencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD'

CurrencyCode definitions enum, matches currencies available in the BigChange Client Site<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: US Dollar</li></ul>

deliverySiteContactIdinteger nullable

The unique identifier of the delivery site contact associated with this purchase order, if applicable

supplierIdinteger

The unique identifier of the supplier associated with the purchase order

clientNotesstring nullable

Notes on the purchase order

internalNotesstring nullable

Internal notes not visible to the client

Example request

{
  "jobId": 12345,
  "jobGroupId": 54321,
  "contactId": 1234,
  "seriesId": 1234,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "reference": "PurchaseOrderNote101",
  "currencyCode": "EUR",
  "deliverySiteContactId": 56789,
  "supplierId": 12345,
  "clientNotes": "Please pay within 30 days",
  "internalNotes": "Follow up in two weeks",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

Created

idinteger

Identifier of the newly created record