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 All Bills
List all Bills for a company ID
curl --request POST \
--url https://api.rootfi.dev/accounting/bills/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"amount_due": {
"gt": 4000
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 1234,
"rootfi_company_id": 123456,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "ZOHO_BOOKS",
"rootfi_updated_at": "2021-09-28T15:00:00.000Z",
"rootfi_created_at": "2021-09-28T15:00:00.000Z",
"platform_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"currency_id": null,
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"due_date": "2021-09-28T15:00:00.000Z",
"memo": "Test Invoice",
"currency_rate": 1234,
"status": "DRAFT",
"total_amount": 100,
"sub_total": 1123,
"total_discount": 234,
"tax_amount": 0,
"amount_due": 100,
"purchase_order_ids": [
"1234567890123456789"
],
"updated_at": "2021-09-28T15:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"line_items": {
"data": [
{
"platform_id": "1234567890123456789",
"line_item_type": "BILLS",
"line_item_type_id": "1234567890123456789",
"tracking_category_ids": [],
"item_id": "1234567890123456789",
"tax_id": "1234567890123456789",
"account_id": null,
"description": "Test Item",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": null,
"tax_amount": 0,
"total_discount": null,
"updated_at": "2021-09-28T15:00:00.000Z"
}
]
},
"documents": {
"data": [
{
"platform_id": "3770712000000085065_3770712000000080327",
"file_name": "Documents.csv",
"file_type": "text/csv",
"file_size": 254.8828125,
"document_type_id": "3770712000000080327",
"document_type": "INVOICES",
"document_uploaded": false,
"download_link": "https://rootfi-dev.s3.amazonaws.com/3770712000000085065_3770712000000080327",
"updated_at": "2021-03-03T10:00:00.000Z"
}
]
},
"payments": {
"data": [
{
"platform_id": "3770712000000106211",
"payment_id": "3770712000000106209",
"bill_id": "3770712000000085084",
"contact_id": null,
"account_id": "3770712000000000361",
"amount": 150,
"payment_date": "2023-02-03T00:00:00.000Z",
"payment_mode": "Cash",
"currency_id": "3770712000000000099",
"currency": {
"data": {
"platform_id": "3770712000000000099",
"name": "Indian Rupee",
"code": "INR",
"symbol": "₹",
"is_base_currency": true,
"exchange_rate": 0,
"updated_at": null
}
},
"currency_rate": 1,
"memo": "Description?",
"document_number": "2",
"updated_at": null
}
]
}
}
],
"total_count": 0
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}A Bills record of goods or services purchased from a vendor.
curl --request POST \
--url https://api.rootfi.dev/accounting/bills/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"amount_due": {
"gt": 4000
}
}
}'
Authorizations
Body
asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc Response
The data object of the bill
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 ID that the accounting platform uses to identify this bill
The accounting platform’s unique ID of the contact associated with this bill
The ISO-4217 currency code of the bill
Reference number for the bill
Date of creation of the bill
The due date for the bill
Memo or description of the bill
Rate between the currency of the bill and the base currency
The status of the bill.
DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN Total amount of the bill
Total pre-tax amount of the bill
Total discount amount levied on the bill
Total tax amount levied on the bill
Outstanding amount to be paid for the bill
Array of Purchase Order IDs associated with the bill
The date at which the bill was updated on the accounting platform
A map containing details of the currency used for the bill, such as ISO-4217 currency code
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
Array of Bill Line items associated with the bill
The item id of the line item
The tax id of the line item
The quantity of the line item
The unit amount of the line item
The platform id of the line item
The line item type of the line item
BILLS, INVOICES, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS, SALES_ORDERS The line item type id of the line item
The tracking category ids of the line item
The account id of the line item
The description of the line item
The total amount of the line item
The sub total of the line item
The tax amount of the line item
The total discount of the line item
The last ISO 8601 timestamp that the data was updated at
A map containing details of documents associated with the bill
A map containing details of payments made towards the bill
The ID that the accounting platform uses to identify this account
The amount of the bill payment
The ID that the accounting platform uses to identify this account
The accounting platform’s unique identifier for the bill associated with this bill payment
The accounting platform’s unique identifier for the contact associated with this bill payment
The accounting platform’s unique identifier for the account associated with this bill payment
The accounting platform’s unique identifier for the credit note associated with this bill payment
The accounting platform’s unique identifier for the currency associated with this bill payment
The date of the bill payment
The payment mode of the bill payment
Rate between the currency of the bill and the base currency
Reference number for the bill payment
Description of the bill payment
The last ISO 8601 timestamp that the data was updated at
The currency of the bill payment
Total Count of response object
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/bills/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"amount_due": {
"gt": 4000
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 1234,
"rootfi_company_id": 123456,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "ZOHO_BOOKS",
"rootfi_updated_at": "2021-09-28T15:00:00.000Z",
"rootfi_created_at": "2021-09-28T15:00:00.000Z",
"platform_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"currency_id": null,
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"due_date": "2021-09-28T15:00:00.000Z",
"memo": "Test Invoice",
"currency_rate": 1234,
"status": "DRAFT",
"total_amount": 100,
"sub_total": 1123,
"total_discount": 234,
"tax_amount": 0,
"amount_due": 100,
"purchase_order_ids": [
"1234567890123456789"
],
"updated_at": "2021-09-28T15:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"line_items": {
"data": [
{
"platform_id": "1234567890123456789",
"line_item_type": "BILLS",
"line_item_type_id": "1234567890123456789",
"tracking_category_ids": [],
"item_id": "1234567890123456789",
"tax_id": "1234567890123456789",
"account_id": null,
"description": "Test Item",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": null,
"tax_amount": 0,
"total_discount": null,
"updated_at": "2021-09-28T15:00:00.000Z"
}
]
},
"documents": {
"data": [
{
"platform_id": "3770712000000085065_3770712000000080327",
"file_name": "Documents.csv",
"file_type": "text/csv",
"file_size": 254.8828125,
"document_type_id": "3770712000000080327",
"document_type": "INVOICES",
"document_uploaded": false,
"download_link": "https://rootfi-dev.s3.amazonaws.com/3770712000000085065_3770712000000080327",
"updated_at": "2021-03-03T10:00:00.000Z"
}
]
},
"payments": {
"data": [
{
"platform_id": "3770712000000106211",
"payment_id": "3770712000000106209",
"bill_id": "3770712000000085084",
"contact_id": null,
"account_id": "3770712000000000361",
"amount": 150,
"payment_date": "2023-02-03T00:00:00.000Z",
"payment_mode": "Cash",
"currency_id": "3770712000000000099",
"currency": {
"data": {
"platform_id": "3770712000000000099",
"name": "Indian Rupee",
"code": "INR",
"symbol": "₹",
"is_base_currency": true,
"exchange_rate": 0,
"updated_at": null
}
},
"currency_rate": 1,
"memo": "Description?",
"document_number": "2",
"updated_at": null
}
]
}
}
],
"total_count": 0
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}