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

idstringRequired

The Rutter generated unique ID of the sales order.

platform_idstringRequired

The platform specific ID of the sales order.

class_idstringnullableRequired

The Rutter ID of the Class linked to the sales order.

customer_idstringnullableRequired

The Rutter ID of the Customer linked to the sales order.

department_idstringnullableRequired

The Rutter ID of the Department linked to the sales order.

location_idstringnullableRequired

The Rutter ID of the Location linked to the sales order.

subsidiary_idstringnullableRequired

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

issue_datestringRequired

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

statusenumRequired

The status of the sales order.

One ofopen, closed, pending_approval, or unknown.

currency_codeenumnullableRequired

The ISO 4217 currency code of the sales 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.

currency_ratenumbernullableRequired

The exchange rate between the currency of the sales order and the business default currency.

discount_amountnumbernullableRequired

The discount amount applied to the sales order.

document_numberstringnullableRequired

The buyer facing document number of the sales order.

memostringnullableRequired

The memo of the sales order.

reference_numberstringnullableRequired

The reference number of the sales order.

tax_amountnumbernullableRequired

The tax amount applied to the sales order.

total_amountnumbernullableRequired

The total amount of the sales order.

line_itemsarrayRequired

An array of line items associated with the sales order.

Show line_items attributes

created_atstringnullableRequired

The ISO 8601 timestamp that the sales order was created.

updated_atstringnullableRequired

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

last_synced_atstringRequired

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

Endpoints

GET

/accounting/sales_orders

GET

/accounting/sales_orders/:id

POST

/accounting/sales_orders

PATCH

/accounting/sales_orders/:id

List Sales Orders

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

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 number of entities to return. Defaults to 50. Maximum is 500.

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

sales_ordersarrayRequired

Show sales_orders attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite

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  "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

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

Request Parameters

idstringpathRequired

The unique ID of the object.

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.

id_typeenumquery

Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

One ofrutter or platform.

Response Body

connectionobjectRequired

Show connection attributes

sales_orderobjectRequired

Show sales_order attributes

Support by integration

QuickBooks
Netsuite

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  "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

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

sales_orderobjectRequired

Show sales_order attributes

Response Body

Any of:

sales_orderobjectRequired

Show sales_order attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
Netsuite

Example Request Body

JSON

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}

Example Response Body

JSON

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

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

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

sales_orderobjectRequired

Show sales_order attributes

Response Body

Any of:

sales_orderobjectRequired

Show sales_order attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks

Example Request Body

JSON

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}

Example Response Body

JSON

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.

Contact support