Bills
The Bill Object
A Rutter Bill represents a bill issued by a vendor that the business entity must pay. Every bill 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.
Files can be attached to Rutter Bills in the form of Rutter Attachments.
Properties
id
stringThe Rutter generated unique ID of the bill.
platform_id
stringThe platform specific ID of the bill.
account_id
stringnullableThe Rutter ID of the Account linked to the bill. Represents the AP account being credited.
payment_terms_id
stringnullableAn array of Rutter IDs of Payment Terms linked to the bill.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the bill. Supported for NetSuite.
vendor_id
stringnullableThe Rutter ID of the Vendor linked to the bill.
due_date
stringnullableThe ISO 8601 timestamp for the due date of the bill.
issue_date
stringThe ISO 8601 timestamp for the issue date of the bill.
amount_due
numberThe current amount due on the bill. Represents the remainder after bill payments or bill credit memos are applied against the total amount.
currency_code
enumThe ISO 4217 currency code of the bill.
status
enumThe status of the bill.
total_amount
numberThe total amount of the bill.
document_number
stringnullableThe buyer facing document number of the bill.
memo
stringnullableThe memo of the bill.
sub_total
numbernullableThe subtotal of the bill, without the tax amount.
tax_amount
numbernullableThe tax amount applied to the bill.
total_discount
numbernullableThe discount amount applied to the bill.
linked_purchase_orders
arrayAn array of Rutter IDs of Purchase Orders linked to the bill.
linked_purchase_orders
attributescurrency_rate
stringnullableOptionalThe exchange rate between the currency of the bill and the business default currency. Supported for NetSuite, QuickBooks, and Xero.
linked_credit_memos
arrayAn array of Rutter IDs of Bill Credit Memos applied against the bill.
linked_credit_memos
attributeslinked_payments
arrayAn array of Rutter IDs of Bill Payments applied against the bill.
linked_payments
attributesline_items
arrayAn array of line items associated with the bill.
line_items
attributescreated_at
stringnullableThe ISO 8601 timestamp that the bill was created.
updated_at
stringnullableThe ISO 8601 timestamp that the bill was last updated.
last_synced_at
stringThe ISO 8601 timestamp when the bill was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bills
Request Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringqueryOptionalThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
document_number
stringqueryOptionalThe exact document number to filter on. Not supported on Sage Intacct, or Dynamics 365.
expand
enumqueryOptionalUsed to request inclusion of optional objects.
force_fetch
enumqueryOptionalForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryOptionalUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryOptionalThe number of entities to return. Defaults to 50. Maximum is 500.
sort
stringqueryOptionalThe 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
integerqueryOptionalUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryOptionalUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesbills
arraybills
attributesnext_cursor
stringnullableOptional- 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 "bills": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "account_id": "00000000-0000-0000-0000-000000000000",
12 "payment_terms_id": "00000000-0000-0000-0000-000000000000",
13 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
14 "vendor_id": "00000000-0000-0000-0000-000000000000",
15 "due_date": "2023-01-02T02:34:56.000Z",
16 "issue_date": "2023-01-02T02:34:56.000Z",
17 "amount_due": 9.34,
18 "currency_code": "USD",
19 "status": "partially_paid",
20 "total_amount": 14.34,
21 "document_number": "VENDBILL-1",
22 "memo": "Bill description",
23 "sub_total": 12.34,
24 "tax_amount": 2,
25 "total_discount": 0,
26 "linked_purchase_orders": [
27 {
28 "id": "00000000-0000-0000-0000-000000000000"
29 }
30 ],
31 "currency_rate": "3.5",
32 "linked_credit_memos": [
33 {
34 "id": "00000000-0000-0000-0000-000000000000",
35 "allocated_date": "2023-01-02T02:34:56.000Z",
36 "allocated_amount": 2
37 }
38 ],
39 "linked_payments": [
40 {
41 "id": "00000000-0000-0000-0000-000000000000",
42 "allocated_date": "2023-01-02T02:34:56.000Z",
43 "allocated_amount": 3
44 }
45 ],
46 "line_items": [
47 {
48 "account_id": "00000000-0000-0000-0000-000000000000",
49 "class_id": "00000000-0000-0000-0000-000000000000",
50 "customer_id": "00000000-0000-0000-0000-000000000000",
51 "department_id": "00000000-0000-0000-0000-000000000000",
52 "location_id": "00000000-0000-0000-0000-000000000000",
53 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
54 "description": "A Rutter shirt.",
55 "discount_amount": 0,
56 "discount_percentage": 0,
57 "sub_total": 12.34,
58 "tax_amount": 2,
59 "total_amount": 14.34,
60 "item": {
61 "id": "00000000-0000-0000-0000-000000000000",
62 "quantity": 1,
63 "unit_amount": 12.34
64 }
65 }
66 ],
67 "created_at": "2023-01-02T02:34:56.000Z",
68 "updated_at": "2023-01-02T02:34:56.000Z",
69 "last_synced_at": "2023-01-02T02:34:56.000Z",
70 "platform_data": {
71 "id": 123,
72 "data": "Varies by platform"
73 }
74 }
75 ],
76 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
77}
Fetch a Bill
Request Parameters
id
stringpathThe unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumqueryOptionalForce a response even if the underlying connection hasn't finished the initial sync.
id_type
enumqueryOptionalOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
Response Body
connection
objectconnection
attributesbill
objectbill
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": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "account_id": "00000000-0000-0000-0000-000000000000",
11 "payment_terms_id": "00000000-0000-0000-0000-000000000000",
12 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
13 "vendor_id": "00000000-0000-0000-0000-000000000000",
14 "due_date": "2023-01-02T02:34:56.000Z",
15 "issue_date": "2023-01-02T02:34:56.000Z",
16 "amount_due": 9.34,
17 "currency_code": "USD",
18 "status": "partially_paid",
19 "total_amount": 14.34,
20 "document_number": "VENDBILL-1",
21 "memo": "Bill description",
22 "sub_total": 12.34,
23 "tax_amount": 2,
24 "total_discount": 0,
25 "linked_purchase_orders": [
26 {
27 "id": "00000000-0000-0000-0000-000000000000"
28 }
29 ],
30 "currency_rate": "3.5",
31 "linked_credit_memos": [
32 {
33 "id": "00000000-0000-0000-0000-000000000000",
34 "allocated_date": "2023-01-02T02:34:56.000Z",
35 "allocated_amount": 2
36 }
37 ],
38 "linked_payments": [
39 {
40 "id": "00000000-0000-0000-0000-000000000000",
41 "allocated_date": "2023-01-02T02:34:56.000Z",
42 "allocated_amount": 3
43 }
44 ],
45 "line_items": [
46 {
47 "account_id": "00000000-0000-0000-0000-000000000000",
48 "class_id": "00000000-0000-0000-0000-000000000000",
49 "customer_id": "00000000-0000-0000-0000-000000000000",
50 "department_id": "00000000-0000-0000-0000-000000000000",
51 "location_id": "00000000-0000-0000-0000-000000000000",
52 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
53 "description": "A Rutter shirt.",
54 "discount_amount": 0,
55 "discount_percentage": 0,
56 "sub_total": 12.34,
57 "tax_amount": 2,
58 "total_amount": 14.34,
59 "item": {
60 "id": "00000000-0000-0000-0000-000000000000",
61 "quantity": 1,
62 "unit_amount": 12.34
63 }
64 }
65 ],
66 "created_at": "2023-01-02T02:34:56.000Z",
67 "updated_at": "2023-01-02T02:34:56.000Z",
68 "last_synced_at": "2023-01-02T02:34:56.000Z",
69 "platform_data": {
70 "id": 123,
71 "data": "Varies by platform"
72 }
73 }
74}
Create a Bill
Request Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill
objectbill
attributesResponse Body
Any of:
bill
objectbill
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "bill": {
3 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
4 "vendor_id": "00000000-0000-0000-0000-000000000000",
5 "due_date": "2023-01-02T02:34:56.000Z",
6 "issue_date": "2023-01-02T02:34:56.000Z",
7 "currency_code": "USD",
8 "currency_rate": "3.5",
9 "line_items": [
10 {
11 "account_id": "00000000-0000-0000-0000-000000000000",
12 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
13 "total_amount": 12.34,
14 "description": "A Rutter shirt.",
15 "item": {
16 "id": "00000000-0000-0000-0000-000000000000",
17 "quantity": 1,
18 "unit_amount": 12.34
19 }
20 }
21 ]
22 }
23}
1{
2 "bill": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "payment_terms_id": "00000000-0000-0000-0000-000000000000",
7 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
8 "vendor_id": "00000000-0000-0000-0000-000000000000",
9 "due_date": "2023-01-02T02:34:56.000Z",
10 "issue_date": "2023-01-02T02:34:56.000Z",
11 "amount_due": 9.34,
12 "currency_code": "USD",
13 "status": "partially_paid",
14 "total_amount": 14.34,
15 "document_number": "VENDBILL-1",
16 "memo": "Bill description",
17 "sub_total": 12.34,
18 "tax_amount": 2,
19 "total_discount": 0,
20 "linked_purchase_orders": [
21 {
22 "id": "00000000-0000-0000-0000-000000000000"
23 }
24 ],
25 "currency_rate": "3.5",
26 "linked_credit_memos": [
27 {
28 "id": "00000000-0000-0000-0000-000000000000",
29 "allocated_date": "2023-01-02T02:34:56.000Z",
30 "allocated_amount": 2
31 }
32 ],
33 "linked_payments": [
34 {
35 "id": "00000000-0000-0000-0000-000000000000",
36 "allocated_date": "2023-01-02T02:34:56.000Z",
37 "allocated_amount": 3
38 }
39 ],
40 "line_items": [
41 {
42 "account_id": "00000000-0000-0000-0000-000000000000",
43 "class_id": "00000000-0000-0000-0000-000000000000",
44 "customer_id": "00000000-0000-0000-0000-000000000000",
45 "department_id": "00000000-0000-0000-0000-000000000000",
46 "location_id": "00000000-0000-0000-0000-000000000000",
47 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
48 "description": "A Rutter shirt.",
49 "discount_amount": 0,
50 "discount_percentage": 0,
51 "sub_total": 12.34,
52 "tax_amount": 2,
53 "total_amount": 14.34,
54 "item": {
55 "id": "00000000-0000-0000-0000-000000000000",
56 "quantity": 1,
57 "unit_amount": 12.34
58 }
59 }
60 ],
61 "created_at": "2023-01-02T02:34:56.000Z",
62 "updated_at": "2023-01-02T02:34:56.000Z",
63 "last_synced_at": "2023-01-02T02:34:56.000Z",
64 "platform_data": {
65 "id": 123,
66 "data": "Varies by platform"
67 }
68 }
69}
Update a Bill
If a field value is provided, that field will take the updated value. If the field is not provided, the existing value will persist.
Request Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
Request Body
bill
objectbill
attributesResponse Body
Any of:
bill
objectbill
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "bill": {
3 "memo": "Example Memo"
4 }
5}
1{
2 "bill": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "payment_terms_id": "00000000-0000-0000-0000-000000000000",
7 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
8 "vendor_id": "00000000-0000-0000-0000-000000000000",
9 "due_date": "2023-01-02T02:34:56.000Z",
10 "issue_date": "2023-01-02T02:34:56.000Z",
11 "amount_due": 9.34,
12 "currency_code": "USD",
13 "status": "partially_paid",
14 "total_amount": 14.34,
15 "document_number": "VENDBILL-1",
16 "memo": "Bill description",
17 "sub_total": 12.34,
18 "tax_amount": 2,
19 "total_discount": 0,
20 "linked_purchase_orders": [
21 {
22 "id": "00000000-0000-0000-0000-000000000000"
23 }
24 ],
25 "currency_rate": "3.5",
26 "linked_credit_memos": [
27 {
28 "id": "00000000-0000-0000-0000-000000000000",
29 "allocated_date": "2023-01-02T02:34:56.000Z",
30 "allocated_amount": 2
31 }
32 ],
33 "linked_payments": [
34 {
35 "id": "00000000-0000-0000-0000-000000000000",
36 "allocated_date": "2023-01-02T02:34:56.000Z",
37 "allocated_amount": 3
38 }
39 ],
40 "line_items": [
41 {
42 "account_id": "00000000-0000-0000-0000-000000000000",
43 "class_id": "00000000-0000-0000-0000-000000000000",
44 "customer_id": "00000000-0000-0000-0000-000000000000",
45 "department_id": "00000000-0000-0000-0000-000000000000",
46 "location_id": "00000000-0000-0000-0000-000000000000",
47 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
48 "description": "A Rutter shirt.",
49 "discount_amount": 0,
50 "discount_percentage": 0,
51 "sub_total": 12.34,
52 "tax_amount": 2,
53 "total_amount": 14.34,
54 "item": {
55 "id": "00000000-0000-0000-0000-000000000000",
56 "quantity": 1,
57 "unit_amount": 12.34
58 }
59 }
60 ],
61 "created_at": "2023-01-02T02:34:56.000Z",
62 "updated_at": "2023-01-02T02:34:56.000Z",
63 "last_synced_at": "2023-01-02T02:34:56.000Z",
64 "platform_data": {
65 "id": 123,
66 "data": "Varies by platform"
67 }
68 }
69}
Delete a Bill
Request Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
Response Body
Any of:
deleted_bill
objectdeleted_bill
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- Netsuite
- Xero
1{
2 "deleted_bill": {
3 "code": "deleted",
4 "success": true
5 }
6}
Have questions?
Contact support for personalized guidance.