Sales Orders - Rutter API Reference - the Common Language for Business Data

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

idstring

The Rutter generated unique ID of the sales order.

platform_idstring

The platform specific ID of the sales order.

class_idstringnullable

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

customer_idstringnullable

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

department_idstringnullable

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

location_idstringnullable

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

subsidiary_idstringnullable

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

issue_datestring

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

statusenum

The status of the sales order.

One ofopen, closed, pending_approval, or unknown.

currency_codeenumnullable

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, 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_ratenumbernullable

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

discount_amountnumbernullable

The discount amount applied to the sales order.

document_numberstringnullable

The buyer facing document number of the sales order.

memostringnullable

The memo of the sales order.

reference_numberstringnullable

The reference number of the sales order.

tax_amountnumbernullable

The tax amount applied to the sales order.

total_amountnumbernullable

The total amount of the sales order.

line_itemsarray

An array of line items associated with the sales order.

Show line_items attributes

created_atstringnullable

The ISO 8601 timestamp that the sales order was created.

updated_atstringnullable

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

Example SalesOrder Object

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

Supported for: NetSuite

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringoptionalquery

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

expandenumoptionalquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumoptionalquery

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

One oftrue or false.

limitintegeroptionalquery

The limit on the number of entities returned.

updated_at_maxintegeroptionalquery

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

updated_at_minintegeroptionalquery

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

Response Body

connectionobject

Show connection attributes

sales_ordersarray

Show sales_orders attributes

next_cursorstringnullableoptional

Example Response Body

{
  "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/:id

Supported for: NetSuite

Request Parameters

access_tokenstringquery

The access token of the connection.

force_fetchenumoptionalquery

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

One oftrue or false.

Response Body

connectionobject

Show connection attributes

sales_orderobject

Show sales_order attributes

Example Response Body

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

Supported for: NetSuite

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

sales_orderobject

Show sales_order attributes

Response Body

Any of:

sales_orderobject

Show sales_order attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "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
        }
      }
    ]
  }
}

Example Response Body

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