General
Server Side SDKs
Core API
- Companies
- Invite Links
- Integrations
- Sync
- Jobs
- Passthrough
Unified API
- Accounting
- Accounts
- Bank Accounts
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Get Invoice Payments
Retrieve invoice payments from the database based on the ID
curl --request POST \
--url https://api.rootfi.dev/accounting/invoice_payments/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"amount": "asc"
},
"filter": {
"contact_id": {
"eq": "1234567890123456789"
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 443583,
"rootfi_company_id": 1672,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "ZOHO_BOOKS",
"rootfi_updated_at": "2023-10-25T13:39:41.201Z",
"rootfi_created_at": "2023-10-25T13:39:41.216Z",
"platform_id": "1234567890123456789",
"payment_id": "1234567890123456789",
"invoice_id": "1234567890123456789",
"credit_note_id": "1234567890123456789",
"account_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"currency_id": null,
"amount": 105,
"payment_date": "2022-12-27T00:00:00.000Z",
"payment_mode": null,
"document_number": null,
"memo": "Amy claims the pest control did not occur",
"currency_rate": 1,
"updated_at": "2023-01-18T00:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"invoice": {
"data": {
"platform_id": "71",
"contact_id": "1",
"sales_order_ids": null,
"document_number": "1025",
"posted_date": "2022-12-02T00:00:00.000Z",
"due_date": "2023-01-01T00:00:00.000Z",
"currency_id": null,
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"currency_rate": null,
"status": "PAID",
"total_amount": 205,
"sub_total": 205,
"total_discount": null,
"tax_amount": 0,
"amount_due": 0,
"memo": null,
"updated_at": "2023-01-18T00:00:00.000Z"
}
}
}
],
"total_count": 1
},
"request_timestamp": "2023-10-25T13:39:41.201Z",
"response_timestamp": "2023-10-25T13:39:41.201Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}The Invoice Payments Data Model streamlines the representation and management of invoice payment information across multiple accounting platforms.
curl --request POST \
--url https://api.rootfi.dev/accounting/invoice_payments/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"amount": "asc"
},
"filter": {
"contact_id": {
"eq": "1234567890123456789"
}
}
}'
Authorizations
Body
asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc Response
The ID that the accounting platform uses to identify this account
The unique ID we assign for that data's information
The RootFi designated id for the company
The RootFi designated id for the organisation
The accounting platform from which the data is being retrieved
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, WAVE, ODOO_ACCOUNTING, NETSUITE, WAFEQ, MEKARI_JURNAL, BUSY, ROOTFI_SANDBOX, QOYOD The latest date at which RootFi updated this data
The date at which RootFi first synced this data
The accounting platform’s unique identifier for this specific payment
The accounting platform’s unique identifier for the invoice associated with this invoice payment
The accounting platform’s unique identifier for the account associated with this invoice payment
The accounting platform’s unique identifier for the contact associated with this invoice payment
The accounting platform’s unique identifier for the credit note associated with this invoice payment
The accounting platform’s unique identifier for the currency associated with this invoice payment
The amount of the invoice payment
The date of the invoice payment
The payment mode of the invoice payment
Reference number for the invoice payment
Description of the invoice payment
Rate between the currency of the payment and the base currency
The last ISO 8601 timestamp at which the payment data was updated
A map containing details of the currency used for this payment
Currency associated with the account.
The ID that the accounting platform uses to identify this currency
The name of the currency
The code of the currency
The symbol of the currency
Is this the base currency of the organisation?
The exchange rate of the currency
The last ISO 8601 timestamp that the data was updated at
A map containing details of the invoice associated with this payment
The ID that the accounting platform uses to identify this invoice
The Accounting Platform’s unique ID for the contact who receives this invoice
The ISO-4217 currency code of the invoice
Reference document number for the invoice
Date of the invoice as recorded by the accounting platform
The due date for the invoice as an ISO 8601 timestamp
Description of the invoice
Rate between the currency of the payment and the base currency
The status of the invoice.
DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN Total tax amount levied on the invoice
Total value of discounts applied to the invoice
Total value of the invoice
Array of linked Sales Orders IDs associated with this invoice
Total pre tax value of the invoice
Total amount pending for the invoice
Date the record was last updated in the accounting platform.
A map containing details of the currency used for this invoice
The total count of the accounts
The time at which the request was received by the server
The time at which the response was sent by the server
The unique ID of the request
curl --request POST \
--url https://api.rootfi.dev/accounting/invoice_payments/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"amount": "asc"
},
"filter": {
"contact_id": {
"eq": "1234567890123456789"
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 443583,
"rootfi_company_id": 1672,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "ZOHO_BOOKS",
"rootfi_updated_at": "2023-10-25T13:39:41.201Z",
"rootfi_created_at": "2023-10-25T13:39:41.216Z",
"platform_id": "1234567890123456789",
"payment_id": "1234567890123456789",
"invoice_id": "1234567890123456789",
"credit_note_id": "1234567890123456789",
"account_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"currency_id": null,
"amount": 105,
"payment_date": "2022-12-27T00:00:00.000Z",
"payment_mode": null,
"document_number": null,
"memo": "Amy claims the pest control did not occur",
"currency_rate": 1,
"updated_at": "2023-01-18T00:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"invoice": {
"data": {
"platform_id": "71",
"contact_id": "1",
"sales_order_ids": null,
"document_number": "1025",
"posted_date": "2022-12-02T00:00:00.000Z",
"due_date": "2023-01-01T00:00:00.000Z",
"currency_id": null,
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"currency_rate": null,
"status": "PAID",
"total_amount": 205,
"sub_total": 205,
"total_discount": null,
"tax_amount": 0,
"amount_due": 0,
"memo": null,
"updated_at": "2023-01-18T00:00:00.000Z"
}
}
}
],
"total_count": 1
},
"request_timestamp": "2023-10-25T13:39:41.201Z",
"response_timestamp": "2023-10-25T13:39:41.201Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}