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.
txn_date
stringThe ISO 8601 timestamp for when the transaction was logged.
currency
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
stringnullableThe total amount on the bill payment.
line_items
arrayAn array of line items containing details of the bill payment.
line_items
attributesadditional_fields
objectOptionalAdditional fields required only for a narrow set of use cases.
additional_fields
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. 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.
Filterable fields: vendor_id
, reference
, created_at
, updated_at
, last_synced_at
.
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.
Sortable fields: vendor_id
, reference
, created_at
, updated_at
, last_synced_at
.
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
- 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 "txn_date": "2023-01-02T02:34:56.000Z",
9 "currency": "USD",
10 "currency_rate": "1",
11 "memo": "Payment for a shirt.",
12 "reference": "123456",
13 "status": "active",
14 "total_amount": "2",
15 "line_items": [
16 {
17 "bill_id": "00000000-0000-0000-0000-000000000000",
18 "allocated_at": "2023-01-02T02:34:56.000Z",
19 "amount": "2",
20 "type": "bill"
21 }
22 ],
23 "created_at": "2023-01-02T02:34:56.000Z",
24 "updated_at": "2023-01-02T02:34:56.000Z",
25 "last_synced_at": "2023-01-02T02:34:56.000Z",
26 "platform_url": "https://platform.com/resource?id=123",
27 "platform_data": {
28 "id": 123,
29 "data": "Varies by platform"
30 }
31 }
32 ],
33 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
34 "connection": {
35 "id": "00000000-0000-0000-0000-000000000000",
36 "orgId": "00000000-0000-0000-0000-000000000000",
37 "platform": "NETSUITE"
38 }
39}
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.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- 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 "txn_date": "2023-01-02T02:34:56.000Z",
8 "currency": "USD",
9 "currency_rate": "1",
10 "memo": "Payment for a shirt.",
11 "reference": "123456",
12 "status": "active",
13 "total_amount": "2",
14 "line_items": [
15 {
16 "bill_id": "00000000-0000-0000-0000-000000000000",
17 "allocated_at": "2023-01-02T02:34:56.000Z",
18 "amount": "2",
19 "type": "bill"
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 "connection": {
32 "id": "00000000-0000-0000-0000-000000000000",
33 "orgId": "00000000-0000-0000-0000-000000000000",
34 "platform": "NETSUITE"
35 }
36}
Create a Bill Payment
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
bill_payment
objectbill_payment
attributesResponse Body
- 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 "txn_date": "2023-01-02T02:34:56.000Z",
6 "currency": "USD",
7 "currency_rate": 1,
8 "memo": "Payment for a shirt.",
9 "line_items": [
10 {
11 "bill_id": "00000000-0000-0000-0000-000000000000",
12 "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 "txn_date": "2023-01-02T02:34:56.000Z",
8 "currency": "USD",
9 "currency_rate": "1",
10 "memo": "Payment for a shirt.",
11 "reference": "123456",
12 "status": "active",
13 "total_amount": "2",
14 "line_items": [
15 {
16 "bill_id": "00000000-0000-0000-0000-000000000000",
17 "allocated_at": "2023-01-02T02:34:56.000Z",
18 "amount": "2",
19 "type": "bill"
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}
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_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- 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 "txn_date": "2023-01-02T02:34:56.000Z",
8 "currency": "USD",
9 "currency_rate": "1",
10 "memo": "Payment for a shirt.",
11 "reference": "123456",
12 "status": "active",
13 "total_amount": "2",
14 "line_items": [
15 {
16 "bill_id": "00000000-0000-0000-0000-000000000000",
17 "allocated_at": "2023-01-02T02:34:56.000Z",
18 "amount": "2",
19 "type": "bill"
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}
Delete a Bill Payment
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
Response Body
- QuickBooks
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.