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

idstring

The Rutter generated unique ID of the bill payment.

platform_idstring

The platform specific ID of the bill payment.

vendor_idstringnullable

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

account_idstringnullable

The Rutter ID of the Account linked to the bill payment. Represents the account being credited.

memostringnullable

The description of the bill payment.

updated_atstringnullable

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

created_atstringnullable

The ISO 8601 timestamp that the bill payment was created.

currencyenum

The ISO 4217 currency code of the bill payment.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
currency_ratestringnullable

The exchange rate between the business default currency and the currency of the journal entry.

txn_datestring

The ISO 8601 timestamp for when the transaction was logged.

line_itemsarray

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

Show line_items attributes
total_amountstringnullable

The total amount on the bill payment.

Example BillPayment Object
{
  "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_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

    connectionConnection
    Show connection attributes
    bill_paymentsarray
    Show bill_payments attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "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/:id
Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    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

    connectionConnection
    Show connection attributes
    bill_paymentBill Payment
    Show bill_payment attributes
Example Response Body
{
  "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_payments
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    bill_paymentCreate Bill Payment
    Show bill_payment attributes

Response Body

    Any of:

    Bill Payment Response

    bill_paymentBill Payment
    Show bill_payment attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "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"
      }
    ]
  }
}
Example Response Body
{
  "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"
  }
}
Previous
Bills