The BillPayment object
A Rutter Bill Payment represents a bill payment issued by the business entity made against a bill. Every bill payment is linked to a Vendor and one or more Bills.
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.
vendor_id
stringnullableThe 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.
memo
stringnullableThe description of the bill payment.
status
enumnullableThe status of the Bill Payment
total_amount
numbernullableThe total amount on the bill payment.
currency_rate
stringnullableThe exchange rate between the currency of the bill payment and the business default currency
linked_bills
arrayAn array of bills linked to the bill payment.
linked_bills
attributescreated_at
stringnullableThe ISO 8601 timestamp that the bill payment was created.
updated_at
stringnullableThe ISO 8601 timestamp that the bill payment was last updated.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Payment for a shirt.",
"status": "active",
"total_amount": 2,
"currency_rate": "1",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 2
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Bill Payments
GET /versioned/accounting/bill_paymentsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesbill_payments
arraybill_payments
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bill_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Payment for a shirt.",
"status": "active",
"total_amount": 2,
"currency_rate": "1",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 2
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
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
GET /versioned/accounting/bill_payments/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the bill payment.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributesbill_payment
objectbill_payment
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bill_payment": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Payment for a shirt.",
"status": "active",
"total_amount": 2,
"currency_rate": "1",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 2
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}
Create a Bill Payment
POST /versioned/accounting/bill_paymentsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill_payment
objectbill_payment
attributesResponse Body
Any of:
bill_payment
objectbill_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
arraybill_payments
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_payment": {
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"currency_rate": 1,
"memo": "Payment for a shirt.",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_amount": 12.34
}
]
}
}
{
"bill_payment": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Payment for a shirt.",
"status": "active",
"total_amount": 2,
"currency_rate": "1",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 2
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}
Update a Bill Payment
PATCH /versioned/accounting/bill_payments/:idIf 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_payment
objectbill_payment
attributesResponse Body
Any of:
bill_payment
objectbill_payment
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_payment": {
"status": "void"
}
}
{
"bill_payment": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "Payment for a shirt.",
"status": "active",
"total_amount": 2,
"currency_rate": "1",
"linked_bills": [
{
"id": "00000000-0000-0000-0000-000000000000",
"allocated_date": "2023-01-02T02:34:56.000Z",
"allocated_amount": 2
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}