Bill Credit Memos
Properties
id
stringRequiredThe Rutter generated unique ID of the bill credit memo.
platform_id
stringRequiredThe platform specific ID of the bill credit memo.
account_id
stringnullableRequiredThe 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
stringnullableRequiredThe Rutter ID of the Vendor linked to the bill credit memo.
allocated_at
stringnullableRequiredThe ISO 8601 timestamp for when the bill credit memo was allocated.
issue_date
stringRequiredThe ISO 8601 timestamp for when the bill credit memo was issued.
document_number
stringRequiredThe buyer facing document number of the bill credit memo.
status
enumRequiredThe status of the bill credit memo.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the bill credit memo.
memo
stringnullableRequiredThe memo of the bill credit memo
remaining_amount
stringnullableRequiredThe remaining unapplied amount of the bill credit memo.
total_amount
stringnullableRequiredThe total amount of the bill credit memo.
linked_bills
arrayRequiredAn array of Rutter IDs of Bills applied against the BillCreditMemo.
linked_bills
attributesline_items
arrayRequiredAn array of line items associated with the BillCreditMemo.
line_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill credit memo was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill credit memo was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bill credit memo was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Bill Credit Memos
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributesbill_credit_memos
arrayRequiredbill_credit_memos
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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 "allocated_at": "2023-01-02T02:34:56.000Z",
14 "issue_date": "2023-01-02T02:34:56.000Z",
15 "document_number": "VENDCRED-1",
16 "status": "paid",
17 "currency_code": "USD",
18 "memo": "Discount for future Rutter shirts.",
19 "remaining_amount": "0",
20 "total_amount": "3",
21 "linked_bills": [
22 {
23 "id": "00000000-0000-0000-0000-000000000000",
24 "allocated_date": "2023-01-02T02:34:56.000Z",
25 "allocated_amount": "3"
26 }
27 ],
28 "line_items": [
29 {
30 "id": "00000000-0000-0000-0000-000000000000",
31 "account_id": "00000000-0000-0000-0000-000000000000",
32 "class_id": "00000000-0000-0000-0000-000000000000",
33 "customer_id": "00000000-0000-0000-0000-000000000000",
34 "department_id": "00000000-0000-0000-0000-000000000000",
35 "item_id": "00000000-0000-0000-0000-000000000000",
36 "location_id": "00000000-0000-0000-0000-000000000000",
37 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
38 "description": "A Rutter shirt.",
39 "amount": "14.34",
40 "discount_amount": "0",
41 "discount_percentage": "0",
42 "quantity": "1",
43 "sub_total": "12.34",
44 "tax_amount": "2",
45 "unit_amount": "12.34",
46 "item": {
47 "id": "00000000-0000-0000-0000-000000000000",
48 "quantity": 1,
49 "unit_amount": 12.34
50 }
51 }
52 ],
53 "created_at": "2023-01-02T02:34:56.000Z",
54 "updated_at": "2023-01-02T02:34:56.000Z",
55 "last_synced_at": "2023-01-02T02:34:56.000Z",
56 "platform_data": {
57 "id": 123,
58 "data": "Varies by platform"
59 }
60 }
61 ],
62 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
63}
Fetch a Bill Credit Memo
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributesbill_credit_memo
objectRequiredbill_credit_memo
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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 "allocated_at": "2023-01-02T02:34:56.000Z",
13 "issue_date": "2023-01-02T02:34:56.000Z",
14 "document_number": "VENDCRED-1",
15 "status": "paid",
16 "currency_code": "USD",
17 "memo": "Discount for future Rutter shirts.",
18 "remaining_amount": "0",
19 "total_amount": "3",
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 "id": "00000000-0000-0000-0000-000000000000",
30 "account_id": "00000000-0000-0000-0000-000000000000",
31 "class_id": "00000000-0000-0000-0000-000000000000",
32 "customer_id": "00000000-0000-0000-0000-000000000000",
33 "department_id": "00000000-0000-0000-0000-000000000000",
34 "item_id": "00000000-0000-0000-0000-000000000000",
35 "location_id": "00000000-0000-0000-0000-000000000000",
36 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
37 "description": "A Rutter shirt.",
38 "amount": "14.34",
39 "discount_amount": "0",
40 "discount_percentage": "0",
41 "quantity": "1",
42 "sub_total": "12.34",
43 "tax_amount": "2",
44 "unit_amount": "12.34",
45 "item": {
46 "id": "00000000-0000-0000-0000-000000000000",
47 "quantity": 1,
48 "unit_amount": 12.34
49 }
50 }
51 ],
52 "created_at": "2023-01-02T02:34:56.000Z",
53 "updated_at": "2023-01-02T02:34:56.000Z",
54 "last_synced_at": "2023-01-02T02:34:56.000Z",
55 "platform_data": {
56 "id": 123,
57 "data": "Varies by platform"
58 }
59 }
60}
Create a Bill Credit Memo
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill_credit_memo
objectRequiredbill_credit_memo
attributesResponse Body
Any of:
bill_credit_memo
objectRequiredbill_credit_memo
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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 "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 "allocated_at": "2023-01-02T02:34:56.000Z",
8 "issue_date": "2023-01-02T02:34:56.000Z",
9 "document_number": "VENDCRED-1",
10 "status": "paid",
11 "currency_code": "USD",
12 "memo": "Discount for future Rutter shirts.",
13 "remaining_amount": "0",
14 "total_amount": "3",
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 "id": "00000000-0000-0000-0000-000000000000",
25 "account_id": "00000000-0000-0000-0000-000000000000",
26 "class_id": "00000000-0000-0000-0000-000000000000",
27 "customer_id": "00000000-0000-0000-0000-000000000000",
28 "department_id": "00000000-0000-0000-0000-000000000000",
29 "item_id": "00000000-0000-0000-0000-000000000000",
30 "location_id": "00000000-0000-0000-0000-000000000000",
31 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
32 "description": "A Rutter shirt.",
33 "amount": "14.34",
34 "discount_amount": "0",
35 "discount_percentage": "0",
36 "quantity": "1",
37 "sub_total": "12.34",
38 "tax_amount": "2",
39 "unit_amount": "12.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 Application
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill_credit_application
objectRequiredbill_credit_application
attributesResponse Body
Any of:
bill_credit_application
objectRequiredbill_credit_application
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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.