Edara API v3: Suppliers

Read the guide first: authentication, paging, errors, rate limits and the shared PagedResult, BatchResult and *Reference shapes.

• GET /v3/suppliers: Lists suppliers.
• GET /v3/suppliers/{id}: Gets a supplier by id.
• POST /v3/suppliers: Creates a supplier.
• PUT /v3/suppliers/{id}: Updates a supplier.
• DELETE /v3/suppliers/{id}: Deletes a supplier.

Endpoints

GET /v3/suppliers: Lists suppliers.

Operation GetSuppliers · permission read:supplier

Query string: GetSuppliersQuery

Responses: OK PagedResult<SupplierResponse>: Paged list of suppliers.

Notes

• name is trimmed and matches any part of the supplier name. A blank name applies no filter.
• Inactive suppliers are included.
• Results are ordered by id. A negative offset is treated as 0, and a limit outside 1 to 1000 falls back to 100.
• A supplier linked to several purchase persons appears more than once and takes several places on the page, while totalCount counts each supplier once. Remove duplicates by id, and expect a page to hold fewer distinct suppliers than limit.

GET /v3/suppliers/{id}: Gets a supplier by id.

Operation GetSupplierById · permission read:supplier

Parameters

Responses: OK SupplierResponse: The supplier.

Notes

• Inactive suppliers are returned. An unknown id returns 404.

POST /v3/suppliers: Creates a supplier.

Operation CreateSupplier · permission create:supplier

Body: SupplierCreateRequest

Responses: Created SupplierResponse: Supplier created.

Business errors (HTTP 409, match on errorCode):

• DupplicatedName: Another supplier or related account already uses this name.

Notes

• Send exactly one of relatedAccountId or relatedAccountParentNodeId. Sending both or neither returns 400. An unknown account or node id also returns 400, not 404.
• With relatedAccountParentNodeId, a new accounts payable account is created under that node, named after the supplier, with the next available code. With relatedAccountId, the existing account is linked.
• A supplier name that already exists returns 409 DupplicatedName. With relatedAccountParentNodeId, you get the same error when an account with that name already exists.
• Only the name, mobile, email, and tax registration id are stored. They are trimmed, and blank values are stored as null. The new supplier has no code.

PUT /v3/suppliers/{id}: Updates a supplier.

Operation UpdateSupplier · permission update:supplier

Parameters

Body: SupplierUpdateRequest

Responses: OK SupplierResponse: The updated supplier.

Business errors (HTTP 409, match on errorCode):

• DupplicatedName: Another supplier already uses this name.

Notes

• An unknown id returns 404.
• name, mobile, email, and taxRegisterationId are overwritten on every update. If you omit mobile, email, or taxRegisterationId, the stored value is cleared, not kept.
• Renaming a supplier does not rename its linked account.
• Any uniqueness conflict returns 409 DupplicatedName, even when the conflicting value is not the name.
• The supplier's active status is not changed by this endpoint.

DELETE /v3/suppliers/{id}: Deletes a supplier.

Operation DeleteSupplier · permission delete:supplier

Parameters

Responses: NoContent: (not declared; read from the method body)

Business errors (HTTP 409, match on errorCode):

• ItemCannotDeleteItInUse: The supplier is still referenced by related records.

Notes

• The delete is permanent. An unknown id returns 404.
• Deleting a supplier also deletes its related account when no other supplier uses that account. Otherwise only the link to the account is removed.
• A supplier that is still in use cannot be deleted. The request returns 409 ItemCannotDeleteItInUse, with no details about what uses it.

Types

AccountReference

Lightweight account reference (id + code + name).

SupplierResponse

Response describing a supplier.