Invoice Payments
Get Invoice Payments
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
Invoice Payments
Get Invoice Payments
Retrieve invoice payments from the database based on the ID
POST
/
accounting
/
invoice_payments
/
all
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
application/json
Response
200 - application/json
The response is of type object
.
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"
}