curl --request POST \
--url https://api.rootfi.dev/accounting/purchase_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",
"bill_ids": [
"1234567890123456789"
],
"contact_id": "1234567890123456789",
"currency_id": null,
"document_number": "A-1002",
"delivery_date": "2023-01-17T00:00:00.000Z",
"posted_date": "2023-01-17T00:00:00.000Z",
"description": "Test description",
"currency_rate": null,
"status": "SUBMITTED",
"total_amount": 125,
"sub_total": null,
"tax_amount": null,
"total_discount": null,
"updated_at": "2023-01-17T00:00:00.000Z",
"payment_mode": null,
"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-01-17T00:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}Retrieve purchase orders
Retrieve purchase orders from the database based on the ID
curl --request POST \
--url https://api.rootfi.dev/accounting/purchase_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",
"bill_ids": [
"1234567890123456789"
],
"contact_id": "1234567890123456789",
"currency_id": null,
"document_number": "A-1002",
"delivery_date": "2023-01-17T00:00:00.000Z",
"posted_date": "2023-01-17T00:00:00.000Z",
"description": "Test description",
"currency_rate": null,
"status": "SUBMITTED",
"total_amount": 125,
"sub_total": null,
"tax_amount": null,
"total_discount": null,
"updated_at": "2023-01-17T00:00:00.000Z",
"payment_mode": null,
"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-01-17T00:00:00.000Z",
"request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}curl --request POST \
--url https://api.rootfi.dev/accounting/purchase_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
Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The ID that the accounting platform uses to identify this purchase 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 purchase order
Array of Bills associated with the purchase order
The accounting platform’s identifier for the currency used in the purchase order
Reference number for the purchase order Some platforms may not support this field because it is auto generated
The delivery date for the purchase order
Date of creation of the purchase order
Description of the purchase order
Rate between the currency of the payment and the base currency
The status of the purchase order.
DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, OVERDUE, VOID, UNKNOWN Total value of the purchase order
Total pre-tax value of the purchase order
Total tax amount levied on the purchase order
Total value of discounts applied to the purchase order
The date at which the information was updated on the accounting platform
The payment mode from which the payment was made for the journal entry
The ISO-4217 currency code used for the journal entry
Show child attributes
Show child attributes
Currency associated with the account.
Show child attributes
Show child attributes
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
An array of addresses associated with the purchase order
Show child attributes
Show child attributes
The addresses associated with the contact
Show child attributes
Show child attributes
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 Purchase Order Line items associated with the purchase order
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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