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
stringfilterablenullableThe 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 and QuickBooks Desktop.
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.
reference
stringfilterablenullableThe reference identifier of the invoice payment. Supported for QuickBooks and QuickBooks Desktop.
total_amount
stringnullableThe total amount on the invoice payment.
linked_invoices
arrayAn array of Invoices linked to the invoice payment.
linked_invoices
attributesadditional_fields
objectOptionalAdditional fields required only for a narrow set of use cases.
additional_fields
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the invoice payment was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the invoice payment was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the invoice payment was last synced by Rutter.
platform_url
stringnullableA 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_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.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot 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
, updated_at
, created_at
, last_synced_at
.
sort
stringqueryOptionalUsed 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 Dynamics 365 Business Central. 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
, updated_at
, created_at
, last_synced_at
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not currently supported on Sage Intacct or Sage Business Cloud.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
invoice_payment
objectinvoice_payment
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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 "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 Invoice Payment
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
response_mode
enumOptionalThe 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.
invoice_payment
objectinvoice_payment
attributesResponse Body
- QuickBooks
- QuickBooks Desktop
- NetSuite
- Zoho Books
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 "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 Invoice Payment
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe 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.
Response Body
- QuickBooks
- Xero
- QuickBooks Desktop
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.