Invoice Payments

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_idstringfilterable

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_idstringfilterablenullable

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

payment_method_idstringnullable

The Rutter ID of the Payment Method linked to the invoice payment method. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.

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, 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, ZMW, ETH, BTC, or null.
currency_ratenumbernullable

The exchange rate between the currency of the invoice payment and the business default currency. Supported for NetSuite, QuickBooks, QuickBooks Desktop, Sage Intacct, and Xero.

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.

referencestringfilterablenullable

The reference identifier of the invoice payment. Supported for NetSuite, QuickBooks, and QuickBooks Desktop. Warning: for NetSuite, this field can only be set if 'Allow override' is checked to allow custom numbering. Additionally, after passing in a numerical reference, the autonumbering will commence with the next number of the overridden number (override + 1) instead of reverting to the built-in sequencer. To avoid this, pass in an alphanumeric value.

total_amountstringnullable

The total amount on the invoice payment.

linked_invoicesarray

An array of Invoices linked to the invoice payment.

Show linked_invoices attributes
additional_fieldsobjectOptional

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

Show additional_fields attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the invoice payment was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

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

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/invoice_payments
GET
/accounting/invoice_payments/:id
POST
/accounting/invoice_payments
PATCH
/accounting/invoice_payments/:id
DELETE
/accounting/invoice_payments/:id

List Invoice Payments

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: customer_id, reference, account_id, updated_at, created_at, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: customer_id, reference, account_id, updated_at, created_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "invoice_payments": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "account_id": "00000000-0000-0000-0000-000000000000",


7
      "customer_id": "00000000-0000-0000-0000-000000000000",


8
      "payment_method_id": "00000000-0000-0000-0000-000000000000",


9
      "txn_date": "2023-01-02T02:34:56.000Z",


10
      "currency_code": "USD",


11
      "currency_rate": 3.5,


12
      "deposited": true,


13
      "memo": "Payment for a shirt.",


14
      "reference": "123456",


15
      "total_amount": "2",


16
      "linked_invoices": [


17
        {


18
          "id": "00000000-0000-0000-0000-000000000000",


19
          "allocated_at": "2023-01-02T02:34:56.000Z",


20
          "amount": "2"


21
        }


22
      ],


23
      "created_at": "2023-01-02T02:34:56.000Z",


24
      "updated_at": "2023-01-02T02:34:56.000Z",


25
      "last_synced_at": "2023-01-02T02:34:56.000Z",


26
      "platform_url": "https://platform.com/resource?id=123",


27
      "platform_data": {


28
        "id": 123,


29
        "data": "Varies by platform"


30
      }


31
    }


32
  ],


33
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


34
  "connection": {


35
    "id": "00000000-0000-0000-0000-000000000000",


36
    "orgId": "00000000-0000-0000-0000-000000000000",


37
    "platform": "NETSUITE"


38
  }


39
}

Fetch an Invoice Payment

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

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "invoice_payment": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "payment_method_id": "00000000-0000-0000-0000-000000000000",


8
    "txn_date": "2023-01-02T02:34:56.000Z",


9
    "currency_code": "USD",


10
    "currency_rate": 3.5,


11
    "deposited": true,


12
    "memo": "Payment for a shirt.",


13
    "reference": "123456",


14
    "total_amount": "2",


15
    "linked_invoices": [


16
      {


17
        "id": "00000000-0000-0000-0000-000000000000",


18
        "allocated_at": "2023-01-02T02:34:56.000Z",


19
        "amount": "2"


20
      }


21
    ],


22
    "created_at": "2023-01-02T02:34:56.000Z",


23
    "updated_at": "2023-01-02T02:34:56.000Z",


24
    "last_synced_at": "2023-01-02T02:34:56.000Z",


25
    "platform_url": "https://platform.com/resource?id=123",


26
    "platform_data": {


27
      "id": 123,


28
      "data": "Varies by platform"


29
    }


30
  },


31
  "connection": {


32
    "id": "00000000-0000-0000-0000-000000000000",


33
    "orgId": "00000000-0000-0000-0000-000000000000",


34
    "platform": "NETSUITE"


35
  }


36
}

Create an Invoice Payment

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    invoice_paymentobject
    Show invoice_payment attributes

