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
id
stringThe Rutter generated unique ID of the purchase order.
platform_id
stringThe platform specific ID of the purchase order.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the purchase order. Supported for NetSuite.
vendor_id
stringfilterablenullableThe Rutter ID of the Vendor linked to the purchase order.
posted_date
stringThe ISO 8601 timestamp for when the purchase order was posted.
currency_code
enumnullableThe ISO 4217 currency code of the purchase order.
document_number
stringnullableThe buyer facing document number of the purchase order.
memo
stringnullableThe memo of the purchase order.
status
stringnullableThe status of the purchase order.
total_amount
stringnullableThe total payment amount of the purchase order.
total_quantity
stringnullableThe total quantity of items in the purchase order.
vendor_name
stringnullableThe name of the Vendor linked to the purchase order.
line_items
arrayAn array of line items associated with the purchase order.
line_items
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the purchase order was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the purchase order was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the purchase order was last synced by Rutter.
platform_url
stringnullableA 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_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Purchase Orders
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot 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
.
sort
stringqueryOptionalUsed 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
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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 "posted_date": "2023-01-02T02:34:56.000Z",
9 "currency_code": "USD",
10 "document_number": "VENDPO-1",
11 "memo": "For a Rutter shirt.",
12 "status": "active",
13 "total_amount": "12.34",
14 "total_quantity": "1",
15 "vendor_name": "Rutter API",
16 "line_items": [
17 {
18 "platform_id": "12345678",
19 "account_id": "00000000-0000-0000-0000-000000000000",
20 "class_id": "00000000-0000-0000-0000-000000000000",
21 "item_id": "00000000-0000-0000-0000-000000000000",
22 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
23 "amount": "12.34",
24 "amount_billed": "12.34",
25 "amount_received": "12.34",
26 "description": "Example description",
27 "item_name": "Rutter shirt",
28 "quantity": "1",
29 "quantity_bill": "1",
30 "quantity_received": "1",
31 "unit_amount": "12.34"
32 }
33 ],
34 "created_at": "2023-01-02T02:34:56.000Z",
35 "updated_at": "2023-01-02T02:34:56.000Z",
36 "last_synced_at": "2023-01-02T02:34:56.000Z",
37 "platform_url": "https://platform.com/resource?id=123",
38 "platform_data": {
39 "id": 123,
40 "data": "Varies by platform"
41 }
42 }
43 ],
44 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
45 "connection": {
46 "id": "00000000-0000-0000-0000-000000000000",
47 "orgId": "00000000-0000-0000-0000-000000000000",
48 "platform": "NETSUITE"
49 }
50}
Fetch a Purchase Order
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not currently supported on Sage Intacct or Sage Business Cloud.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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 "connection": {
43 "id": "00000000-0000-0000-0000-000000000000",
44 "orgId": "00000000-0000-0000-0000-000000000000",
45 "platform": "NETSUITE"
46 }
47}
Create a Purchase Order
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
purchase_order
objectpurchase_order
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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}
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
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
purchase_order
objectpurchase_order
attributesResponse Body
- QuickBooks
- QuickBooks Desktop
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}
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
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
Response Body
- QuickBooks
- QuickBooks Desktop
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.