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

idstring

The Rutter generated unique ID of the bill credit memo.

platform_idstring

The platform specific ID of the bill credit memo.

account_idstringnullable

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_idstringfilterablenullable

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

issue_datestring

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

document_numberstringfilterable

The buyer facing document number of the bill credit memo.

remaining_amountnumber

The remaining unapplied amount of the bill credit memo.

statusenum

The status of the bill credit memo.

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

total_amountnumber

The total amount of the bill credit memo.

currency_codeenumnullable

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

memostringnullable

The memo of the bill credit memo

linked_billsarray

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

Show linked_bills attributes

line_itemsarray

An array of line items associated with the BillCreditMemo.

Show line_items attributes

created_atstringfilterablenullable

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

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

The ISO 8601 timestamp when the bill credit memo 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/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.

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: vendor_id, document_number, 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 Dynamics 365 Business Central. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: vendor_id, document_number, 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

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

Example Response Body

JSON

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

Fetch a Bill Credit Memo

GEThttps://production.rutterapi.com/versioned/accounting/bill_credit_memos/: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

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

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        "project_id": "00000000-0000-0000-0000-000000000000",
29        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
30        "description": "A Rutter shirt.",
31        "discount_amount": 0,
32        "discount_percentage": 0,
33        "sub_total": 12.34,
34        "tax_amount": 2,
35        "total_amount": 14.34,
36        "item": {
37          "id": "00000000-0000-0000-0000-000000000000",
38          "quantity": 1,
39          "unit_amount": 12.34
40        }
41      }
42    ],
43    "created_at": "2023-01-02T02:34:56.000Z",
44    "updated_at": "2023-01-02T02:34:56.000Z",
45    "last_synced_at": "2023-01-02T02:34:56.000Z",
46    "platform_url": "https://platform.com/resource?id=123",
47    "platform_data": {
48      "id": 123,
49      "data": "Varies by platform"
50    }
51  },
52  "connection": {
53    "id": "00000000-0000-0000-0000-000000000000",
54    "orgId": "00000000-0000-0000-0000-000000000000",
55    "platform": "NETSUITE"
56  }
57}

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

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.

bill_credit_memoobject

Show bill_credit_memo attributes

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

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}

200

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        "project_id": "00000000-0000-0000-0000-000000000000",
29        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
30        "description": "A Rutter shirt.",
31        "discount_amount": 0,
32        "discount_percentage": 0,
33        "sub_total": 12.34,
34        "tax_amount": 2,
35        "total_amount": 14.34,
36        "item": {
37          "id": "00000000-0000-0000-0000-000000000000",
38          "quantity": 1,
39          "unit_amount": 12.34
40        }
41      }
42    ],
43    "created_at": "2023-01-02T02:34:56.000Z",
44    "updated_at": "2023-01-02T02:34:56.000Z",
45    "last_synced_at": "2023-01-02T02:34:56.000Z",
46    "platform_url": "https://platform.com/resource?id=123",
47    "platform_data": {
48      "id": 123,
49      "data": "Varies by platform"
50    }
51  }
52}

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

response_modeenumOptional

One ofasync or prefer_sync.

bill_credit_applicationobject

Show bill_credit_application attributes

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

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}

200

Example Response Body

JSON

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

Have questions?

Contact support for personalized guidance.

Contact support