Invoice Payments
Properties
id
stringThe Rutter generated unique ID of the invoice payment.
platform_id
stringThe platform specific ID of the invoice payment.
account_id
stringThe Rutter ID of the Account linked to the invoice payment.
ar_account_id
stringOptionalThe Rutter ID of the AR Account linked to the invoice payment.
customer_id
stringnullableThe Rutter ID of the Customer linked to the invoice payment.
payment_method_id
stringnullableThe Rutter ID of the Payment Method linked to the invoice payment method. Supported for NetSuite.
txn_date
stringThe ISO 8601 timestamp for when the transaction was logged.
currency_code
enumnullableThe ISO 4217 currency code of the invoice payment.
deposited
booleannullableIf 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.
memo
stringnullableThe memo of the invoice payment.
additional_fields
objectOptionalAdditional fields required only for a narrow set of use cases.
additional_fields
attributestotal_amount
stringnullableThe total amount on the invoice payment.
linked_invoices
arrayAn array of Invoices linked to the invoice payment.
linked_invoices
attributescreated_at
stringnullableThe ISO 8601 timestamp that the invoice payment was created.
updated_at
stringnullableThe ISO 8601 timestamp that the invoice payment was last updated.
last_synced_at
stringThe ISO 8601 timestamp when the invoice payment was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Invoice Payments
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
last_synced_at_min
integerqueryOptionalUsed to filter objects with a last_synced_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Currently supports the fields: updated_at
or last_synced_at
. If a field is provided but ASC
or DESC
is not, defaults to ASC
. If this field is omitted, defaults to updated_at DESC
.
updated_at_max
integerqueryOptionalUsed 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_min
integerqueryOptionalUsed to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
Response Body
connection
objectconnection
attributesinvoice_payments
arrayinvoice_payments
attributesnext_cursor
stringnullableOptional- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "invoice_payments": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "account_id": "00000000-0000-0000-0000-000000000000",
12 "customer_id": "00000000-0000-0000-0000-000000000000",
13 "payment_method_id": "00000000-0000-0000-0000-000000000000",
14 "txn_date": "2023-01-02T02:34:56.000Z",
15 "currency_code": "USD",
16 "deposited": true,
17 "memo": "Payment for a shirt.",
18 "total_amount": "2",
19 "linked_invoices": [
20 {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "allocated_at": "2023-01-02T02:34:56.000Z",
23 "amount": "2"
24 }
25 ],
26 "created_at": "2023-01-02T02:34:56.000Z",
27 "updated_at": "2023-01-02T02:34:56.000Z",
28 "last_synced_at": "2023-01-02T02:34:56.000Z",
29 "platform_data": {
30 "id": 123,
31 "data": "Varies by platform"
32 }
33 }
34 ],
35 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
36}
Fetch an Invoice Payment
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
Response Body
connection
objectconnection
attributesinvoice_payment
objectinvoice_payment
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "invoice_payment": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "account_id": "00000000-0000-0000-0000-000000000000",
11 "customer_id": "00000000-0000-0000-0000-000000000000",
12 "payment_method_id": "00000000-0000-0000-0000-000000000000",
13 "txn_date": "2023-01-02T02:34:56.000Z",
14 "currency_code": "USD",
15 "deposited": true,
16 "memo": "Payment for a shirt.",
17 "total_amount": "2",
18 "linked_invoices": [
19 {
20 "id": "00000000-0000-0000-0000-000000000000",
21 "allocated_at": "2023-01-02T02:34:56.000Z",
22 "amount": "2"
23 }
24 ],
25 "created_at": "2023-01-02T02:34:56.000Z",
26 "updated_at": "2023-01-02T02:34:56.000Z",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_data": {
29 "id": 123,
30 "data": "Varies by platform"
31 }
32 }
33}
Create an Invoice Payment
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_payment
objectinvoice_payment
attributesResponse Body
Any of:
invoice_payment
objectinvoice_payment
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
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}
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 "total_amount": "2",
13 "linked_invoices": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000",
16 "allocated_at": "2023-01-02T02:34:56.000Z",
17 "amount": "2"
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z",
23 "platform_data": {
24 "id": 123,
25 "data": "Varies by platform"
26 }
27 }
28}
Update an InvoicePayment
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
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_payment
objectinvoice_payment
attributesResponse Body
Any of:
invoice_payment
objectinvoice_payment
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
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}
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 "total_amount": "2",
13 "linked_invoices": [
14 {
15 "id": "00000000-0000-0000-0000-000000000000",
16 "allocated_at": "2023-01-02T02:34:56.000Z",
17 "amount": "2"
18 }
19 ],
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z",
23 "platform_data": {
24 "id": 123,
25 "data": "Varies by platform"
26 }
27 }
28}
Delete an InvoicePayment
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Response Body
Any of:
deleted_invoice_payment
objectdeleted_invoice_payment
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks Desktop
1{
2 "deleted_invoice_payment": {
3 "code": "deleted",
4 "success": true
5 }
6}
Have questions?
Contact support for personalized guidance.