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

The InvoicePayment object

A Rutter Invoice Payment represents an invoice payment issued by a customer made against an invoice. Every invoice payment is linked to a Customer and one or more Invoices.

Properties

idstring

The Rutter generated unique ID of the invoice payment.

platform_idstring

The platform specific ID of the invoice payment.

account_idstring

The Rutter ID of the Account linked to the invoice payment.

ar_account_idstringoptional

The Rutter ID of the AR Account linked to the invoice payment.

customer_idstringnullable

The Rutter ID of the Customer linked to the invoice payment.

txn_datestring

The ISO 8601 timestamp for when the transaction was logged.

currency_codeenumnullable

The ISO 4217 currency code of the invoice 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, 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.

depositedbooleannullable

If the invoice payment debits the 'Undeposited Funds' account, this field will show whether the invoice payment has been deposited (usually in another Bank Deposit transaction). Null if the invoice payment doesn't debit the 'Undeposited Funds' account or if the platform does not support this field.

memostringnullable

The memo of the invoice payment.

additional_fieldsobjectoptional

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

Show additional_fields attributes

total_amountstringnullable

The total amount on the invoice payment.

linked_invoicesarray

An array of Invoices linked to the invoice payment.

Show linked_invoices attributes

updated_atstringnullable

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

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example InvoicePayment Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "txn_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "deposited": true,
  "memo": "Payment for a shirt.",
  "total_amount": "2",
  "linked_invoices": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "allocated_at": "2023-01-02T02:34:56.000Z",
      "amount": "2"
    }
  ],
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Invoice Payments

GET /versioned/accounting/invoice_payments

Supported for: NetSuiteQuickBooksQuickBooks DesktopSage 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

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

invoice_paymentsarray

Show invoice_payments attributes

next_cursorstringnullableoptional

Example Response Body

{
  "invoice_payments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "txn_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "deposited": true,
      "memo": "Payment for a shirt.",
      "total_amount": "2",
      "linked_invoices": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "allocated_at": "2023-01-02T02:34:56.000Z",
          "amount": "2"
        }
      ],
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch an Invoice Payment

GET /versioned/accounting/invoice_payments/:id

Supported for: NetSuiteQuickBooksQuickBooks DesktopSage 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

connectionobject

Show connection attributes

invoice_paymentobject

Show invoice_payment attributes

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "invoice_payment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "txn_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "deposited": true,
    "memo": "Payment for a shirt.",
    "total_amount": "2",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_at": "2023-01-02T02:34:56.000Z",
        "amount": "2"
      }
    ],
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create an Invoice Payment

POST /versioned/accounting/invoice_payments

Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

invoice_paymentobject

Show invoice_payment attributes

Response Body

Any of:

invoice_paymentobject

Show invoice_payment attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "invoice_payment": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "txn_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 12.34,
    "memo": "Payment for a shirt.",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_at": "2023-01-02T02:34:56.000Z",
        "amount": 12.34
      }
    ]
  }
}

Example Response Body

{
  "invoice_payment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "txn_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "deposited": true,
    "memo": "Payment for a shirt.",
    "total_amount": "2",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_at": "2023-01-02T02:34:56.000Z",
        "amount": "2"
      }
    ],
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Update an InvoicePayment

PATCH /versioned/accounting/invoice_payments/:id

Supported for: NetSuiteQuickBooksXero

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

invoice_paymentobject

Show invoice_payment attributes

Response Body

Any of:

invoice_paymentobject

Show invoice_payment attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "invoice_payment": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "txn_date": "2023-01-02T02:34:56.000Z",
    "memo": "Payment for a shirt.",
    "total_amount": 12.34,
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_at": "2023-01-02T02:34:56.000Z",
        "amount": 12.34
      }
    ]
  }
}

Example Response Body

{
  "invoice_payment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "txn_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "deposited": true,
    "memo": "Payment for a shirt.",
    "total_amount": "2",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_at": "2023-01-02T02:34:56.000Z",
        "amount": "2"
      }
    ],
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}