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.

vendor_idstringnullable

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

transaction_datestring

The ISO 8601 timestamp for when the transaction was logged.

currency_codeenum

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.

memostringnullable

The memo of the bill payment.

statusenumnullable

The status of the bill payment.

One ofactive or void.

total_amountnumbernullable

The total amount of the bill payment.

currency_ratestringnullable

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

linked_billsarray

An array of bills linked to the bill payment.

Show linked_bills attributes

created_atstringnullable

The ISO 8601 timestamp that the bill payment was created.

updated_atstringnullable

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

last_synced_atstring

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

Endpoints

GET

/accounting/bill_payments

GET

/accounting/bill_payments/:id

POST

/accounting/bill_payments

PATCH

/accounting/bill_payments/:id

List Bill Payments

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

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringqueryOptional

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

expandenumqueryOptional

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumqueryOptional

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

last_synced_at_minintegerqueryOptional

Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

limitintegerqueryOptional

The number of entities to return. Defaults to 50. Maximum is 500.

sortstringqueryOptional

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

Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

updated_at_minintegerqueryOptional

Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

connectionobject

Show connection attributes

bill_paymentsarray

Show bill_payments attributes

next_cursorstringnullableOptional

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Response Body

JSON

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

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

Request Parameters

idstringpath

The Rutter generated unique ID of the object.

access_tokenstringquery

The access token of the connection.

force_fetchenumqueryOptional

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

id_typeenumqueryOptional

Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

One ofrutter or platform.

Response Body

connectionobject

Show connection attributes

bill_paymentobject

Show bill_payment attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Response Body

JSON

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

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

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

bill_paymentobject

Show bill_payment attributes

Response Body

Any of:

bill_paymentobject

Show bill_payment attributes

Returned 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_paymentsarray

Show bill_payments attributes

async_responseobjectOptional

Show async_response attributes

errorsarrayOptional

Show errors attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

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    "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}

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    "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

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

idstringpath

The Rutter generated unique ID of the object.

access_tokenstringquery

The access token of the connection.

Request Body

bill_paymentobject

Show bill_payment attributes

Response Body

Any of:

bill_paymentobject

Show bill_payment attributes

async_responseobjectOptional

Show async_response attributes

errorsarrayOptional

Show errors attributes

Support by integration

QuickBooks
Netsuite

Example Request Body

JSON

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

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

Contact support