# 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.

```text
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`):

```text
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](guide.md): authentication, paging, errors, rate limits and the behaviours that
  most often cause wrong results.

## Reference

### Sales

- [Bundles](reference/bundles.md): 4 endpoints: /v3/bundles, /v3/bundles/{id}
- [Customers](reference/customers.md): 18 endpoints: /v3/customers, /v3/customers/{id}, /v3/customers/{id}/addresses, /v3/customers/{id}/balance, /v3/customers/{id}/invoiceable-documents, and more
- [Sales Orders](reference/sales-orders.md): 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](reference/sales-persons.md): 7 endpoints: /v3/sales-persons, /v3/sales-persons/{id}, /v3/sales-persons/code/{code}
- [Sales Returns](reference/sales-returns.md): 3 endpoints: /v3/sales-returns, /v3/sales-returns/returnable
- [Sales Stores](reference/sales-stores.md): 2 endpoints: /v3/sales-stores
- [Service Items](reference/service-items.md): 7 endpoints: /v3/service-items, /v3/service-items/{id}, /v3/service-items/code/{code}

### Inventory

- [Stock Items](reference/stock-items.md): 28 endpoints: /v3/stock-items, /v3/stock-items/list, /v3/stock-items/{id}, /v3/stock-items/search, /v3/stock-items/batch, and more
- [Brands](reference/brands.md): 3 endpoints: /v3/brands, /v3/brands/{id}
- [Classifications](reference/classifications.md): 5 endpoints: /v3/classifications/stock-items, /v3/classifications/stock-items/tree/{userId}, /v3/classifications/common, /v3/classifications/common/{id}
- [Dynamic Properties](reference/dynamic-properties.md): 4 endpoints: /v3/dynamic-properties, /v3/dynamic-properties/tree/{userId}, /v3/dynamic-properties/batch, /v3/dynamic-properties/{id}
- [Units of Measure](reference/units-of-measure.md): 4 endpoints: /v3/units-of-measure/standard, /v3/units-of-measure, /v3/units-of-measure/{id}
- [Warehouses](reference/warehouses.md): 8 endpoints: /v3/warehouses, /v3/warehouses/{id}, /v3/warehouses/code/{code}, /v3/warehouses/rma, /v3/warehouses/{id}/balance, and more
- [Work Orders](reference/work-orders.md): 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](reference/accounts.md): 4 endpoints: /v3/accounts, /v3/accounts/{id}, /v3/accounts/{id}/balance, /v3/accounts/nodes
- [Cash In/Out](reference/cash-in-out.md): 2 endpoints: /v3/cash-in, /v3/cash-out
- [Cost Centers](reference/cost-centers.md): 2 endpoints: /v3/cost-centers, /v3/cost-centers/{id}
- [Currencies](reference/currencies.md): 7 endpoints: /v3/currencies, /v3/currencies/{id}, /v3/currencies/code/{code}
- [Journal Entries](reference/journal-entries.md): 5 endpoints: /v3/journal-entries, /v3/journal-entries/code/{code}, /v3/journal-entries/payment
- [Taxes](reference/taxes.md): 6 endpoints: /v3/taxes, /v3/taxes/{id}, /v3/taxes/einvoice-tax-types
- [Tax Invoices](reference/tax-invoices.md): 3 endpoints: /v3/tax-invoices/nr-report, /v3/tax-invoices/np-report, /v3/tax-invoices/taxable-sales-invoices

### Purchasing

- [Purchase Orders](reference/purchase-orders.md): 4 endpoints: /v3/purchase-orders, /v3/purchase-orders/{id}, /v3/purchase-orders/find, /v3/purchase-orders/purchase-returns/find
- [Suppliers](reference/suppliers.md): 5 endpoints: /v3/suppliers, /v3/suppliers/{id}

### Common

- [Cities](reference/cities.md): 5 endpoints: /v3/cities, /v3/cities/{id}
- [Common](reference/common.md): 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](reference/countries.md): 5 endpoints: /v3/countries, /v3/countries/{id}
- [Districts](reference/districts.md): 5 endpoints: /v3/districts, /v3/districts/{id}
- [Document Manual Links](reference/document-manual-links.md): 3 endpoints: /v3/documents/{code}/manual-links, /v3/documents/{code}/manual-links/{linkedCode}
- [Settings](reference/settings.md): 1 endpoint: /v3/settings
- [Tags](reference/tags.md): 1 endpoint: /v3/tags

## Other resources

- [Interactive docs](https://edara-api.edara.io/swagger/ui/index)
- [OpenAPI spec](https://edara-api.edara.io/swagger/docs/v3)