Bill Payments
Properties
id
stringThe Rutter generated unique ID of the bill payment.
platform_id
stringThe platform specific ID of the bill payment.
account_id
stringnullableThe Rutter ID of the Account linked to the bill payment. Represents the account being credited. Typically this is an account of type bank
.
vendor_id
stringfilterablenullableThe Rutter ID of the Vendor linked to the bill payment.
transaction_date
stringThe ISO 8601 timestamp for when the transaction was logged.
currency_code
enumThe ISO 4217 currency code of the bill payment.
currency_rate
stringnullableThe exchange rate between the currency of the bill payment and the business default currency.
memo
stringnullableThe memo of the bill payment.
reference
stringfilterablenullableThe reference identifier of the bill payment. Supported for QuickBooks Desktop.
status
enumnullableThe status of the bill payment.
total_amount
numbernullableThe total amount of the bill payment.
linked_bills
arrayAn array of bills linked to the bill payment.
linked_bills
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the bill payment was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the bill payment was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the bill payment was last synced by Rutter.
platform_url
stringnullableA URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bill Payments
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot yet supported on Sage Intacct or Dynamics 365 Business Central yet. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable
tag in the response object.
sort
stringqueryOptionalUsed to sort the response objects, e.g. last_synced_at ASC
. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
. Supports only fields decorated with a filterable
tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at
and last_synced_at
fields are supported.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a last_synced_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_max
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_min
integerqueryOptionalDeprecated - use filter
instead. Used to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
bill_payments
arraybill_payments
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "bill_payments": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "account_id": "00000000-0000-0000-0000-000000000000",
7 "vendor_id": "00000000-0000-0000-0000-000000000000",
8 "transaction_date": "2023-01-02T02:34:56.000Z",
9 "currency_code": "USD",
10 "memo": "Payment for a shirt.",
11 "reference": "123456",
12 "status": "active",
13 "total_amount": 2,
14 "currency_rate": "1",
15 "linked_bills": [
16 {
17 "id": "00000000-0000-0000-0000-000000000000",
18 "allocated_date": "2023-01-02T02:34:56.000Z",
19 "allocated_amount": 2
20 }
21 ],
22 "created_at": "2023-01-02T02:34:56.000Z",
23 "updated_at": "2023-01-02T02:34:56.000Z",
24 "last_synced_at": "2023-01-02T02:34:56.000Z",
25 "platform_url": "https://platform.com/resource?id=123",
26 "platform_data": {
27 "id": 123,
28 "data": "Varies by platform"
29 }
30 }
31 ],
32 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
33 "connection": {
34 "id": "00000000-0000-0000-0000-000000000000",
35 "orgId": "00000000-0000-0000-0000-000000000000",
36 "platform": "NETSUITE"
37 }
38}
Platform Differences
There can be some differences in field values due to platform-specific limitations or if the connection is missing required scopes.
Dynamics 365 Business Central
Due to limitations of the base Business Central API, bill payments (known as vendor ledger entries within Business Central) can only be retrieved if your customer installs the Rutter Extension from the Microsoft AppSource marketplace or manually. Please contact support@rutterapi.com to configure this.
Fetch a Bill Payment
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not yet supported on Sage Intacct or Dynamics 365 Business Central yet.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
bill_payment
objectbill_payment
attributesconnection
objectconnection
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "bill_payment": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "vendor_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "memo": "Payment for a shirt.",
10 "reference": "123456",
11 "status": "active",
12 "total_amount": 2,
13 "currency_rate": "1",
14 "linked_bills": [
15 {
16 "id": "00000000-0000-0000-0000-000000000000",
17 "allocated_date": "2023-01-02T02:34:56.000Z",
18 "allocated_amount": 2
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 },
30 "connection": {
31 "id": "00000000-0000-0000-0000-000000000000",
32 "orgId": "00000000-0000-0000-0000-000000000000",
33 "platform": "NETSUITE"
34 }
35}
Create a Bill Payment
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill_payment
objectbill_payment
attributesResponse Body
Any of:
bill_payment
objectbill_payment
attributesasync_response
objectOptionalasync_response
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "bill_payment": {
3 "account_id": "00000000-0000-0000-0000-000000000000",
4 "vendor_id": "00000000-0000-0000-0000-000000000000",
5 "transaction_date": "2023-01-02T02:34:56.000Z",
6 "currency_code": "USD",
7 "currency_rate": 1,
8 "memo": "Payment for a shirt.",
9 "linked_bills": [
10 {
11 "id": "00000000-0000-0000-0000-000000000000",
12 "allocated_amount": 12.34
13 }
14 ]
15 }
16}
1{
2 "bill_payment": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "vendor_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "memo": "Payment for a shirt.",
10 "reference": "123456",
11 "status": "active",
12 "total_amount": 2,
13 "currency_rate": "1",
14 "linked_bills": [
15 {
16 "id": "00000000-0000-0000-0000-000000000000",
17 "allocated_date": "2023-01-02T02:34:56.000Z",
18 "allocated_amount": 2
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 }
30}
Update a Bill Payment
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_payment
objectbill_payment
attributesResponse Body
Any of:
bill_payment
objectbill_payment
attributesasync_response
objectOptionalasync_response
attributes- QuickBooks
- Xero
- NetSuite
1{
2 "bill_payment": {
3 "status": "void"
4 }
5}
1{
2 "bill_payment": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "vendor_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "memo": "Payment for a shirt.",
10 "reference": "123456",
11 "status": "active",
12 "total_amount": 2,
13 "currency_rate": "1",
14 "linked_bills": [
15 {
16 "id": "00000000-0000-0000-0000-000000000000",
17 "allocated_date": "2023-01-02T02:34:56.000Z",
18 "allocated_amount": 2
19 }
20 ],
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_url": "https://platform.com/resource?id=123",
25 "platform_data": {
26 "id": 123,
27 "data": "Varies by platform"
28 }
29 }
30}
Delete a Bill Payment
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Response Body
Any of:
code
enumReturns the status of the requested object: deleted
indicates object was deleted by this operation, whereas not_found
indicates object was not found (allowing us to make DELETE operations idempotent).
success
booleanIndicates whether deletion was successful.
async_response
objectOptionalasync_response
attributes- QuickBooks
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.