Purchase Orders

The PurchaseOrder Object

A Rutter Purchase Order represents a commercial document issued by a vendor to a customer, indicating the types, quantities, and agreed prices for products or services that the customer wishes to purchase. It serves as a formal offer to buy goods or services from a vendor.

Properties

idstring

The Rutter generated unique ID of the purchase order.

platform_idstring

The platform specific ID of the purchase order.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the purchase order. Supported for NetSuite.

vendor_idstringfilterablenullable

The Rutter ID of the Vendor linked to the purchase order.

issue_datestring

The ISO 8601 timestamp for the issue date of the purchase order.

statusenum

The status of the purchase order.

One ofopen, closed, pending_bill, or unknown.

currency_codeenumnullable

The ISO 4217 currency code of the purchase order.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, or null.

document_numberstringnullable

The buyer facing document number of the purchase order.

memostringnullable

The memo of the purchase order.

total_amountnumbernullable

The total payment amount of the purchase order.

total_quantitynumbernullable

The total quantity of items in the purchase order.

line_itemsarray

An array of line items associated with the purchase order.

Show line_items attributes

created_atstringfilterablenullable

The ISO 8601 timestamp that the purchase order was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the purchase order was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the purchase order was last synced by Rutter.

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/purchase_orders

GET

/accounting/purchase_orders/:id

POST

/accounting/purchase_orders

PATCH

/accounting/purchase_orders/:id

DELETE

/accounting/purchase_orders/:id

List Purchase Orders

GEThttps://production.rutterapi.com/versioned/accounting/purchase_orders

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

filterstringqueryOptional

Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

Filterable fields: vendor_id, created_at, updated_at, last_synced_at.

sortstringqueryOptional

Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: vendor_id, created_at, updated_at, last_synced_at.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_maxintegerqueryOptional

Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_minintegerqueryOptional

Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

Example Response Body

JSON

1{
2  "purchase_orders": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
7      "vendor_id": "00000000-0000-0000-0000-000000000000",
8      "issue_date": "2023-01-02T02:34:56.000Z",
9      "status": "open",
10      "currency_code": "USD",
11      "document_number": "VENDPO-1",
12      "memo": "Example purchase order top-level memo",
13      "total_amount": 12.34,
14      "total_quantity": 1,
15      "line_items": [
16        {
17          "account_id": "00000000-0000-0000-0000-000000000000",
18          "class_id": "00000000-0000-0000-0000-000000000000",
19          "department_id": "00000000-0000-0000-0000-000000000000",
20          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
21          "description": "Example description",
22          "total_amount": 12.34,
23          "item": {
24            "id": "00000000-0000-0000-0000-000000000000",
25            "quantity": 1,
26            "unit_amount": 12.34
27          }
28        }
29      ],
30      "created_at": "2023-01-02T02:34:56.000Z",
31      "updated_at": "2023-01-02T02:34:56.000Z",
32      "last_synced_at": "2023-01-02T02:34:56.000Z",
33      "platform_url": "https://platform.com/resource?id=123",
34      "platform_data": {
35        "id": 123,
36        "data": "Varies by platform"
37      }
38    }
39  ],
40  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
41  "connection": {
42    "id": "00000000-0000-0000-0000-000000000000",
43    "orgId": "00000000-0000-0000-0000-000000000000",
44    "platform": "NETSUITE"
45  }
46}

Fetch a Purchase Order

GEThttps://production.rutterapi.com/versioned/accounting/purchase_orders/:id

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

Example Response Body

JSON

1{
2  "purchase_order": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6    "vendor_id": "00000000-0000-0000-0000-000000000000",
7    "issue_date": "2023-01-02T02:34:56.000Z",
8    "status": "open",
9    "currency_code": "USD",
10    "document_number": "VENDPO-1",
11    "memo": "Example purchase order top-level memo",
12    "total_amount": 12.34,
13    "total_quantity": 1,
14    "line_items": [
15      {
16        "account_id": "00000000-0000-0000-0000-000000000000",
17        "class_id": "00000000-0000-0000-0000-000000000000",
18        "department_id": "00000000-0000-0000-0000-000000000000",
19        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
20        "description": "Example description",
21        "total_amount": 12.34,
22        "item": {
23          "id": "00000000-0000-0000-0000-000000000000",
24          "quantity": 1,
25          "unit_amount": 12.34
26        }
27      }
28    ],
29    "created_at": "2023-01-02T02:34:56.000Z",
30    "updated_at": "2023-01-02T02:34:56.000Z",
31    "last_synced_at": "2023-01-02T02:34:56.000Z",
32    "platform_url": "https://platform.com/resource?id=123",
33    "platform_data": {
34      "id": 123,
35      "data": "Varies by platform"
36    }
37  },
38  "connection": {
39    "id": "00000000-0000-0000-0000-000000000000",
40    "orgId": "00000000-0000-0000-0000-000000000000",
41    "platform": "NETSUITE"
42  }
43}

