Bill Credit Memos

The BillCreditMemo Object

A Rutter Bill Credit Memo represents a bill credit memo issued from a vendor that can be applied against a bill. Every bill credit memo is linked to an Vendor and zero or more Bills.

Properties

idstringRequired

The Rutter generated unique ID of the bill credit memo.

platform_idstringRequired

The platform specific ID of the bill credit memo.

account_idstringnullableRequired

The Rutter ID of the Account linked to the bill credit memo. Represents the account being credited. This is typically the primary Accounts Payable account.

vendor_idstringnullableRequired

The Rutter ID of the Vendor linked to the bill credit memo.

issue_datestringRequired

The ISO 8601 timestamp for when the bill credit memo was issued.

document_numberstringRequired

The buyer facing document number of the bill credit memo.

remaining_amountnumberRequired

The remaining unapplied amount of the bill credit memo.

statusenumRequired

The status of the bill credit memo.

One ofopen, partially_paid, paid, void, draft, unknown, or submitted.

total_amountnumberRequired

The total amount of the bill credit memo.

currency_codeenumnullableRequired

The ISO 4217 currency code of the bill credit memo.

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.

memostringnullableRequired

The memo of the bill credit memo

linked_billsarrayRequired

An array of Rutter IDs of BillCreditMemo Payments applied against the BillCreditMemo.

Show linked_bills attributes

line_itemsarrayRequired

An array of line items associated with the BillCreditMemo.

Show line_items attributes

created_atstringnullableRequired

The ISO 8601 timestamp that the bill credit memo was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the bill credit memo was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the bill credit memo was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/bill_credit_memos

GET

/accounting/bill_credit_memos/:id

POST

/accounting/bill_credit_memos

POST

/accounting/bill_credit_applications

List Bill Credit Memos

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

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

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 limit on the number of entities returned.

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

bill_credit_memosarrayRequired

Show bill_credit_memos attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

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  "bill_credit_memos": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "account_id": "00000000-0000-0000-0000-000000000000",
12      "vendor_id": "00000000-0000-0000-0000-000000000000",
13      "issue_date": "2023-01-02T02:34:56.000Z",
14      "document_number": "VENDCRED-1",
15      "remaining_amount": 3,
16      "status": "paid",
17      "total_amount": 3,
18      "currency_code": "USD",
19      "memo": "Discount for future Rutter shirts.",
20      "linked_bills": [
21        {
22          "id": "00000000-0000-0000-0000-000000000000",
23          "allocated_date": "2023-01-02T02:34:56.000Z",
24          "allocated_amount": 3
25        }
26      ],
27      "line_items": [
28        {
29          "account_id": "00000000-0000-0000-0000-000000000000",
30          "class_id": "00000000-0000-0000-0000-000000000000",
31          "customer_id": "00000000-0000-0000-0000-000000000000",
32          "department_id": "00000000-0000-0000-0000-000000000000",
33          "location_id": "00000000-0000-0000-0000-000000000000",
34          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
35          "description": "A Rutter shirt.",
36          "discount_amount": 0,
37          "discount_percentage": 0,
38          "sub_total": 12.34,
39          "tax_amount": 2,
40          "total_amount": 14.34,
41          "item": {
42            "id": "00000000-0000-0000-0000-000000000000",
43            "quantity": 1,
44            "unit_amount": 12.34
45          }
46        }
47      ],
48      "created_at": "2023-01-02T02:34:56.000Z",
49      "updated_at": "2023-01-02T02:34:56.000Z",
50      "last_synced_at": "2023-01-02T02:34:56.000Z",
51      "platform_data": {
52        "id": 123,
53        "data": "Varies by platform"
54      }
55    }
56  ],
57  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
58}

Fetch a Bill Credit Memo

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

Request Parameters

idstringpathRequired

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

Response Body

connectionobjectRequired

Show connection attributes

bill_credit_memoobjectRequired

