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
stringThe Rutter generated unique ID of the sales order.
platform_id
stringThe platform specific ID of the sales order.
class_id
stringnullableThe Rutter ID of the Class linked to the sales order.
customer_id
stringnullableThe Rutter ID of the Customer linked to the sales order.
department_id
stringnullableThe Rutter ID of the Department linked to the sales order.
location_id
stringnullableThe Rutter ID of the Location linked to the sales order.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the sales order. This feature is currently only supported on NetSuite.
issue_date
stringThe ISO 8601 timestamp for the issue date of the sales order.
status
enumThe status of the sales order.
currency_code
enumnullableThe ISO 4217 currency code of the sales order.
currency_rate
numbernullableThe exchange rate between the currency of the sales order and the business default currency.
discount_amount
numbernullableThe discount amount applied to the sales order.
document_number
stringnullableThe buyer facing document number of the sales order.
memo
stringnullableThe memo of the sales order.
reference_number
stringnullableThe reference number of the sales order.
tax_amount
numbernullableThe tax amount applied to the sales order.
total_amount
numbernullableThe total amount of the sales order.
line_items
arrayAn array of line items associated with the sales order.
line_items
attributescreated_at
stringnullableThe ISO 8601 timestamp that the sales order was created.
updated_at
stringnullableThe ISO 8601 timestamp that the sales order was last updated.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"currency_rate": 1,
"discount_amount": 0,
"document_number": "VENDPO-1",
"memo": "Example sales order top-level memo",
"reference_number": "2",
"tax_amount": 0,
"total_amount": 12.34,
"line_items": [
{
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Sales Orders
GET /accounting/sales_ordersRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributessales_orders
arraysales_orders
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"sales_orders": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"currency_rate": 1,
"discount_amount": 0,
"document_number": "VENDPO-1",
"memo": "Example sales order top-level memo",
"reference_number": "2",
"tax_amount": 0,
"total_amount": 12.34,
"line_items": [
{
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Sales Order
GET /accounting/sales_orders/:idRequest Parameters
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributessales_order
objectsales_order
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"sales_order": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"currency_rate": 1,
"discount_amount": 0,
"document_number": "VENDPO-1",
"memo": "Example sales order top-level memo",
"reference_number": "2",
"tax_amount": 0,
"total_amount": 12.34,
"line_items": [
{
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}
Create a Sales Order
POST /accounting/sales_ordersRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
sales_order
objectsales_order
attributesResponse Body
Any of:
sales_order
objectsales_order
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"sales_order": {
"customer_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"line_items": [
{
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 10
}
}
]
}
}
{
"sales_order": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"currency_rate": 1,
"discount_amount": 0,
"document_number": "VENDPO-1",
"memo": "Example sales order top-level memo",
"reference_number": "2",
"tax_amount": 0,
"total_amount": 12.34,
"line_items": [
{
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}