General
Server Side SDKs
Core API
- Companies
- Invite Links
- Sync
- Passthrough
- Real Time
- Webhooks
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
- Payments
- Ecommerce
- CRM
Get All Goods Receipt Notes
Retrieve all Goods Receipt Notes.
curl --request GET \
--url https://api.rootfi.dev/v3/accounting/goods_receipt_notes \
--header 'api_key: <api-key>'{
"data": [
{
"rootfi_id": 123,
"rootfi_deleted_at": null,
"rootfi_created_at": "2024-01-25T09:00:00Z",
"rootfi_updated_at": "2024-01-25T09:00:00Z",
"rootfi_company_id": 456,
"platform_id": "123456_1",
"platform_unique_id": "123456",
"description": "Example Description",
"sub_total": 1000,
"total_amount": 1100,
"total_discount": 100,
"tax_amount": 100,
"updated_at": "2024-01-25T09:00:00Z",
"payment_mode": "Example Payment Mode",
"delivery_date": "2024-01-25T09:00:00Z",
"purchase_order_ids": [
"123456"
],
"currency_id": "123456",
"currency_rate": 1,
"document_number": "123456",
"posted_date": "2024-01-25T09:00:00Z",
"status": "Example Status",
"contact_id": "123456",
"line_items": [
{
"rootfi_id": 157,
"platform_id": "123456",
"line_item_type": "INVOICES",
"line_item_type_id": "123456",
"tracking_category_ids": [
"123456"
],
"project_id": "123456",
"item_id": "123456",
"tax_id": "123456",
"account_id": "123456",
"description": "This is a description",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": 100,
"tax_amount": 100,
"total_discount": 100,
"updated_at": "2024-01-22T05:07:31.000Z"
}
]
}
],
"prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
"next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
"total_count": 123
}A goods receipt note is a document that acknowledges the delivery of goods to a customer by a supplier
Authorizations
Query Parameters
The number of objects you want to retrieve
The next page of objects to retrieve
The previous page of objects to retrieve
Comma separated fields to expand.
Comma separated fields to select. Supported values are raw_data, data_hash
Filter by rootfi_updated_at Greater than or Equal To.
Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]
Include deleted records. By default, deleted records are not included. Supported values are true and false
Return the count of the objects. Supported values are true and false
Response
The data of the invoices endpoint
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
The description of the goods receipt note
The sub total of the goods receipt note
The total amount of the goods receipt note
The total discount of the goods receipt note
The tax amount of the goods receipt note
The updated at of the goods receipt note
The payment mode of the goods receipt note
The delivery date of the goods receipt note
The purchase order IDs of the goods receipt note
The currency ID of the goods receipt note
The currency rate of the goods receipt note
The document number of the goods receipt note
The posted date of the goods receipt note
The status of the goods receipt note
The contact ID of the goods receipt note
The line items of the goods receipt note.
The unique ID we assign for that data's information
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 project id of the line item
The item id of the line item
The item of the line item
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Name of the item
Description of the item
Status of the item. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN Type of the item. Values are INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN Reference code of the item
Quantity on hand
Check if there are details (bill_item) of this item getting purchased
Item details of this item getting purchased
Check if there are details (invoice_item) of this item getting sold
Item details of this item getting sold
Tax id of the item
Unit price of the item
Description of the item
The date the item was last updated
The tax id of the line item
The tax of the line item
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Display name
Simple ID for the tax rate
The type of tax as mentioned in the accounting platform
The total tax rate after accounting for the compounding effects of the all tax components
The sum of all the tax rate components
The list of tax rate components
Display name
The total tax rate after accounting for the compounding effects of the all tax components
The tax agency of the tax rate component
Whether the tax rate component is compound
The last time the tax rate was updated
The account id of the line item
The account of the line item
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Name of the account
Description of the account
The nominal code of the account
The current balance of the account
The date the account was last updated
The status of the account
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The sub category of the account
The currency id of the account
The parent account id of the account
The parent account of the account.
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Name of the account
Description of the account
The nominal code of the account
The current balance of the account
The date the account was last updated
The status of the account
The category of the account
ASSET, EXPENSE, LIABILITY, EQUITY, INCOME, BANK, UNKNOWN The sub category of the account
The currency id of the account
The parent account id of the account
The currency of the account.
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
The name of the currency
The currency code.
The symbol that represents the currency. Not applicable for many currencies.
Whether the currency is the base currency for the company.
The exchange rate for the currency.
The last ISO 8601 timestamp that the data was updated at.
The description of the line item
The quantity of the line item
The unit amount 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
The currency of the invoice
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
The name of the currency
The currency code.
The symbol that represents the currency. Not applicable for many currencies.
Whether the currency is the base currency for the company.
The exchange rate for the currency.
The last ISO 8601 timestamp that the data was updated at.
The contact of the invoice
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the company in the accounting platform
An unique custom RootFi ID made from platform's unique_id.
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Name of the contact
Name of the contact person for the contact
The type of contact. Values are either CUSTOMER or VENDOR
CUSTOMER, VENDOR The ISO-4217 currency code
Contact’s tax number
Contact’s identifying number
The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN
ACTIVE, ARCHIVED, UNKNOWN The date the contact was last updated
External links for the contact
The RootFi ID of the contact
The platform ID of the contact
The link to the contact
The type of the link.
EMAIL, WEBSITE Phone numbers for the contact
The RootFi ID of the contact
The platform ID of the contact
The number to the contact
The type of the link.
MOBILE, TELEPHONE, FAX Addresses for the contact
The RootFi ID of the contact
The platform ID of the contact
The street of the address
The locality of the address
The city of the address
The state of the address
The pincode of the address
The country of the address
The previous page of objects to retrieve
The next page of objects to retrieve
The total count of the objects
curl --request GET \
--url https://api.rootfi.dev/v3/accounting/goods_receipt_notes \
--header 'api_key: <api-key>'{
"data": [
{
"rootfi_id": 123,
"rootfi_deleted_at": null,
"rootfi_created_at": "2024-01-25T09:00:00Z",
"rootfi_updated_at": "2024-01-25T09:00:00Z",
"rootfi_company_id": 456,
"platform_id": "123456_1",
"platform_unique_id": "123456",
"description": "Example Description",
"sub_total": 1000,
"total_amount": 1100,
"total_discount": 100,
"tax_amount": 100,
"updated_at": "2024-01-25T09:00:00Z",
"payment_mode": "Example Payment Mode",
"delivery_date": "2024-01-25T09:00:00Z",
"purchase_order_ids": [
"123456"
],
"currency_id": "123456",
"currency_rate": 1,
"document_number": "123456",
"posted_date": "2024-01-25T09:00:00Z",
"status": "Example Status",
"contact_id": "123456",
"line_items": [
{
"rootfi_id": 157,
"platform_id": "123456",
"line_item_type": "INVOICES",
"line_item_type_id": "123456",
"tracking_category_ids": [
"123456"
],
"project_id": "123456",
"item_id": "123456",
"tax_id": "123456",
"account_id": "123456",
"description": "This is a description",
"quantity": 1,
"unit_amount": 100,
"total_amount": 100,
"sub_total": 100,
"tax_amount": 100,
"total_discount": 100,
"updated_at": "2024-01-22T05:07:31.000Z"
}
]
}
],
"prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
"next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
"total_count": 123
}