Edara API v3 reference

A reference for the Edara REST API v3, written so that AI coding assistants and developers can use it directly. It lists every public endpoint with its parameters, real defaults, validation rules, response types and business error codes.

Use it with an AI coding assistant

Point your assistant at the index file. It links to one small page per resource, so the assistant loads only what it needs.

https://developers.edara.io/llms.txt

Claude Code, Cursor, Copilot and similar tools: add this line to your project instructions file (CLAUDE.md, .cursorrules or AGENTS.md):

Before writing code that calls the Edara API, read https://developers.edara.io/llms.txt and the guide it links to.

Chat assistants: paste the link and ask your question.

Everything in one file: https://developers.edara.io/llms-full.txt

Start here

Guide: authentication, paging, errors, rate limits and the behaviours that most often cause wrong results.

Reference

Sales

Bundles: 4 endpoints: /v3/bundles, /v3/bundles/{id}
Customers: 18 endpoints: /v3/customers, /v3/customers/{id}, /v3/customers/{id}/addresses, /v3/customers/{id}/balance, /v3/customers/{id}/invoiceable-documents, and more
Sales Orders: 15 endpoints: /v3/sales-orders, /v3/sales-orders/{id}, /v3/sales-orders/issued, /v3/sales-orders/header, /v3/sales-orders/code/{code}, and more
Sales Persons: 7 endpoints: /v3/sales-persons, /v3/sales-persons/{id}, /v3/sales-persons/code/{code}
Sales Returns: 3 endpoints: /v3/sales-returns, /v3/sales-returns/returnable
Sales Stores: 2 endpoints: /v3/sales-stores
Service Items: 7 endpoints: /v3/service-items, /v3/service-items/{id}, /v3/service-items/code/{code}

Inventory

Stock Items: 28 endpoints: /v3/stock-items, /v3/stock-items/list, /v3/stock-items/{id}, /v3/stock-items/search, /v3/stock-items/batch, and more
Brands: 3 endpoints: /v3/brands, /v3/brands/{id}
Classifications: 5 endpoints: /v3/classifications/stock-items, /v3/classifications/stock-items/tree/{userId}, /v3/classifications/common, /v3/classifications/common/{id}
Dynamic Properties: 4 endpoints: /v3/dynamic-properties, /v3/dynamic-properties/tree/{userId}, /v3/dynamic-properties/batch, /v3/dynamic-properties/{id}
Units of Measure: 4 endpoints: /v3/units-of-measure/standard, /v3/units-of-measure, /v3/units-of-measure/{id}
Warehouses: 8 endpoints: /v3/warehouses, /v3/warehouses/{id}, /v3/warehouses/code/{code}, /v3/warehouses/rma, /v3/warehouses/{id}/balance, and more
Work Orders: 5 endpoints: /v3/work-orders, /v3/work-orders/{id}, /v3/work-orders/issue-offering, /v3/work-orders/receive-supplies, /v3/work-orders/opening-balance

Accounting

Accounts: 4 endpoints: /v3/accounts, /v3/accounts/{id}, /v3/accounts/{id}/balance, /v3/accounts/nodes
Cash In/Out: 2 endpoints: /v3/cash-in, /v3/cash-out
Cost Centers: 2 endpoints: /v3/cost-centers, /v3/cost-centers/{id}
Currencies: 7 endpoints: /v3/currencies, /v3/currencies/{id}, /v3/currencies/code/{code}
Journal Entries: 5 endpoints: /v3/journal-entries, /v3/journal-entries/code/{code}, /v3/journal-entries/payment
Taxes: 6 endpoints: /v3/taxes, /v3/taxes/{id}, /v3/taxes/einvoice-tax-types
Tax Invoices: 3 endpoints: /v3/tax-invoices/nr-report, /v3/tax-invoices/np-report, /v3/tax-invoices/taxable-sales-invoices

Purchasing

Purchase Orders: 4 endpoints: /v3/purchase-orders, /v3/purchase-orders/{id}, /v3/purchase-orders/find, /v3/purchase-orders/purchase-returns/find
Suppliers: 5 endpoints: /v3/suppliers, /v3/suppliers/{id}

Common

Cities: 5 endpoints: /v3/cities, /v3/cities/{id}
Common: 4 endpoints: /v3/common/convert-money-to-arabic-words, /v3/common/convert-money-to-english-words, /v3/common/files/{token}, /v3/common/adjust-invoiced-quantity
Countries: 5 endpoints: /v3/countries, /v3/countries/{id}
Districts: 5 endpoints: /v3/districts, /v3/districts/{id}
Document Manual Links: 3 endpoints: /v3/documents/{code}/manual-links, /v3/documents/{code}/manual-links/{linkedCode}
Settings: 1 endpoint: /v3/settings
Tags: 1 endpoint: /v3/tags