Sales Orders
The SalesOrder Object
A Rutter Sales Order represents a document generated by a vendor in response to a customer's purchase order or as a result of a direct sales transaction. It outlines the details of a customer's request to purchase specific products or services from the vendor.
Properties
id
stringRequiredThe Rutter generated unique ID of the sales order.
platform_id
stringRequiredThe platform specific ID of the sales order.
class_id
stringnullableRequiredThe Rutter ID of the Class linked to the sales order.
customer_id
stringnullableRequiredThe Rutter ID of the Customer linked to the sales order.
department_id
stringnullableRequiredThe Rutter ID of the Department linked to the sales order.
location_id
stringnullableRequiredThe Rutter ID of the Location linked to the sales order.
subsidiary_id
stringnullableRequiredThe Rutter ID of the Subsidiary linked to the sales order. Supported for NetSuite.
issue_date
stringRequiredThe ISO 8601 timestamp for the issue date of the sales order.
status
enumRequiredThe status of the sales order.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the sales order.
currency_rate
numbernullableRequiredThe exchange rate between the currency of the sales order and the business default currency.
discount_amount
numbernullableRequiredThe discount amount applied to the sales order.
document_number
stringnullableRequiredThe buyer facing document number of the sales order.
memo
stringnullableRequiredThe memo of the sales order.
reference_number
stringnullableRequiredThe reference number of the sales order.
tax_amount
numbernullableRequiredThe tax amount applied to the sales order.
total_amount
numbernullableRequiredThe total amount of the sales order.
line_items
arrayRequiredAn array of line items associated with the sales order.
line_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the sales order was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the sales order was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the sales order was last synced by Rutter.
List Sales Orders
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributessales_orders
arrayRequiredsales_orders
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "sales_orders": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "class_id": "00000000-0000-0000-0000-000000000000",
12 "customer_id": "00000000-0000-0000-0000-000000000000",
13 "department_id": "00000000-0000-0000-0000-000000000000",
14 "location_id": "00000000-0000-0000-0000-000000000000",
15 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
16 "issue_date": "2023-01-02T02:34:56.000Z",
17 "status": "open",
18 "currency_code": "USD",
19 "currency_rate": 1,
20 "discount_amount": 0,
21 "document_number": "VENDPO-1",
22 "memo": "Example sales order top-level memo",
23 "reference_number": "2",
24 "tax_amount": 0,
25 "total_amount": 12.34,
26 "line_items": [
27 {
28 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
29 "description": "Example description",
30 "total_amount": 12.34,
31 "item": {
32 "id": "00000000-0000-0000-0000-000000000000",
33 "quantity": 1,
34 "unit_amount": 12.34
35 }
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 }
42 ],
43 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
44}
Fetch a Sales Order
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
id_type
enumqueryOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
Response Body
connection
objectRequiredconnection
attributessales_order
objectRequiredsales_order
attributes- QuickBooks
- Netsuite
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "sales_order": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "class_id": "00000000-0000-0000-0000-000000000000",
11 "customer_id": "00000000-0000-0000-0000-000000000000",
12 "department_id": "00000000-0000-0000-0000-000000000000",
13 "location_id": "00000000-0000-0000-0000-000000000000",
14 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
15 "issue_date": "2023-01-02T02:34:56.000Z",
16 "status": "open",
17 "currency_code": "USD",
18 "currency_rate": 1,
19 "discount_amount": 0,
20 "document_number": "VENDPO-1",
21 "memo": "Example sales order top-level memo",
22 "reference_number": "2",
23 "tax_amount": 0,
24 "total_amount": 12.34,
25 "line_items": [
26 {
27 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
28 "description": "Example description",
29 "total_amount": 12.34,
30 "item": {
31 "id": "00000000-0000-0000-0000-000000000000",
32 "quantity": 1,
33 "unit_amount": 12.34
34 }
35 }
36 ],
37 "created_at": "2023-01-02T02:34:56.000Z",
38 "updated_at": "2023-01-02T02:34:56.000Z",
39 "last_synced_at": "2023-01-02T02:34:56.000Z"
40 }
41}
Create a Sales Order
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
sales_order
objectRequiredsales_order
attributesResponse Body
Any of:
sales_order
objectRequiredsales_order
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
1{
2 "sales_order": {
3 "customer_id": "00000000-0000-0000-0000-000000000000",
4 "issue_date": "2023-01-02T02:34:56.000Z",
5 "currency_code": "USD",
6 "line_items": [
7 {
8 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
9 "description": "Example description",
10 "item": {
11 "id": "00000000-0000-0000-0000-000000000000",
12 "quantity": 1,
13 "unit_amount": 10
14 }
15 }
16 ]
17 }
18}
1{
2 "sales_order": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "class_id": "00000000-0000-0000-0000-000000000000",
6 "customer_id": "00000000-0000-0000-0000-000000000000",
7 "department_id": "00000000-0000-0000-0000-000000000000",
8 "location_id": "00000000-0000-0000-0000-000000000000",
9 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
10 "issue_date": "2023-01-02T02:34:56.000Z",
11 "status": "open",
12 "currency_code": "USD",
13 "currency_rate": 1,
14 "discount_amount": 0,
15 "document_number": "VENDPO-1",
16 "memo": "Example sales order top-level memo",
17 "reference_number": "2",
18 "tax_amount": 0,
19 "total_amount": 12.34,
20 "line_items": [
21 {
22 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
23 "description": "Example description",
24 "total_amount": 12.34,
25 "item": {
26 "id": "00000000-0000-0000-0000-000000000000",
27 "quantity": 1,
28 "unit_amount": 12.34
29 }
30 }
31 ],
32 "created_at": "2023-01-02T02:34:56.000Z",
33 "updated_at": "2023-01-02T02:34:56.000Z",
34 "last_synced_at": "2023-01-02T02:34:56.000Z"
35 }
36}
Update a Sales Order
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
sales_order
objectRequiredsales_order
attributesResponse Body
Any of:
sales_order
objectRequiredsales_order
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
1{
2 "sales_order": {
3 "customer_id": "00000000-0000-0000-0000-000000000000",
4 "currency_code": "USD",
5 "line_items": [
6 {
7 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
8 "description": "Example description",
9 "item": {
10 "id": "00000000-0000-0000-0000-000000000000",
11 "quantity": 1,
12 "unit_amount": 10
13 }
14 }
15 ]
16 }
17}
1{
2 "sales_order": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "class_id": "00000000-0000-0000-0000-000000000000",
6 "customer_id": "00000000-0000-0000-0000-000000000000",
7 "department_id": "00000000-0000-0000-0000-000000000000",
8 "location_id": "00000000-0000-0000-0000-000000000000",
9 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
10 "issue_date": "2023-01-02T02:34:56.000Z",
11 "status": "open",
12 "currency_code": "USD",
13 "currency_rate": 1,
14 "discount_amount": 0,
15 "document_number": "VENDPO-1",
16 "memo": "Example sales order top-level memo",
17 "reference_number": "2",
18 "tax_amount": 0,
19 "total_amount": 12.34,
20 "line_items": [
21 {
22 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
23 "description": "Example description",
24 "total_amount": 12.34,
25 "item": {
26 "id": "00000000-0000-0000-0000-000000000000",
27 "quantity": 1,
28 "unit_amount": 12.34
29 }
30 }
31 ],
32 "created_at": "2023-01-02T02:34:56.000Z",
33 "updated_at": "2023-01-02T02:34:56.000Z",
34 "last_synced_at": "2023-01-02T02:34:56.000Z"
35 }
36}
Have questions?
Contact support for personalized guidance.