Invoice Payments
Properties
id
stringRequiredThe Rutter generated unique ID of the invoice payment.
platform_id
stringRequiredThe platform specific ID of the invoice payment.
account_id
stringRequiredThe Rutter ID of the Account linked to the invoice payment.
ar_account_id
stringThe Rutter ID of the AR Account linked to the invoice payment.
customer_id
stringnullableRequiredThe Rutter ID of the Customer linked to the invoice payment.
payment_method_id
stringnullableRequiredThe Rutter ID of the Payment Method linked to the invoice payment method. This feature is currently only supported on NetSuite.
txn_date
stringRequiredThe ISO 8601 timestamp for when the transaction was logged.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the invoice payment.
deposited
booleannullableRequiredIf 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
stringnullableRequiredThe memo of the invoice payment.
additional_fields
objectAdditional fields required only for a narrow set of use cases.
additional_fields
attributestotal_amount
stringnullableRequiredThe total amount on the invoice payment.
linked_invoices
arrayRequiredAn array of Invoices linked to the invoice payment.
linked_invoices
attributesupdated_at
stringnullableRequiredThe ISO 8601 timestamp that the invoice payment was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the invoice payment was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Invoice Payments
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe field and direction to sort by (ASC
or DESC
), e.g. last_synced_at ASC
. Currently supports the fields: updated_at
, 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
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
invoice_payments
arrayRequiredinvoice_payments
attributesnext_cursor
stringnullable- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "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 "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 ],
29 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
30}
Fetch an Invoice Payment
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributesinvoice_payment
objectRequiredinvoice_payment
attributes- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "updated_at": "2023-01-02T02:34:56.000Z",
26 "last_synced_at": "2023-01-02T02:34:56.000Z",
27 "platform_data": {
28 "id": 123,
29 "data": "Varies by platform"
30 }
31 }
32}
Create an Invoice Payment
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
invoice_payment
objectRequiredinvoice_payment
attributesResponse Body
Any of:
invoice_payment
objectRequiredinvoice_payment
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Dynamics 365
- Exact
- Free Agent
- Freshbooks
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 "updated_at": "2023-01-02T02:34:56.000Z",
21 "last_synced_at": "2023-01-02T02:34:56.000Z",
22 "platform_data": {
23 "id": 123,
24 "data": "Varies by platform"
25 }
26 }
27}
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
objectRequiredinvoice_payment
attributesResponse Body
Any of:
invoice_payment
objectRequiredinvoice_payment
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Netsuite
- Quickbooks
- QuickBooks Desktop
- Xero
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 "updated_at": "2023-01-02T02:34:56.000Z",
21 "last_synced_at": "2023-01-02T02:34:56.000Z",
22 "platform_data": {
23 "id": 123,
24 "data": "Varies by platform"
25 }
26 }
27}
Have questions?
Contact support for personalized guidance.