Bill Payments
Properties
id
stringRequiredThe Rutter generated unique ID of the bill payment.
platform_id
stringRequiredThe platform specific ID of the bill payment.
account_id
stringnullableRequiredThe Rutter ID of the Account linked to the bill payment. Represents the account being credited.
vendor_id
stringnullableRequiredThe Rutter ID of the Vendor linked to the bill payment.
transaction_date
stringRequiredThe ISO 8601 timestamp for when the transaction was logged.
currency_code
enumRequiredThe ISO 4217 currency code of the bill payment.
memo
stringnullableRequiredThe description of the bill payment.
status
enumnullableRequiredThe status of the Bill Payment
total_amount
numbernullableRequiredThe total amount on the bill payment.
currency_rate
stringnullableRequiredThe exchange rate between the currency of the bill payment and the business default currency
linked_bills
arrayRequiredAn array of bills linked to the bill payment.
linked_bills
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill payment was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the bill payment was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bill payment was last synced by Rutter.
List Bill Payments
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.
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
attributesbill_payments
arrayRequiredbill_payments
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 "bill_payments": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "account_id": "00000000-0000-0000-0000-000000000000",
12 "vendor_id": "00000000-0000-0000-0000-000000000000",
13 "transaction_date": "2023-01-02T02:34:56.000Z",
14 "currency_code": "USD",
15 "memo": "Payment for a shirt.",
16 "status": "active",
17 "total_amount": 2,
18 "currency_rate": "1",
19 "linked_bills": [
20 {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "allocated_date": "2023-01-02T02:34:56.000Z",
23 "allocated_amount": 2
24 }
25 ],
26 "created_at": "2023-01-02T02:34:56.000Z",
27 "updated_at": "2023-01-02T02:34:56.000Z",
28 "last_synced_at": "2023-01-02T02:34:56.000Z"
29 }
30 ],
31 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
32}
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 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_payment
objectRequiredbill_payment
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_payment": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "account_id": "00000000-0000-0000-0000-000000000000",
11 "vendor_id": "00000000-0000-0000-0000-000000000000",
12 "transaction_date": "2023-01-02T02:34:56.000Z",
13 "currency_code": "USD",
14 "memo": "Payment for a shirt.",
15 "status": "active",
16 "total_amount": 2,
17 "currency_rate": "1",
18 "linked_bills": [
19 {
20 "id": "00000000-0000-0000-0000-000000000000",
21 "allocated_date": "2023-01-02T02:34:56.000Z",
22 "allocated_amount": 2
23 }
24 ],
25 "created_at": "2023-01-02T02:34:56.000Z",
26 "updated_at": "2023-01-02T02:34:56.000Z",
27 "last_synced_at": "2023-01-02T02:34:56.000Z"
28 }
29}
Create a Bill Payment
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bill_payment
objectRequiredbill_payment
attributesResponse Body
Any of:
bill_payment
objectRequiredbill_payment
attributesReturned when the underlying platform creates multiple bill payment entities from a single Rutter request. Only applies to [XERO]
, and only when the request has multiple bills specified in linked_bills
.
bill_payments
arrayRequiredbill_payments
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "status": "active",
11 "total_amount": 2,
12 "currency_rate": "1",
13 "linked_bills": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000",
16 "allocated_date": "2023-01-02T02:34:56.000Z",
17 "allocated_amount": 2
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z"
23 }
24}
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
objectRequiredbill_payment
attributesResponse Body
Any of:
bill_payment
objectRequiredbill_payment
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Netsuite
- Quickbooks
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 "status": "active",
11 "total_amount": 2,
12 "currency_rate": "1",
13 "linked_bills": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000",
16 "allocated_date": "2023-01-02T02:34:56.000Z",
17 "allocated_amount": 2
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z"
23 }
24}
Have questions?
Contact support for personalized guidance.