The Bill object
A Rutter Bill represents a bill issued by a vendor that the business entity must pay. Every expense is linked to an accounts payable Account, a Vendor, Purchase Orders, Bill Payments, and Bill Credit Memos.
The bill line item contains information regarding the items purchased and accounts affected in the bill. Every bill line item is linked to a debit Account, Tax Rate, and Item.
Properties
id
stringThe Rutter generated unique ID of the bill.
platform_id
stringThe platform specific ID of the bill.
memo
stringnullableMemo or description of the bill
document_number
stringnullableThe buyer facing document number of the bill.
account_id
stringoptionalThe Rutter ID of the Account linked to the bill. Represents the AP account being credited.
vendor_id
stringnullableThe Rutter ID of the Vendor linked to the bill.
issue_date
stringThe ISO 8601 timestamp for the issue date of the bill..
due_date
stringThe ISO 8601 timestamp of the due date of the bill.
status
enumThe status of the bill.
total_discount
stringnullableThe total amount of discounts applied to the bill.
sub_total
stringnullableThe subtotal of the bill, without the tax amount.
tax_amount
stringnullableThe total tax amount applied to the bill.
total_amount
stringThe total amount due on the bill.
amount_due
stringThe current amount due on the bill. Represents the remainder after bill payments or bill credit memos are applied against the total amount.
created_at
stringnullableupdated_at
stringnullablecurrency
enumThe ISO 4217 currency code of the bill.
payments
arrayAn array of Rutter IDs of Bill Payments and Bill Credit Memos applied against the bill.
payments
attributespurchase_orders
arrayAn array of Rutter IDs of Purchase Orders linked to the bill.
purchase_orders
attributesline_items
arrayAn array of line items associated with the bill.
line_items
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDBILL-1",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"memo": "Bill description",
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"issue_date": "2023-01-02T02:34:56.000Z",
"due_date": "2023-01-02T02:34:56.000Z",
"currency": "USD",
"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"
}
],
"status": "partially_paid",
"total_discount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"total_amount": "14.34",
"amount_due": "9.34",
"payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_PAYMENT",
"amount": "3",
"date": "2023-01-02T02:34:56.000Z"
},
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_CREDIT_MEMO",
"amount": "2",
"date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Bills
GET /accounting/billsRequest 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
attributesbills
arraybills
attributesnext_cursor
stringnullableoptional{
"bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDBILL-1",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"memo": "Bill description",
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"issue_date": "2023-01-02T02:34:56.000Z",
"due_date": "2023-01-02T02:34:56.000Z",
"currency": "USD",
"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"
}
],
"status": "partially_paid",
"total_discount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"total_amount": "14.34",
"amount_due": "9.34",
"payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_PAYMENT",
"amount": "3",
"date": "2023-01-02T02:34:56.000Z"
},
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_CREDIT_MEMO",
"amount": "2",
"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
GET /accounting/bills/: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
Billbill
attributes{
"bill": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDBILL-1",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"memo": "Bill description",
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"issue_date": "2023-01-02T02:34:56.000Z",
"due_date": "2023-01-02T02:34:56.000Z",
"currency": "USD",
"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"
}
],
"status": "partially_paid",
"total_discount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"total_amount": "14.34",
"amount_due": "9.34",
"payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_PAYMENT",
"amount": "3",
"date": "2023-01-02T02:34:56.000Z"
},
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_CREDIT_MEMO",
"amount": "2",
"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
POST /accounting/billsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill
objectbill
attributesResponse Body
Any of:
Bill Response
bill
Billbill
attributesAsync Response Payload
async_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill": {
"vendor_id": "00000000-0000-0000-0000-000000000000",
"currency": "USD",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"amount": 12.34,
"description": "A Rutter shirt."
}
],
"due_date": "2023-01-02T02:34:56.000Z",
"issue_date": "2023-01-02T02:34:56.000Z"
}
}
{
"bill": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDBILL-1",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"memo": "Bill description",
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"issue_date": "2023-01-02T02:34:56.000Z",
"due_date": "2023-01-02T02:34:56.000Z",
"currency": "USD",
"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"
}
],
"status": "partially_paid",
"total_discount": "0",
"sub_total": "12.34",
"tax_amount": "2",
"total_amount": "14.34",
"amount_due": "9.34",
"payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_PAYMENT",
"amount": "3",
"date": "2023-01-02T02:34:56.000Z"
},
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "BILL_CREDIT_MEMO",
"amount": "2",
"date": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}