Bill Payments

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

idstring

The Rutter generated unique ID of the bill payment.

platform_idstring

The platform specific ID of the bill payment.

account_idstringnullable

The Rutter ID of the Account linked to the bill payment. Represents the account being credited. Typically this is an account of type bank.

vendor_idstringfilterablenullable

The Rutter ID of the Vendor linked to the bill payment.

txn_datestring

The ISO 8601 timestamp for when the transaction was logged.

currencyenum

The ISO 4217 currency code of the bill payment.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.

currency_ratestringnullable

The exchange rate between the currency of the bill payment and the business default currency.

memostringnullable

The memo of the bill payment.

referencestringfilterablenullable

The reference identifier of the bill payment. Supported for QuickBooks Desktop.

statusenumnullable

The status of the bill payment.

One ofactive, void, or null.

total_amountstringnullable

The total amount on the bill payment.

line_itemsarray

An array of line items containing details of the bill payment.

Show line_items attributes

additional_fieldsobjectOptional

Additional fields required only for a narrow set of use cases.

Show additional_fields attributes

created_atstringfilterablenullable

The ISO 8601 timestamp that the bill payment was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the bill payment was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the bill payment was last synced by Rutter.

platform_urlstringnullable

A 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_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/bill_payments

GET

/accounting/bill_payments/:id

POST

/accounting/bill_payments

PATCH

/accounting/bill_payments/:id

DELETE

/accounting/bill_payments/:id

List Bill Payments

GEThttps://production.rutterapi.com/versioned/accounting/bill_payments

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

filterstringqueryOptional

Not currently supported on Sage Intacct or Sage Business Cloud. 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.

sortstringqueryOptional

Used 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_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: vendor_id, reference, created_at, updated_at, last_synced_at.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Deprecated - 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_maxintegerqueryOptional

Deprecated - 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_minintegerqueryOptional

Deprecated - 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_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

Example Response Body

JSON

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

GEThttps://production.rutterapi.com/versioned/accounting/bill_payments/:id

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

200

Example Response Body

JSON

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

POSThttps://production.rutterapi.com/versioned/accounting/bill_payments

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

The 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.

One ofasync or prefer_sync.

bill_paymentobject

Show bill_payment attributes

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

Example Request Body

JSON

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}

200

Example Response Body

JSON

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

PATCHhttps://production.rutterapi.com/versioned/accounting/bill_payments/:id

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

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bill_paymentobject

Show bill_payment attributes

response_modeenumOptional

One ofasync or prefer_sync.

Response Body

Support by integration

QuickBooks
Xero
QuickBooks Desktop
NetSuite

Example Request Body

JSON

1{
2  "bill_payment": {
3    "status": "void"
4  }
5}

200

Example Response Body

JSON

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

DELETEhttps://production.rutterapi.com/versioned/accounting/bill_payments/:id

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

Response Body

Support by integration

QuickBooks

200

Example Response Body

JSON

1{
2  "code": "deleted",
3  "success": true
4}

Have questions?

Contact support for personalized guidance.

Contact support