Bill Credit Memos
Properties
id
stringThe Rutter generated unique ID of the bill credit memo.
platform_id
stringThe platform specific ID of the bill credit memo.
account_id
stringnullableThe 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_id
stringnullableThe Rutter ID of the Vendor linked to the bill credit memo.
issue_date
stringThe ISO 8601 timestamp for when the bill credit memo was issued.
document_number
stringThe buyer facing document number of the bill credit memo.
remaining_amount
numberThe remaining unapplied amount of the bill credit memo.
status
enumThe status of the bill credit memo.
total_amount
numberThe total amount of the bill credit memo.
currency_code
enumnullableThe ISO 4217 currency code of the bill credit memo.
memo
stringnullableThe memo of the bill credit memo
linked_bills
arrayAn array of Rutter IDs of BillCreditMemo Payments applied against the BillCreditMemo.
linked_bills
attributesline_items
arrayAn array of line items associated with the BillCreditMemo.
line_items
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the bill credit memo was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the bill credit memo was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the bill credit memo was last synced by Rutter.
platform_url
stringnullableA 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_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bill Credit Memos
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot yet supported on Sage Intacct or Dynamics 365 Business Central. 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: created_at
, updated_at
, last_synced_at
.
sort
stringqueryOptionalUsed 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
and last_synced_at
fields are supported.
Sortable fields: created_at
, updated_at
, last_synced_at
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not yet supported on Sage Intacct or Dynamics 365 Business Central.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
bill_credit_memo
objectbill_credit_memo
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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}
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
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
bill_credit_application
objectbill_credit_application
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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}
1{
2 "bill_credit_application": {
3 "success": true
4 }
5}
Have questions?
Contact support for personalized guidance.