Sales Receipts

The SalesReceipt Object

A Rutter Sales Receipt represents a document that records the sale of goods or services to a customer where payment is received at the time of sale. Unlike invoices which request payment, sales receipts confirm that payment has already been received and serve as proof of purchase for the customer.

Properties

idstring

The Rutter generated unique ID of the sales receipt.

platform_idstring

The platform specific ID of the sales receipt.

customer_idstringfilterablenullable

The Rutter ID of the Customers linked to the sales receipt.

issue_datestringnullable

The ISO 8601 timestamp for when the sales receipt was issued.

amount_duenumbernullable

The current amount due on the sales receipt.

currency_codeenumnullable

The ISO 4217 currency code of the sales receipt.

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, ZMW, ETH, BTC, or null.

discount_amountnumbernullable

The total amount of discounts applied to the sales receipt.

document_numberstringfilterablenullable

The seller facing document number of the sales receipt.

memostringnullable

The customer-facing memo on the sales receipt. Supported for QuickBooks.

referencestringfilterablenullable

The reference identifier of the sales receipt. Supported for QuickBooks.

total_amountnumbernullable

The total amount on the sales receipt.

linked_transactionsarray

An array of transactions linked to the sales receipt.

Show linked_transactions attributes

line_itemsarray

An array of line items associated with the sales receipt.

Show line_items attributes

additional_fieldsobjectOptional

Additional fields required only for a narrow set of use cases.

Show additional_fields attributes

created_atstringfilterablenullable

The ISO 8601 timestamp that the sales receipt was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

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

platform_urlstringnullable

A 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_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/sales_receipts

GET

/accounting/sales_receipts/:id

POST

/accounting/sales_receipts

List Sales Receipts

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

filterstringqueryOptional

Not 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: document_number, customer_id, reference, created_at, updated_at, last_synced_at.

sortstringqueryOptional

Used 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 Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: document_number, customer_id, reference, created_at, updated_at, last_synced_at.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Deprecated - 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_maxintegerqueryOptional

Deprecated - 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_minintegerqueryOptional

Deprecated - 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_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "sales_receipts": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "customer_id": "00000000-0000-0000-0000-000000000000",
7      "issue_date": "2023-01-02T02:34:56.000Z",
8      "amount_due": 0,
9      "currency_code": "USD",
10      "discount_amount": 0,
11      "document_number": "SR-001",
12      "memo": "Customer-facing memo",
13      "reference": "REF-001",
14      "total_amount": 12.34,
15      "linked_transactions": [],
16      "line_items": [
17        {
18          "class_id": "00000000-0000-0000-0000-000000000000",
19          "description": "Example sales receipt line item",
20          "total_amount": 12.34,
21          "item": {
22            "id": "00000000-0000-0000-0000-000000000000",
23            "quantity": 1,
24            "unit_amount": 12.34
25          }
26        }
27      ],
28      "additional_fields": {
29        "billing_email": "customer@example.com",
30        "internal_memo": "Internal note for sales receipt",
31        "tax_amount": 0,
32        "addresses": []
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 Sales Receipt

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

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "sales_receipt": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "customer_id": "00000000-0000-0000-0000-000000000000",
6    "issue_date": "2023-01-02T02:34:56.000Z",
7    "amount_due": 0,
8    "currency_code": "USD",
9    "discount_amount": 0,
10    "document_number": "SR-001",
11    "memo": "Customer-facing memo",
12    "reference": "REF-001",
13    "total_amount": 12.34,
14    "linked_transactions": [],
15    "line_items": [
16      {
17        "class_id": "00000000-0000-0000-0000-000000000000",
18        "description": "Example sales receipt line item",
19        "total_amount": 12.34,
20        "item": {
21          "id": "00000000-0000-0000-0000-000000000000",
22          "quantity": 1,
23          "unit_amount": 12.34
24        }
25      }
26    ],
27    "additional_fields": {
28      "billing_email": "customer@example.com",
29      "internal_memo": "Internal note for sales receipt",
30      "tax_amount": 0,
31      "addresses": []
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 Sales Receipt

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

The 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.

One ofasync or prefer_sync.

sales_receiptobject

Show sales_receipt attributes

Response Body

Example Request Body

JSON

1{
2  "sales_receipt": {
3    "customer_id": "00000000-0000-0000-0000-000000000000",
4    "issue_date": "2023-01-02T02:34:56.000Z",
5    "currency_code": "USD",
6    "document_number": "SR-001",
7    "reference": "REF-001",
8    "line_items": [
9      {
10        "total_amount": 12.34,
11        "description": "Example sales receipt line item",
12        "item": {
13          "id": "00000000-0000-0000-0000-000000000000",
14          "quantity": 1,
15          "unit_amount": 12.34
16        }
17      }
18    ]
19  }
20}

200

Example Response Body

JSON

1{
2  "sales_receipt": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "customer_id": "00000000-0000-0000-0000-000000000000",
6    "issue_date": "2023-01-02T02:34:56.000Z",
7    "amount_due": 0,
8    "currency_code": "USD",
9    "discount_amount": 0,
10    "document_number": "SR-001",
11    "memo": "Customer-facing memo",
12    "reference": "REF-001",
13    "total_amount": 12.34,
14    "linked_transactions": [],
15    "line_items": [
16      {
17        "class_id": "00000000-0000-0000-0000-000000000000",
18        "description": "Example sales receipt line item",
19        "total_amount": 12.34,
20        "item": {
21          "id": "00000000-0000-0000-0000-000000000000",
22          "quantity": 1,
23          "unit_amount": 12.34
24        }
25      }
26    ],
27    "additional_fields": {
28      "billing_email": "customer@example.com",
29      "internal_memo": "Internal note for sales receipt",
30      "tax_amount": 0,
31      "addresses": []
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}

Have questions?

Contact support for personalized guidance.

Contact support