Show bill_credit_memo attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

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  "bill_credit_memo": {
8    "id": "00000000-0000-0000-0000-000000000000",
9    "platform_id": "12345678",
10    "account_id": "00000000-0000-0000-0000-000000000000",
11    "vendor_id": "00000000-0000-0000-0000-000000000000",
12    "issue_date": "2023-01-02T02:34:56.000Z",
13    "document_number": "VENDCRED-1",
14    "remaining_amount": 3,
15    "status": "paid",
16    "total_amount": 3,
17    "currency_code": "USD",
18    "memo": "Discount for future Rutter shirts.",
19    "linked_bills": [
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "allocated_date": "2023-01-02T02:34:56.000Z",
23        "allocated_amount": 3
24      }
25    ],
26    "line_items": [
27      {
28        "account_id": "00000000-0000-0000-0000-000000000000",
29        "class_id": "00000000-0000-0000-0000-000000000000",
30        "customer_id": "00000000-0000-0000-0000-000000000000",
31        "department_id": "00000000-0000-0000-0000-000000000000",
32        "location_id": "00000000-0000-0000-0000-000000000000",
33        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
34        "description": "A Rutter shirt.",
35        "discount_amount": 0,
36        "discount_percentage": 0,
37        "sub_total": 12.34,
38        "tax_amount": 2,
39        "total_amount": 14.34,
40        "item": {
41          "id": "00000000-0000-0000-0000-000000000000",
42          "quantity": 1,
43          "unit_amount": 12.34
44        }
45      }
46    ],
47    "created_at": "2023-01-02T02:34:56.000Z",
48    "updated_at": "2023-01-02T02:34:56.000Z",
49    "last_synced_at": "2023-01-02T02:34:56.000Z",
50    "platform_data": {
51      "id": 123,
52      "data": "Varies by platform"
53    }
54  }
55}

Create a Bill Credit Memo

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bill_credit_memoobjectRequired

Show bill_credit_memo attributes

Response Body

Any of:

bill_credit_memoobjectRequired

Show bill_credit_memo attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Request Body

JSON

1{
2  "bill_credit_memo": {
3    "account_id": "00000000-0000-0000-0000-000000000000",
4    "vendor_id": "00000000-0000-0000-0000-000000000000",
5    "issue_date": "2023-01-02T02:34:56.000Z",
6    "currency_code": "USD",
7    "line_items": [
8      {
9        "account_id": "00000000-0000-0000-0000-000000000000",
10        "total_amount": 12.34,
11        "description": "A Rutter shirt."
12      }
13    ]
14  }
15}

Example Response Body

JSON

1{
2  "bill_credit_memo": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "account_id": "00000000-0000-0000-0000-000000000000",
6    "vendor_id": "00000000-0000-0000-0000-000000000000",
7    "issue_date": "2023-01-02T02:34:56.000Z",
8    "document_number": "VENDCRED-1",
9    "remaining_amount": 3,
10    "status": "paid",
11    "total_amount": 3,
12    "currency_code": "USD",
13    "memo": "Discount for future Rutter shirts.",
14    "linked_bills": [
15      {
16        "id": "00000000-0000-0000-0000-000000000000",
17        "allocated_date": "2023-01-02T02:34:56.000Z",
18        "allocated_amount": 3
19      }
20    ],
21    "line_items": [
22      {
23        "account_id": "00000000-0000-0000-0000-000000000000",
24        "class_id": "00000000-0000-0000-0000-000000000000",
25        "customer_id": "00000000-0000-0000-0000-000000000000",
26        "department_id": "00000000-0000-0000-0000-000000000000",
27        "location_id": "00000000-0000-0000-0000-000000000000",
28        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
29        "description": "A Rutter shirt.",
30        "discount_amount": 0,
31        "discount_percentage": 0,
32        "sub_total": 12.34,
33        "tax_amount": 2,
34        "total_amount": 14.34,
35        "item": {
36          "id": "00000000-0000-0000-0000-000000000000",
37          "quantity": 1,
38          "unit_amount": 12.34
39        }
40      }
41    ],
42    "created_at": "2023-01-02T02:34:56.000Z",
43    "updated_at": "2023-01-02T02:34:56.000Z",
44    "last_synced_at": "2023-01-02T02:34:56.000Z",
45    "platform_data": {
46      "id": 123,
47      "data": "Varies by platform"
48    }
49  }
50}

Create a Bill Credit Application

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bill_credit_applicationobjectRequired

Show bill_credit_application attributes

Response Body

Any of:

bill_credit_applicationobjectRequired

Show bill_credit_application attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Request Body

JSON

1{
2  "bill_credit_application": {
3    "bill_credit_memo_id": "00000000-0000-0000-0000-000000000000",
4    "vendor_id": "00000000-0000-0000-0000-000000000000",
5    "transaction_date": "2023-01-02T02:34:56.000Z",
6    "currency_code": "USD",
7    "memo": "Applying vendor credit for bill.",
8    "linked_bills": [
9      {
10        "id": "00000000-0000-0000-0000-000000000000",
11        "allocated_amount": 12.34
12      }
13    ]
14  }
15}

Example Response Body

JSON

1{
2  "bill_credit_application": {
3    "success": true
4  }
5}

Have questions?

Contact support for personalized guidance.

Contact support