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.
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
stringnullableThe ISO 8601 timestamp that the bill credit memo was created.
updated_at
stringnullableThe ISO 8601 timestamp that the bill credit memo was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"document_number": "VENDCRED-1",
"remaining_amount": 3,
"status": "paid",
"total_amount": 3,
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 3
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"discount_amount": 0,
"discount_percentage": 0,
"sub_total": 12.34,
"tax_amount": 2,
"total_amount": 14.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Bill Credit Memos
GET /versioned/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
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesbill_credit_memos
arraybill_credit_memos
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bill_credit_memos": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"document_number": "VENDCRED-1",
"remaining_amount": 3,
"status": "paid",
"total_amount": 3,
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 3
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"discount_amount": 0,
"discount_percentage": 0,
"sub_total": 12.34,
"tax_amount": 2,
"total_amount": 14.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Bill Credit Memo
GET /versioned/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
objectconnection
attributesbill_credit_memo
objectbill_credit_memo
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bill_credit_memo": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"document_number": "VENDCRED-1",
"remaining_amount": 3,
"status": "paid",
"total_amount": 3,
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 3
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"discount_amount": 0,
"discount_percentage": 0,
"sub_total": 12.34,
"tax_amount": 2,
"total_amount": 14.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create a Bill Credit Memo
POST /versioned/accounting/bill_credit_memosRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill_credit_memo
objectbill_credit_memo
attributesResponse Body
Any of:
bill_credit_memo
objectbill_credit_memo
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_credit_memo": {
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 12.34,
"description": "A Rutter shirt."
}
]
}
}
{
"bill_credit_memo": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"document_number": "VENDCRED-1",
"remaining_amount": 3,
"status": "paid",
"total_amount": 3,
"currency_code": "USD",
"memo": "Discount for future Rutter shirts.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 3
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "A Rutter shirt.",
"discount_amount": 0,
"discount_percentage": 0,
"sub_total": 12.34,
"tax_amount": 2,
"total_amount": 14.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create a Bill Credit Application
POST /versioned/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:
bill_credit_application
objectbill_credit_application
attributesasync_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",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Applying vendor credit for bill.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": 12.34
}
]
}
}
{
"bill_credit_application": {
"success": true
}
}