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 ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
memostringnullable

The description of the bill payment.

statusenumnullable

The status of the Bill Payment

One ofactive or void.
total_amountnumbernullable

The total amount on 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.

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.",
  "status": "active",
  "total_amount": 2,
  "currency_rate": "1",
  "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 /versioned/accounting/bill_payments
Supported for: Dynamics 365ExactFreeAgentKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

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

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

    updated_at_minintegeroptionalquery

    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
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.",
      "status": "active",
      "total_amount": 2,
      "currency_rate": "1",
      "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="
}

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

GET /versioned/accounting/bill_payments/:id
Supported for: Dynamics 365ExactFreeAgentKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

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.",
    "status": "active",
    "total_amount": 2,
    "currency_rate": "1",
    "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 /versioned/accounting/bill_payments
Supported for: Dynamics 365ExactFreeAgentKashFlowMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctXeroZoho Books

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
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",
    "currency_rate": 1,
    "memo": "Payment for a shirt.",
    "linked_bills": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "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.",
    "status": "active",
    "total_amount": 2,
    "currency_rate": "1",
    "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"
  }
}

Update a Bill Payment

PATCH /versioned/accounting/bill_payments/:id
Supported for: NetSuiteQuickBooks

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
Example Request Body
{
  "bill_payment": {
    "status": "void"
  }
}
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.",
    "status": "active",
    "total_amount": 2,
    "currency_rate": "1",
    "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"
  }
}