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

idstringRequired

The Rutter generated unique ID of the purchase order.

platform_idstringRequired

The platform specific ID of the purchase order.

subsidiary_idstringnullableRequired

The Rutter ID of the Subsidiary linked to the purchase order. This feature is currently only supported on NetSuite.

vendor_idstringnullableRequired

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

posted_datestringRequired

The ISO 8601 timestamp for when the purchase order was posted.

currency_codeenumnullableRequired

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, or ZMW.

document_numberstringnullableRequired

The buyer facing document number of the purchase order.

memostringnullableRequired

The memo of the purchase order.

statusstringnullableRequired

The status of the purchase order.

vendor_namestringnullableRequired

The name of the Vendor linked to the purchase order.

total_amountstringnullableRequired

The total payment amount of the purchase order.

total_quantitystringnullableRequired

The total quantity of items in the purchase order.

line_itemsarrayRequired

An array of line items associated with the purchase order.

Show line_items attributes

created_atstringnullableRequired

The ISO 8601 timestamp that the purchase order was created.

updated_atstringnullableRequired

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

last_synced_atstringRequired

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

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/purchase_orders

GET

/accounting/purchase_orders/:id

POST

/accounting/purchase_orders

List Purchase Orders

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

expandenumquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

last_synced_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

limitintegerquery

The limit on the number of entities returned.

sortstringquery

The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

updated_at_maxintegerquery

Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

updated_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

connectionobjectRequired

Show connection attributes

purchase_ordersarrayRequired

Show purchase_orders attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite
Xero

Example Response Body

JSON

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

Fetch a Purchase Order

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

Response Body

connectionobjectRequired

Show connection attributes

purchase_orderobjectRequired

Show purchase_order attributes

Support by integration

QuickBooks
Netsuite
Xero

Example Response Body

JSON

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

Create a Purchase Order

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

purchase_orderobjectRequired

Show purchase_order attributes

Response Body

Any of:

purchase_orderobjectRequired

Show purchase_order attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

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}

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    "vendor_name": "Rutter API",
13    "total_amount": "12.34",
14    "total_quantity": "1",
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        "description": "Example description",
23        "item_name": "Rutter shirt",
24        "amount": "12.34",
25        "amount_billed": "12.34",
26        "amount_received": "12.34",
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_data": {
37      "id": 123,
38      "data": "Varies by platform"
39    }
40  }
41}

Have questions?

Contact support for personalized guidance.

Contact support