Response Body

Example Request Body
JSON
1
{


2
  "invoice_payment": {


3
    "account_id": "00000000-0000-0000-0000-000000000000",


4
    "customer_id": "00000000-0000-0000-0000-000000000000",


5
    "payment_method_id": "00000000-0000-0000-0000-000000000000",


6
    "txn_date": "2023-01-02T02:34:56.000Z",


7
    "currency_code": "USD",


8
    "memo": "Payment for a shirt.",


9
    "total_amount": 12.34,


10
    "linked_invoices": [


11
      {


12
        "id": "00000000-0000-0000-0000-000000000000",


13
        "allocated_at": "2023-01-02T02:34:56.000Z",


14
        "amount": 12.34


15
      }


16
    ]


17
  }


18
}
200
Example Response Body
JSON
1
{


2
  "invoice_payment": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "payment_method_id": "00000000-0000-0000-0000-000000000000",


8
    "txn_date": "2023-01-02T02:34:56.000Z",


9
    "currency_code": "USD",


10
    "currency_rate": 3.5,


11
    "deposited": true,


12
    "memo": "Payment for a shirt.",


13
    "reference": "123456",


14
    "total_amount": "2",


15
    "linked_invoices": [


16
      {


17
        "id": "00000000-0000-0000-0000-000000000000",


18
        "allocated_at": "2023-01-02T02:34:56.000Z",


19
        "amount": "2"


20
      }


21
    ],


22
    "created_at": "2023-01-02T02:34:56.000Z",


23
    "updated_at": "2023-01-02T02:34:56.000Z",


24
    "last_synced_at": "2023-01-02T02:34:56.000Z",


25
    "platform_url": "https://platform.com/resource?id=123",


26
    "platform_data": {


27
      "id": 123,


28
      "data": "Varies by platform"


29
    }


30
  }


31
}

Update an Invoice Payment

PATCHhttps://production.rutterapi.com/versioned/accounting/invoice_payments/:id

If a field is provided, that field will take the updated value. If a field is not provided, the existing value will persist. The exception is for array fields such as `line_items`. For these fields, the entire array will be replaced with the new array value.

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    invoice_paymentobject
    Show invoice_payment attributes

Response Body

Example Request Body
JSON
1
{


2
  "invoice_payment": {


3
    "account_id": "00000000-0000-0000-0000-000000000000",


4
    "customer_id": "00000000-0000-0000-0000-000000000000",


5
    "txn_date": "2023-01-02T02:34:56.000Z",


6
    "memo": "Payment for a shirt.",


7
    "total_amount": 12.34,


8
    "linked_invoices": [


9
      {


10
        "id": "00000000-0000-0000-0000-000000000000",


11
        "allocated_at": "2023-01-02T02:34:56.000Z",


12
        "amount": 12.34


13
      }


14
    ]


15
  }


16
}
200
Example Response Body
JSON
1
{


2
  "invoice_payment": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "payment_method_id": "00000000-0000-0000-0000-000000000000",


8
    "txn_date": "2023-01-02T02:34:56.000Z",


9
    "currency_code": "USD",


10
    "currency_rate": 3.5,


11
    "deposited": true,


12
    "memo": "Payment for a shirt.",


13
    "reference": "123456",


14
    "total_amount": "2",


15
    "linked_invoices": [


16
      {


17
        "id": "00000000-0000-0000-0000-000000000000",


18
        "allocated_at": "2023-01-02T02:34:56.000Z",


19
        "amount": "2"


20
      }


21
    ],


22
    "created_at": "2023-01-02T02:34:56.000Z",


23
    "updated_at": "2023-01-02T02:34:56.000Z",


24
    "last_synced_at": "2023-01-02T02:34:56.000Z",


25
    "platform_url": "https://platform.com/resource?id=123",


26
    "platform_data": {


27
      "id": 123,


28
      "data": "Varies by platform"


29
    }


30
  }


31
}

Delete an Invoice Payment

DELETEhttps://production.rutterapi.com/versioned/accounting/invoice_payments/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.

Response Body

200
Example Response Body
JSON
1
{


2
  "code": "deleted",


3
  "success": true


4
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Invoices