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 Bill Payment
Add a bill payment.
curl --request POST \
--url https://api.rootfi.dev/accounting/bill_payments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"bill_id": "123456",
"contact_id": "123456",
"amount": 100,
"account_id": "123456",
"payment_date": "2021-09-28T15:00:00.000Z",
"document_number": "ROOTFI01",
"memo": "Test Memo"
}
]
}'
{
"data": {
"status": "SUCCESS",
"upload_job_id": "xQm2K441VosP8W4",
"data": [
{
"job_id": "aXI9pUDA5T7E2LS",
"status": "success",
"response": {
"platform_id": "3770712000001669018",
"payment_id": "3770712000001669016",
"bill_id": "3770712000000319001",
"contact_id": "3770712000000209007",
"credit_note_id": "3770712000001669016",
"account_id": "3770712000000000361",
"currency_id": "3770712000000000099",
"amount": 1234,
"payment_date": "2023-03-01T00:00:00.000Z",
"payment_mode": "Cash",
"currency_rate": 12,
"document_number": "S69",
"memo": "Payment for the Bill",
"updated_at": "2023-11-01T00:00:00.000Z",
"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": "b2e791f5-7384-4e4f-800f-5c032f6bb61b"
}
The Bill Payments Data Model is designed to standardise and simplify the management of bill payment information across various accounting platforms.
curl --request POST \
--url https://api.rootfi.dev/accounting/bill_payments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"bill_id": "123456",
"contact_id": "123456",
"amount": 100,
"account_id": "123456",
"payment_date": "2021-09-28T15:00:00.000Z",
"document_number": "ROOTFI01",
"memo": "Test Memo"
}
]
}'
Authorizations
Body
The amount of the bill payment
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
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 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 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/bill_payments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1,
"data": [
{
"bill_id": "123456",
"contact_id": "123456",
"amount": 100,
"account_id": "123456",
"payment_date": "2021-09-28T15:00:00.000Z",
"document_number": "ROOTFI01",
"memo": "Test Memo"
}
]
}'
{
"data": {
"status": "SUCCESS",
"upload_job_id": "xQm2K441VosP8W4",
"data": [
{
"job_id": "aXI9pUDA5T7E2LS",
"status": "success",
"response": {
"platform_id": "3770712000001669018",
"payment_id": "3770712000001669016",
"bill_id": "3770712000000319001",
"contact_id": "3770712000000209007",
"credit_note_id": "3770712000001669016",
"account_id": "3770712000000000361",
"currency_id": "3770712000000000099",
"amount": 1234,
"payment_date": "2023-03-01T00:00:00.000Z",
"payment_mode": "Cash",
"currency_rate": 12,
"document_number": "S69",
"memo": "Payment for the Bill",
"updated_at": "2023-11-01T00:00:00.000Z",
"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": "b2e791f5-7384-4e4f-800f-5c032f6bb61b"
}