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_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.

payment_method_idstringnullable

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

txn_datestring

The ISO 8601 timestamp for when the transaction was logged.

currency_codeenumnullable

The ISO 4217 currency code of the invoice payment.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, 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.

referencestringnullable

The reference identifier of the invoice payment. Supported for QuickBooks and QuickBooks Desktop.

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

    Used to specify criteria to filter out the objects returned. Supports all filterable fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    sortstringqueryOptional

    Used to sort the returned objects, e.g. last_synced_at ASC. Supports all filterable fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at and last_synced_at fields are supported. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC.

    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

    invoice_paymentsarray
    Show invoice_payments attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
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
"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
],
32
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
33
"connection": {
34
"id": "00000000-0000-0000-0000-000000000000",
35
"orgId": "00000000-0000-0000-0000-000000000000",
36
"platform": "NETSUITE"
37
}
38
}

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 supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    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

    invoice_paymentobject
    Show invoice_payment attributes
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
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
"deposited": true,
11
"memo": "Payment for a shirt.",
12
"reference": "123456",
13
"total_amount": "2",
14
"linked_invoices": [
15
{
16
"id": "00000000-0000-0000-0000-000000000000",
17
"allocated_at": "2023-01-02T02:34:56.000Z",
18
"amount": "2"
19
}
20
],
21
"created_at": "2023-01-02T02:34:56.000Z",
22
"updated_at": "2023-01-02T02:34:56.000Z",
23
"last_synced_at": "2023-01-02T02:34:56.000Z",
24
"platform_url": "https://platform.com/resource?id=123",
25
"platform_data": {
26
"id": 123,
27
"data": "Varies by platform"
28
}
29
},
30
"connection": {
31
"id": "00000000-0000-0000-0000-000000000000",
32
"orgId": "00000000-0000-0000-0000-000000000000",
33
"platform": "NETSUITE"
34
}
35
}

Create an Invoice Payment

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

Request Parameters

    access_tokenstringqueryRequired

    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
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
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
"total_amount": 12.34,
9
"memo": "Payment for a shirt.",
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
}
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
"deposited": true,
11
"memo": "Payment for a shirt.",
12
"reference": "123456",
13
"total_amount": "2",
14
"linked_invoices": [
15
{
16
"id": "00000000-0000-0000-0000-000000000000",
17
"allocated_at": "2023-01-02T02:34:56.000Z",
18
"amount": "2"
19
}
20
],
21
"created_at": "2023-01-02T02:34:56.000Z",
22
"updated_at": "2023-01-02T02:34:56.000Z",
23
"last_synced_at": "2023-01-02T02:34:56.000Z",
24
"platform_url": "https://platform.com/resource?id=123",
25
"platform_data": {
26
"id": 123,
27
"data": "Varies by platform"
28
}
29
}
30
}

Update an InvoicePayment

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

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

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    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
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
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
}
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
"deposited": true,
11
"memo": "Payment for a shirt.",
12
"reference": "123456",
13
"total_amount": "2",
14
"linked_invoices": [
15
{
16
"id": "00000000-0000-0000-0000-000000000000",
17
"allocated_at": "2023-01-02T02:34:56.000Z",
18
"amount": "2"
19
}
20
],
21
"created_at": "2023-01-02T02:34:56.000Z",
22
"updated_at": "2023-01-02T02:34:56.000Z",
23
"last_synced_at": "2023-01-02T02:34:56.000Z",
24
"platform_url": "https://platform.com/resource?id=123",
25
"platform_data": {
26
"id": 123,
27
"data": "Varies by platform"
28
}
29
}
30
}

Delete an InvoicePayment

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.

Response Body

    Any of:

    deleted_invoice_paymentobject
    Show deleted_invoice_payment attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    Show errors attributes
Support by integration
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"deleted_invoice_payment": {
3
"code": "deleted",
4
"success": true
5
}
6
}

Have questions?

Contact support for personalized guidance.

Contact support