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
id
stringThe Rutter generated unique ID of the bill credit memo.
platform_id
stringThe platform specific ID of the bill credit memo.
memo
stringnullableThe memo of the bill credit memo
document_number
stringThe buyer facing document number of the bill credit memo.
account_id
stringnullableThe Rutter ID of the Account linked to the bill credit memo. Represents the account being credited.
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.
currency_code
enumnullableThe ISO 4217 currency code of the bill credit memo.
status
enumThe status of the bill credit memo.
created_at
stringnullableupdated_at
stringnullableplatform_data
optionalThe raw platform data corresponding to the Rutter object.
line_items
arrayAn array of line items associated with the BillCreditMemo.
line_items
attributeslinked_bills
arrayAn array of Rutter IDs of BillCreditMemo Payments applied against the BillCreditMemo.
linked_bills
attributesallocated_at
stringnullableThe ISO 8601 timestamp for when the bill credit memo was allocated.
total_amount
stringnullableThe total amount of the bill credit memo.
remaining_amount
stringnullableThe remaining unapplied amount of the bill credit memo.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"document_number": "VENDCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "paid",
"total_amount": "3",
"remaining_amount": "0",
"line_items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"unit_amount": "12.34",
"quantity": "1",
"discount_amount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"amount": "14.34",
"discount_percentage": "0",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"item_id": "00000000-0000-0000-0000-000000000000",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"unit_amount": 12.34,
"quantity": 1
},
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000"
}
],
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3",
"allocated_date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Bill Credit Memos
GET /accounting/bill_credit_memosRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
connection
Connectionconnection
attributesbill_credit_memos
arraybill_credit_memos
attributesnext_cursor
stringnullableoptional{
"bill_credit_memos": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"document_number": "VENDCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "paid",
"total_amount": "3",
"remaining_amount": "0",
"line_items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"unit_amount": "12.34",
"quantity": "1",
"discount_amount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"amount": "14.34",
"discount_percentage": "0",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"item_id": "00000000-0000-0000-0000-000000000000",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"unit_amount": 12.34,
"quantity": 1
},
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000"
}
],
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3",
"allocated_date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
Fetch a Bill Credit Memo
GET /accounting/bill_credit_memos/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
Connectionconnection
attributesbill_credit_memo
BillCreditMemobill_credit_memo
attributes{
"bill_credit_memo": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"document_number": "VENDCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "paid",
"total_amount": "3",
"remaining_amount": "0",
"line_items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"unit_amount": "12.34",
"quantity": "1",
"discount_amount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"amount": "14.34",
"discount_percentage": "0",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"item_id": "00000000-0000-0000-0000-000000000000",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"unit_amount": 12.34,
"quantity": 1
},
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000"
}
],
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3",
"allocated_date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
},
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
Create a Bill Credit Memo
POST /accounting/bill_credit_memosRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill_credit_memo
Bill Credit Memobill_credit_memo
attributesResponse Body
Any of:
BillCreditMemo Response
bill_credit_memo
BillCreditMemobill_credit_memo
attributesAsync Response Payload
async_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_credit_memo": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"document_number": "VENDCRED-1",
"issue_date": "2023-01-02T02:34:56.000Z",
"allocated_at": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"status": "paid",
"total_amount": "3",
"remaining_amount": "0",
"line_items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"unit_amount": "12.34",
"quantity": "1",
"discount_amount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"amount": "14.34",
"discount_percentage": "0",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"item_id": "00000000-0000-0000-0000-000000000000",
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"unit_amount": 12.34,
"quantity": 1
},
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000"
}
],
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": "3",
"allocated_date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}
Create a Bill Credit Application
POST /accounting/bill_credit_applicationsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill_credit_application
objectbill_credit_application
attributesResponse Body
Any of:
Create Bill Credit Application Response Response
bill_credit_application
Create Bill Credit Application Responsebill_credit_application
attributesAsync Response Payload
async_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_credit_application": {
"bill_credit_memo_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"currency_code": "USD",
"transaction_date": "2023-01-02T02:34:56.000Z",
"memo": "Applying vendor credit for bill.",
"linked_bills": [
{
"allocated_amount": 12.34,
"id": "00000000-0000-0000-0000-000000000000"
}
]
}
}
{
"bill_credit_application": {
"success": true
}
}