The Bill Payment 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.
vendor_id
stringnullableThe Rutter ID of the Vendor linked to the bill payment.
account_id
stringnullableThe Rutter ID of the Account linked to the bill payment. Represents the account being credited.
memo
stringnullableThe description of the bill payment.
updated_at
stringnullableThe ISO 8601 timestamp that the bill payment was last updated.
created_at
stringnullableThe ISO 8601 timestamp that the bill payment was created.
currency
enumThe ISO 4217 currency code of the bill payment.
currency_rate
stringnullableThe exchange rate between the business default currency and the currency of the journal entry.
txn_date
stringThe ISO 8601 timestamp for when the transaction was logged.
line_items
arrayAn array of line items containing details of the bill payment.
line_items
attributestotal_amount
stringnullableThe total amount on the bill payment.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": "2",
"currency": "USD",
"currency_rate": "1",
"txn_date": "2023-01-02T02:34:56.000Z",
"memo": "Payment for a shirt.",
"line_items": [
{
"amount": "2",
"bill_id": "00000000-0000-0000-0000-000000000000",
"type": "bill",
"allocated_at": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Bill Payments
GET /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
integeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
connection
Connectionconnection
attributesbill_payments
arraybill_payments
attributesnext_cursor
stringnullableoptional{
"bill_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": "2",
"currency": "USD",
"currency_rate": "1",
"txn_date": "2023-01-02T02:34:56.000Z",
"memo": "Payment for a shirt.",
"line_items": [
{
"amount": "2",
"bill_id": "00000000-0000-0000-0000-000000000000",
"type": "bill",
"allocated_at": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
Fetch a Bill Payment
GET /accounting/bill_payments/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
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
Connectionconnection
attributesbill_payment
Bill Paymentbill_payment
attributes{
"bill_payment": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": "2",
"currency": "USD",
"currency_rate": "1",
"txn_date": "2023-01-02T02:34:56.000Z",
"memo": "Payment for a shirt.",
"line_items": [
{
"amount": "2",
"bill_id": "00000000-0000-0000-0000-000000000000",
"type": "bill",
"allocated_at": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
},
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
Create a Bill Payment
POST /accounting/bill_paymentsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bill_payment
Create Bill Paymentbill_payment
attributesResponse Body
Any of:
Bill Payment Response
bill_payment
Bill Paymentbill_payment
attributesAsync Response Payload
async_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bill_payment": {
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"currency": "USD",
"currency_rate": 1,
"txn_date": "2023-01-02T02:34:56.000Z",
"memo": "Payment for a shirt.",
"line_items": [
{
"amount": 12.34,
"bill_id": "00000000-0000-0000-0000-000000000000",
"allocated_at": "2023-01-02T02:34:56.000Z"
}
]
}
}
{
"bill_payment": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": "2",
"currency": "USD",
"currency_rate": "1",
"txn_date": "2023-01-02T02:34:56.000Z",
"memo": "Payment for a shirt.",
"line_items": [
{
"amount": "2",
"bill_id": "00000000-0000-0000-0000-000000000000",
"type": "bill",
"allocated_at": "2023-01-02T02:34:56.000Z"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}