Bill Payments - Rutter API Reference - the Common Language for Business Data

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, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, 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 description of the bill payment.

total_amountnumbernullable

The total amount on the bill payment.

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.

Example BillPayment Object

{
  "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.",
  "total_amount": 2,
  "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 /accounting/bill_payments

Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringoptionalquery

The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

expandenumoptionalquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumoptionalquery

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

One oftrue or false.

limitintegeroptionalquery

The limit on the number of entities returned.

updated_at_maxintegeroptionalquery

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

updated_at_minintegeroptionalquery

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

Response Body

connectionobject

Show connection attributes

bill_paymentsarray

Show bill_payments attributes

next_cursorstringnullableoptional

Example Response Body

{
  "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.",
      "total_amount": 2,
      "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="
}

Fetch a Bill Payment

GET /accounting/bill_payments/:id

Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

idstringpath

The Rutter generated unique ID of the bill payment.

access_tokenstringquery

The access token of the connection.

force_fetchenumoptionalquery

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

One oftrue or false.

Response Body

connectionobject

Show connection attributes

bill_paymentobject

Show bill_payment attributes

Example Response Body

{
  "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.",
    "total_amount": 2,
    "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 /accounting/bill_payments

Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

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

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "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",
    "memo": "Payment for a shirt.",
    "linked_bills": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 12.34
      }
    ]
  }
}

Example Response Body

{
  "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.",
    "total_amount": 2,
    "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"
  }
}