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 Sales Orders
Retrieve sales orders from the database based on the ID
curl --request POST \
--url https://api.rootfi.dev/accounting/sales_orders/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"status": {
"eq": "SUBMITTED"
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 137160,
"rootfi_company_id": 1760,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "QUICKBOOKS_SANDBOX",
"rootfi_updated_at": "2023-10-26T16:14:59.673Z",
"rootfi_created_at": "2023-10-26T16:14:59.685Z",
"platform_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"invoice_ids": [
"3770712000000000099"
],
"currency_id": null,
"document_number": "A-1011",
"posted_date": "2023-01-17T00:00:00.000Z",
"delivery_date": null,
"description": null,
"currency_rate": 1,
"status": "SUBMITTED",
"total_amount": 78.75,
"sub_total": 87.5,
"tax_amount": 0,
"total_discount": 8.75,
"updated_at": "2023-01-17T00:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"addresses": {
"data": [
{
"platform_id": "_CONTACTS_1013_BILLING",
"type": "BILLING",
"data_model": "CONTACTS",
"data_model_id": "1013",
"street": "123 Main Street",
"locality": "Downtown",
"city": "Metropolis",
"state": "Stateville",
"country": "Countryland",
"pincode": "12345",
"updated_at": "2023-11-06T10:00:00.000Z"
}
]
},
"line_items": {
"data": [
{
"platform_id": "1234567890123456789",
"line_item_type": "BILLS",
"line_item_type_id": "1234567890123456789",
"tracking_category_ids": [
"1234567890123456789"
],
"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"
}
]
}
}
],
"total_count": 1
},
"request_timestamp": "2023-10-27T05:05:28.522Z",
"response_timestamp": "2023-10-27T05:05:28.522Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}A Sales order is a record of goods or services sold to a customer
curl --request POST \
--url https://api.rootfi.dev/accounting/sales_orders/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"status": {
"eq": "SUBMITTED"
}
}
}'
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 asc, desc asc, desc asc, desc asc, desc Response
The ID that the accounting platform uses to identify this sales order
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 ID of the contact associated with this sales order
Array of Invoices associated with the sales order
Currency ID of the sales order
Reference number for the sales order
Date of creation of the sales order
The delivery date for the sales order
Description of the sales order
Rate between the currency of the sales order and the base currency
The status of the sales order.
DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN The total value of the sales order
The total pre-tax value of the sales order
The total tax amount levied on the sales order
The total value of discounts applied to the sales order
The date at which the information was updated on the accounting platform
The currency associated with the sales order
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
The addresses associated with the sales order
The addresses associated with the contact
The ID of the address in the accounting platform
The type of address
BILLING, SHIPPING The data model that the address belongs to
The ID of the data model that the address belongs to
The street address
The locality Name
The city Name
The state Name
The country Name
The Portal Code
The time at which the address was last updated
Array of Sales Order Line items associated with the sales order
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
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/sales_orders/all \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"take": 10,
"skip": 0,
"orderBy": {
"total_amount": "asc"
},
"filter": {
"status": {
"eq": "SUBMITTED"
}
}
}'
{
"data": {
"data": [
{
"rootfi_id": 137160,
"rootfi_company_id": 1760,
"rootfi_organisation_id": 1,
"rootfi_integration_type": "QUICKBOOKS_SANDBOX",
"rootfi_updated_at": "2023-10-26T16:14:59.673Z",
"rootfi_created_at": "2023-10-26T16:14:59.685Z",
"platform_id": "1234567890123456789",
"contact_id": "1234567890123456789",
"invoice_ids": [
"3770712000000000099"
],
"currency_id": null,
"document_number": "A-1011",
"posted_date": "2023-01-17T00:00:00.000Z",
"delivery_date": null,
"description": null,
"currency_rate": 1,
"status": "SUBMITTED",
"total_amount": 78.75,
"sub_total": 87.5,
"tax_amount": 0,
"total_discount": 8.75,
"updated_at": "2023-01-17T00:00:00.000Z",
"currency": {
"data": {
"platform_id": null,
"name": null,
"code": null,
"symbol": null,
"is_base_currency": null,
"exchange_rate": null,
"updated_at": null
}
},
"addresses": {
"data": [
{
"platform_id": "_CONTACTS_1013_BILLING",
"type": "BILLING",
"data_model": "CONTACTS",
"data_model_id": "1013",
"street": "123 Main Street",
"locality": "Downtown",
"city": "Metropolis",
"state": "Stateville",
"country": "Countryland",
"pincode": "12345",
"updated_at": "2023-11-06T10:00:00.000Z"
}
]
},
"line_items": {
"data": [
{
"platform_id": "1234567890123456789",
"line_item_type": "BILLS",
"line_item_type_id": "1234567890123456789",
"tracking_category_ids": [
"1234567890123456789"
],
"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"
}
]
}
}
],
"total_count": 1
},
"request_timestamp": "2023-10-27T05:05:28.522Z",
"response_timestamp": "2023-10-27T05:05:28.522Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}