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
Create Invoice
Add an invoice.
curl --request POST \
--url https://api.rootfi.dev/accounting/invoices \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"contact_id": "123456",
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"due_date": "2021-09-28T15:00:00.000Z",
"memo": "Test Invoice",
"line_items": [
{
"account_id": "123456",
"quantity": 1,
"item_id": "123456",
"tax_id": "123456",
"unit_amount": 100,
"total_discount": 0,
"description": "Test Item"
}
]
}
]
}'
{
"data": {
"status": "SUCCESS",
"upload_job_id": "aXI9pUDA5T7E2LS",
"data": [
{
"job_id": "xQm2K441VosP8W4",
"status": "success",
"response": {
"tax_amount": 34.2,
"document_number": "INV82897",
"total_discount": 10,
"due_date": "2024-03-19T00:00:00.000Z",
"memo": "Tvoice",
"contact_id": "3770712000000080150",
"currency_rate": 1,
"updated_at": "2023-11-01T00:00:00.000Z",
"total_amount": 224.2,
"sales_order_ids": [],
"platform_id": "3770712000001676083",
"sub_total": 190,
"amount_due": 224.2,
"posted_date": "2023-03-17T00:00:00.000Z",
"currency_id": "3770712000000000099",
"status": "DRAFT",
"raw_data": {
"platform_id": "123456",
"nominal_code": "Rootfi 01",
"name": "Test Account",
"description": "Test Description",
"category": "LIABILITY",
"sub_category": "Long Term Liabilities",
"status": "ACTIVE"
}
},
"error": null
}
]
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}The Invoices Data Model is designed to standardise and simplify the handling of invoice-related information across different accounting platforms.
Authorizations
Body
Create invoices for the company
1
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
Array of Invoice Line items associated with the invoice
The ID of the account in the accounting platform
The quantity of the item
The ID of the item in the accounting platform
The ID of the tax in the accounting platform
The unit amount of the item
The total discount on the item
The description of the item
The IDs of the tracking categories in the accounting platform
A JSON containing fields that you can directly pass to the accounting platform.
Response
The status of the job.
SUCCESS, FAILED, CREATED, RUNNING The ID of the job.
The ID of the job.
The status of the job.
success, failed 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.
The raw JSON response we get from the accounting platform for that data
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/invoices \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"contact_id": "123456",
"document_number": "ROOTFI01",
"posted_date": "2021-09-28T15:00:00.000Z",
"due_date": "2021-09-28T15:00:00.000Z",
"memo": "Test Invoice",
"line_items": [
{
"account_id": "123456",
"quantity": 1,
"item_id": "123456",
"tax_id": "123456",
"unit_amount": 100,
"total_discount": 0,
"description": "Test Item"
}
]
}
]
}'
{
"data": {
"status": "SUCCESS",
"upload_job_id": "aXI9pUDA5T7E2LS",
"data": [
{
"job_id": "xQm2K441VosP8W4",
"status": "success",
"response": {
"tax_amount": 34.2,
"document_number": "INV82897",
"total_discount": 10,
"due_date": "2024-03-19T00:00:00.000Z",
"memo": "Tvoice",
"contact_id": "3770712000000080150",
"currency_rate": 1,
"updated_at": "2023-11-01T00:00:00.000Z",
"total_amount": 224.2,
"sales_order_ids": [],
"platform_id": "3770712000001676083",
"sub_total": 190,
"amount_due": 224.2,
"posted_date": "2023-03-17T00:00:00.000Z",
"currency_id": "3770712000000000099",
"status": "DRAFT",
"raw_data": {
"platform_id": "123456",
"nominal_code": "Rootfi 01",
"name": "Test Account",
"description": "Test Description",
"category": "LIABILITY",
"sub_category": "Long Term Liabilities",
"status": "ACTIVE"
}
},
"error": null
}
]
},
"request_timestamp": "2021-09-28T15:00:00.000Z",
"response_timestamp": "2021-09-28T15:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}