Create a Purchase Order

POSThttps://production.rutterapi.com/versioned/accounting/purchase_orders

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

One ofasync or prefer_sync.

purchase_orderobject

Show purchase_order attributes

Response Body

Support by integration

QuickBooks
QuickBooks Desktop
NetSuite

Example Request Body

JSON

1{
2  "purchase_order": {
3    "vendor_id": "00000000-0000-0000-0000-000000000000",
4    "currency": "USD",
5    "line_items": [
6      {
7        "item": "00000000-0000-0000-0000-000000000000",
8        "quantity": 1,
9        "description": "Example description",
10        "unit_amount": 10
11      }
12    ]
13  }
14}

200

Example Response Body

JSON

1{
2  "purchase_order": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6    "vendor_id": "00000000-0000-0000-0000-000000000000",
7    "posted_date": "2023-01-02T02:34:56.000Z",
8    "currency_code": "USD",
9    "document_number": "VENDPO-1",
10    "memo": "For a Rutter shirt.",
11    "status": "active",
12    "total_amount": "12.34",
13    "total_quantity": "1",
14    "vendor_name": "Rutter API",
15    "line_items": [
16      {
17        "platform_id": "12345678",
18        "account_id": "00000000-0000-0000-0000-000000000000",
19        "class_id": "00000000-0000-0000-0000-000000000000",
20        "item_id": "00000000-0000-0000-0000-000000000000",
21        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
22        "amount": "12.34",
23        "amount_billed": "12.34",
24        "amount_received": "12.34",
25        "description": "Example description",
26        "item_name": "Rutter shirt",
27        "quantity": "1",
28        "quantity_bill": "1",
29        "quantity_received": "1",
30        "unit_amount": "12.34"
31      }
32    ],
33    "created_at": "2023-01-02T02:34:56.000Z",
34    "updated_at": "2023-01-02T02:34:56.000Z",
35    "last_synced_at": "2023-01-02T02:34:56.000Z",
36    "platform_url": "https://platform.com/resource?id=123",
37    "platform_data": {
38      "id": 123,
39      "data": "Varies by platform"
40    }
41  }
42}

Update a Purchase Order

PATCHhttps://production.rutterapi.com/versioned/accounting/purchase_orders/:id

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

purchase_orderobject

Show purchase_order attributes

Response Body

Support by integration

QuickBooks
QuickBooks Desktop

Example Request Body

JSON

1{
2  "purchase_order": {
3    "vendor_id": "00000000-0000-0000-0000-000000000000",
4    "line_items": [
5      {
6        "item": "00000000-0000-0000-0000-000000000000",
7        "quantity": 1,
8        "description": "Example description",
9        "unit_amount": 10
10      }
11    ]
12  }
13}

200

Example Response Body

JSON

1{
2  "purchase_order": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6    "vendor_id": "00000000-0000-0000-0000-000000000000",
7    "posted_date": "2023-01-02T02:34:56.000Z",
8    "currency_code": "USD",
9    "document_number": "VENDPO-1",
10    "memo": "For a Rutter shirt.",
11    "status": "active",
12    "total_amount": "12.34",
13    "total_quantity": "1",
14    "vendor_name": "Rutter API",
15    "line_items": [
16      {
17        "platform_id": "12345678",
18        "account_id": "00000000-0000-0000-0000-000000000000",
19        "class_id": "00000000-0000-0000-0000-000000000000",
20        "item_id": "00000000-0000-0000-0000-000000000000",
21        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
22        "amount": "12.34",
23        "amount_billed": "12.34",
24        "amount_received": "12.34",
25        "description": "Example description",
26        "item_name": "Rutter shirt",
27        "quantity": "1",
28        "quantity_bill": "1",
29        "quantity_received": "1",
30        "unit_amount": "12.34"
31      }
32    ],
33    "created_at": "2023-01-02T02:34:56.000Z",
34    "updated_at": "2023-01-02T02:34:56.000Z",
35    "last_synced_at": "2023-01-02T02:34:56.000Z",
36    "platform_url": "https://platform.com/resource?id=123",
37    "platform_data": {
38      "id": 123,
39      "data": "Varies by platform"
40    }
41  }
42}

Delete a Purchase Order

DELETEhttps://production.rutterapi.com/versioned/accounting/purchase_orders/:id

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

Response Body

Support by integration

QuickBooks
QuickBooks Desktop

200

Example Response Body

JSON

1{
2  "code": "deleted",
3  "success": true
4}

Have questions?

Contact support for personalized guidance.

Contact support