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
stringRequiredThe Rutter generated unique ID of the bill.
platform_id
stringRequiredThe platform specific ID of the bill.
account_id
stringThe Rutter ID of the Account linked to the bill. Represents the AP account being credited.
payment_terms_id
stringnullableRequiredAn array of Rutter IDs of Payment Terms linked to the bill.
subsidiary_id
stringnullableRequiredThe Rutter ID of the Subsidiary linked to the bill. This feature is currently only supported on NetSuite.
vendor_id
stringnullableRequiredThe Rutter ID of the Vendor linked to the bill.
due_date
stringRequiredThe ISO 8601 timestamp of the due date of the bill.
issue_date
stringRequiredThe ISO 8601 timestamp for the issue date of the bill.
currency
enumRequiredThe ISO 4217 currency code of the bill.
status
enumRequiredThe status of the bill.
document_number
stringnullableRequiredThe buyer facing document number of the bill.
memo
stringnullableRequiredMemo or description of the bill
amount_due
stringRequiredThe current amount due on the bill. Represents the remainder after bill payments or bill credit memos are applied against the total amount.
purchase_orders
arrayRequiredAn array of Rutter IDs of Purchase Orders linked to the bill.
purchase_orders
attributestotal_amount
stringRequiredThe total amount due on the bill.
sub_total
stringnullableRequiredThe subtotal of the bill, without the tax amount.
tax_amount
stringnullableRequiredThe total tax amount applied to the bill.
total_discount
stringnullableRequiredThe total amount of discounts applied to the bill.
payments
arrayRequiredAn array of Rutter IDs of Bill Payments and Bill Credit Memos applied against the bill.
payments
attributesline_items
arrayRequiredAn array of line items associated with the bill.
line_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bill was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Bills
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
document_number
stringqueryThe document number to filter on. Supported for QuickBooks Desktop only.
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 limit on the number of entities returned.
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
attributesbills
arrayRequiredbills
attributesnext_cursor
stringnullable- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "currency": "USD",
18 "status": "partially_paid",
19 "document_number": "VENDBILL-1",
20 "memo": "Bill description",
21 "amount_due": "9.34",
22 "purchase_orders": [
23 {
24 "id": "00000000-0000-0000-0000-000000000000"
25 }
26 ],
27 "total_amount": "14.34",
28 "sub_total": "12.34",
29 "tax_amount": "2",
30 "total_discount": "0",
31 "payments": [
32 {
33 "id": "00000000-0000-0000-0000-000000000000",
34 "date": "2023-01-02T02:34:56.000Z",
35 "type": "BILL_PAYMENT",
36 "amount": "3"
37 },
38 {
39 "id": "00000000-0000-0000-0000-000000000000",
40 "date": "2023-01-02T02:34:56.000Z",
41 "type": "BILL_CREDIT_MEMO",
42 "amount": "2"
43 }
44 ],
45 "line_items": [
46 {
47 "id": "00000000-0000-0000-0000-000000000000",
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 "item_id": "00000000-0000-0000-0000-000000000000",
53 "location_id": "00000000-0000-0000-0000-000000000000",
54 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
55 "description": "A Rutter shirt.",
56 "amount": "14.34",
57 "discount_amount": "0",
58 "discount_percentage": "0",
59 "quantity": "1",
60 "sub_total": "12.34",
61 "tax_amount": "2",
62 "unit_amount": "12.34",
63 "item": {
64 "id": "00000000-0000-0000-0000-000000000000",
65 "quantity": 1,
66 "unit_amount": 12.34
67 }
68 }
69 ],
70 "created_at": "2023-01-02T02:34:56.000Z",
71 "updated_at": "2023-01-02T02:34:56.000Z",
72 "last_synced_at": "2023-01-02T02:34:56.000Z",
73 "platform_data": {
74 "id": 123,
75 "data": "Varies by platform"
76 }
77 }
78 ],
79 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
80}
Fetch a Bill
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.
id_type
enumqueryOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on Quickbooks Desktop or Dynamics 365.
Response Body
connection
objectRequiredconnection
attributesbill
objectRequiredbill
attributes- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "currency": "USD",
17 "status": "partially_paid",
18 "document_number": "VENDBILL-1",
19 "memo": "Bill description",
20 "amount_due": "9.34",
21 "purchase_orders": [
22 {
23 "id": "00000000-0000-0000-0000-000000000000"
24 }
25 ],
26 "total_amount": "14.34",
27 "sub_total": "12.34",
28 "tax_amount": "2",
29 "total_discount": "0",
30 "payments": [
31 {
32 "id": "00000000-0000-0000-0000-000000000000",
33 "date": "2023-01-02T02:34:56.000Z",
34 "type": "BILL_PAYMENT",
35 "amount": "3"
36 },
37 {
38 "id": "00000000-0000-0000-0000-000000000000",
39 "date": "2023-01-02T02:34:56.000Z",
40 "type": "BILL_CREDIT_MEMO",
41 "amount": "2"
42 }
43 ],
44 "line_items": [
45 {
46 "id": "00000000-0000-0000-0000-000000000000",
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 "item_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 "amount": "14.34",
56 "discount_amount": "0",
57 "discount_percentage": "0",
58 "quantity": "1",
59 "sub_total": "12.34",
60 "tax_amount": "2",
61 "unit_amount": "12.34",
62 "item": {
63 "id": "00000000-0000-0000-0000-000000000000",
64 "quantity": 1,
65 "unit_amount": 12.34
66 }
67 }
68 ],
69 "created_at": "2023-01-02T02:34:56.000Z",
70 "updated_at": "2023-01-02T02:34:56.000Z",
71 "last_synced_at": "2023-01-02T02:34:56.000Z",
72 "platform_data": {
73 "id": 123,
74 "data": "Varies by platform"
75 }
76 }
77}
Create a Bill
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill
objectRequiredbill
attributesResponse Body
Any of:
bill
objectRequiredbill
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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": "USD",
8 "line_items": [
9 {
10 "account_id": "00000000-0000-0000-0000-000000000000",
11 "amount": 12.34,
12 "description": "A Rutter shirt."
13 }
14 ]
15 }
16}
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 "currency": "USD",
12 "status": "partially_paid",
13 "document_number": "VENDBILL-1",
14 "memo": "Bill description",
15 "amount_due": "9.34",
16 "purchase_orders": [
17 {
18 "id": "00000000-0000-0000-0000-000000000000"
19 }
20 ],
21 "total_amount": "14.34",
22 "sub_total": "12.34",
23 "tax_amount": "2",
24 "total_discount": "0",
25 "payments": [
26 {
27 "id": "00000000-0000-0000-0000-000000000000",
28 "date": "2023-01-02T02:34:56.000Z",
29 "type": "BILL_PAYMENT",
30 "amount": "3"
31 },
32 {
33 "id": "00000000-0000-0000-0000-000000000000",
34 "date": "2023-01-02T02:34:56.000Z",
35 "type": "BILL_CREDIT_MEMO",
36 "amount": "2"
37 }
38 ],
39 "line_items": [
40 {
41 "id": "00000000-0000-0000-0000-000000000000",
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 "item_id": "00000000-0000-0000-0000-000000000000",
47 "location_id": "00000000-0000-0000-0000-000000000000",
48 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
49 "description": "A Rutter shirt.",
50 "amount": "14.34",
51 "discount_amount": "0",
52 "discount_percentage": "0",
53 "quantity": "1",
54 "sub_total": "12.34",
55 "tax_amount": "2",
56 "unit_amount": "12.34",
57 "item": {
58 "id": "00000000-0000-0000-0000-000000000000",
59 "quantity": 1,
60 "unit_amount": 12.34
61 }
62 }
63 ],
64 "created_at": "2023-01-02T02:34:56.000Z",
65 "updated_at": "2023-01-02T02:34:56.000Z",
66 "last_synced_at": "2023-01-02T02:34:56.000Z",
67 "platform_data": {
68 "id": 123,
69 "data": "Varies by platform"
70 }
71 }
72}
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
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill
objectRequiredbill
attributesResponse Body
Any of:
bill
objectRequiredbill
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Dynamics 365
- Exact
- KashFlow
- Netsuite
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 "currency": "USD",
12 "status": "partially_paid",
13 "document_number": "VENDBILL-1",
14 "memo": "Bill description",
15 "amount_due": "9.34",
16 "purchase_orders": [
17 {
18 "id": "00000000-0000-0000-0000-000000000000"
19 }
20 ],
21 "total_amount": "14.34",
22 "sub_total": "12.34",
23 "tax_amount": "2",
24 "total_discount": "0",
25 "payments": [
26 {
27 "id": "00000000-0000-0000-0000-000000000000",
28 "date": "2023-01-02T02:34:56.000Z",
29 "type": "BILL_PAYMENT",
30 "amount": "3"
31 },
32 {
33 "id": "00000000-0000-0000-0000-000000000000",
34 "date": "2023-01-02T02:34:56.000Z",
35 "type": "BILL_CREDIT_MEMO",
36 "amount": "2"
37 }
38 ],
39 "line_items": [
40 {
41 "id": "00000000-0000-0000-0000-000000000000",
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 "item_id": "00000000-0000-0000-0000-000000000000",
47 "location_id": "00000000-0000-0000-0000-000000000000",
48 "tax_rate_id": "00000000-0000-0000-0000-000000000000",
49 "description": "A Rutter shirt.",
50 "amount": "14.34",
51 "discount_amount": "0",
52 "discount_percentage": "0",
53 "quantity": "1",
54 "sub_total": "12.34",
55 "tax_amount": "2",
56 "unit_amount": "12.34",
57 "item": {
58 "id": "00000000-0000-0000-0000-000000000000",
59 "quantity": 1,
60 "unit_amount": 12.34
61 }
62 }
63 ],
64 "created_at": "2023-01-02T02:34:56.000Z",
65 "updated_at": "2023-01-02T02:34:56.000Z",
66 "last_synced_at": "2023-01-02T02:34:56.000Z",
67 "platform_data": {
68 "id": 123,
69 "data": "Varies by platform"
70 }
71 }
72}
Delete a Bill
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Response Body
deleted_bill
objectRequireddeleted_bill
attributes- Netsuite
- Quickbooks
- Xero
1{
2 "deleted_bill": {
3 "code": "deleted",
4 "success": true
5 }
6}
Have questions?
Contact support for personalized guidance.