Edara API v3: Work Orders

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

• GET /v3/work-orders: Lists work orders.
• GET /v3/work-orders/{id}: Gets a work order by id.
• POST /v3/work-orders/issue-offering: Creates an issue offering.
• POST /v3/work-orders/receive-supplies: Receives work order supplies.
• POST /v3/work-orders/opening-balance: Creates an opening balance.

Endpoints

GET /v3/work-orders: Lists work orders.

Operation GetWorkOrder · permission read:work-order

Query string: GetWorkOrderQuery

Responses: OK PagedResult<WorkOrderResponse>: The paged list of matching work orders.

Notes

• onlyMyOrders defaults to true and also applies when you filter by code or paperNumber, not only when listing. A lookup for a document that another user created returns 200 with no items unless you set onlyMyOrders to false.
• With onlyMyOrders set to true, you only get documents created by the calling user. With false, you get documents created by any user.
• code and paperNumber are trimmed and match exactly.
• The supplier, customer and other-party filters match the exact id. Sending more than one of them returns 400.
• orderDateFrom and orderDateTo are inclusive and compare against the full date and time of the document. An orderDateTo without a time means the start of that day, so send the end of the day to include it.
• The list is not filtered by document type: IO, RS, RR, OB, IT, RT and every other type come back together. Use type in the response to tell them apart.
• Results are ordered by id, descending.
• A page past the end of the list returns totalCount 0.

GET /v3/work-orders/{id}: Gets a work order by id.

Operation GetWorkOrderById · permission read:work-order

Parameters

Responses: OK WorkOrderResponse: The work order.

Notes

• A work order of any type is returned by id. Check type in the response.
• You get 404 when the work order does not exist or has no lines.
• An id lookup also finds archived work orders.

POST /v3/work-orders/issue-offering: Creates an issue offering.

Operation CreateIssueOffering · permission create:work-order

Body: CreateIssueOfferingRequest

Responses: Created WorkOrderResponse: Work order created.

Business errors (HTTP 409, match on errorCode):

• DateMustBeLessThanSystemDate: Date must be less than system date.
• ErrorOrderPaperNoIsMandatory: Order paper number is mandatory.
• ErrorOrderResponsibleIsMandatory: Responsible is mandatory.
• ExchangeRateDecimalsExceedLimit: The exchange rate decimals exceed the limit.
• NoDefaultEvaluationCostMethod: No default evaluation cost method is configured.
• RelatedSODidNotPassPaymentApproval: The related sales order did not pass payment approval.
• SerialsCountExceedQuntity: Entered serials exceed the line quantity.
• msg_DocumentDateCannotbeBeforeRelatedSalesOrderDate: Document date cannot be before the related sales order date.

Notes

• Send exactly one of customerId or otherPartyId. Sending both or neither returns 400.
• Every stockItemId on the lines must exist, otherwise the request returns 400. Inactive stock items are accepted.
• A warehouseId that does not exist returns 500, not 400 or 404.
• code and serial are always generated by Edara, per document type and warehouse. A serial you send is overwritten.
• If you omit exchangeRate, it is saved as 1, even when currencyId is a foreign currency. The current rate is never looked up, so send exchangeRate yourself for a foreign currency.
• If you omit date, the current date and time is used. A future date returns 409 with errorCode DateMustBeLessThanSystemDate.
• The document is saved all or nothing: if any step fails, nothing is saved. When the warehouse is connected to accounting, the related accounting journal entries are created in the same request.
• If the issue would make stock negative, the request returns 409 with errorCode AddingItemQuantityCauseNegativeBalance and names the stock items.
• When relatedSoCode refers to a sales order (the code contains SO), the request fails with SalesOrderAlreadyIssued if that sales order is already issued, or with RelatedSalesOrderCancelled if it is cancelled.
• Work order lines are matched to the sales order lines by exactly the same stock item, quantity and price, so send the same values as on the sales order.
• After a successful issue against a sales order, the sales order status changes to Shipped and its stock reservations are released.
• A relatedSoCode for a sales order that does not exist returns 500.
• There is no duplicate protection. externalId and paperNumber are stored but not checked for duplicates, so a retried request creates a second document.
• AddingItemQuantityCauseNegativeBalance, SalesOrderAlreadyIssued and RelatedSalesOrderCancelled can be returned by this endpoint even though its error list does not include them.
• ErrorOrderPaperNoIsMandatory, ErrorOrderResponsibleIsMandatory, RelatedSODidNotPassPaymentApproval and msg_DocumentDateCannotbeBeforeRelatedSalesOrderDate are never returned by this endpoint.

POST /v3/work-orders/receive-supplies: Receives work order supplies.

Operation CreateReceiveSupplies · permission create:work-order

Body: CreateReceiveSuppliesRequest

Responses: Created WorkOrderResponse: Work order created.

Business errors (HTTP 409, match on errorCode):

• DateMustBeLessThanSystemDate: Date must be less than system date.
• ExchangeRateDecimalsExceedLimit: The exchange rate decimals exceed the limit.
• NoDefaultEvaluationCostMethod: No default evaluation cost method is configured.
• SerialsCountExceedQuntity: Entered serials exceed the line quantity.

Notes

• Send exactly one of supplierId or otherPartyId. Sending both or neither returns 400.
• Every line needs a price greater than 0. A line with no price or a zero price returns 400.
• Every stockItemId on the lines must exist, otherwise the request returns 400.
• If a stock item requires a batch number or an expiry date and a line does not have it, the request returns 400 and lists those lines.
• For a stock item that enforces batch and expiry and fills the batch automatically, a line with expdate gets its batch number replaced by that date in dd/MM/yyyy format, whatever batch number you send.
• If you omit exchangeRate, it is saved as 1, even when currencyId is a foreign currency. Edara looks up the current rate only when you send an exchangeRate of 0 or less.
• Without currencyId, the document is saved with no currency and a rate of 1.
• A warehouseId that does not exist returns 500, not 400 or 404.
• A document created here never marks a purchase order or a supplies request as received.
• linkedDocumentCode can hold several document codes separated by commas. Each one is stored as a separate document link.
• code and serial are always generated by Edara, per document type and warehouse. A serial you send is ignored.
• The document is saved all or nothing: if any step fails, nothing is saved. When the warehouse is connected to accounting, the related accounting documents are created in the same request.
• There is no duplicate protection, so a retried request creates a second document.

POST /v3/work-orders/opening-balance: Creates an opening balance.

Operation CreateOpeningBalance · permission create:work-order

Body: WorkOrderUpsertRequest

Responses: Created WorkOrderResponse: Opening balance created.

Business errors (HTTP 409, match on errorCode):

• AllDetailsAreDeleted: All opening balance details have been marked as deleted.
• Error_OB_StockItemDuplication: An opening balance cannot contain duplicate stock items.
• OB_GroupingItemsNotAllowed: Grouping items are not allowed in an opening balance.
• OnlyOneOpeningBalanceAllowedPerWarehouse: Only one opening balance is allowed per warehouse.
• PreventModifyOpeningCostAfterClosingJE: The opening cost cannot be modified after the closing journal entry.
• QuantityMustHaveValue: Quantity must have a value.

Notes

• date must not be after today, and the check compares it with the start of today. Today's date with a time of day is therefore rejected with 400, so send a date without a time.
• If you omit date, it is saved as today at 00:00.
• A request can carry from 1 to 5000 lines. Outside that range it returns 400.
• Every stockItemId on the lines must exist, otherwise the request returns 400.
• Stock items that use batch tracking (automatic batch numbers, enforced batch or enforced expiry) are not allowed and return 400.
• unitOfMeasure, when sent, must be one of the stock item's primary units of measure, otherwise the request returns 400.
• A warehouseId that does not exist returns 404. Inactive warehouses are accepted.
• Only stockItemId, quantity, unitPrice, comments and unitOfMeasure are read from each line. price, batch and serial fields are ignored, so use unitPrice, not price. The unit conversion ratio is always saved as 1.
• If a closing journal entry already exists, the request returns 409 with errorCode PreventModifyOpeningCostAfterClosingJE.
• A warehouse can have only one opening balance. A second one returns 409 with errorCode OnlyOneOpeningBalanceAllowedPerWarehouse.
• Grouping items return 409 with errorCode OB_GroupingItemsNotAllowed.
• The same stock item on more than one line returns 409 with errorCode Error_OB_StockItemDuplication.
• AllDetailsAreDeleted and QuantityMustHaveValue are never returned here: an empty line list or a quantity of 0 or less returns 400 first.
• The customer, supplier and currency fields, relatedSoCode and destinationWarehouseId have no effect on an opening balance: they are ignored or not used to link documents.

Types

CurrencyReference

Lightweight currency reference (id + ISO code + name).

CustomerReference

Lightweight customer reference (id + code + name).

DocumentRowState

Row-state for mutable document detail lines.

Values (sent/returned as the name): Added=0, Modified=1, Deleted=2

DocumentType

Document type codes shared across sales, purchase, and warehouse domains.

Values (sent/returned as the name): RS, RR, RT, IO, IR, IT, TR, CI, CO, JE, SI, PI, CN, DN, NR, NP, SO, SR, RecSO, PO, PR, OB, RMA

SalesPersonReference

Lightweight sales-person reference (id + code + name).

StockItemReference

Lightweight stock-item reference (id + code + description).

SupplierReference

Lightweight supplier reference (id + code + name).

UnitOfMeasureReference

Lightweight unit-of-measure reference (id + name).

WarehouseReference

Lightweight warehouse reference (id + code + name).

WorkOrderItemResponse

Response describing a work-order line item.

WorkOrderItemUpsertRequest

Request to create or update a work-order line item.

WorkOrderResponse

Response describing a work order (Issue Offering, Receive Supplies, Receive Returns, or Opening Balance).

WorkOrderStatus

Work-order status values for the v3 API contract.

Values (sent/returned as the name): Pending=0, Accepted=1, Released=2, Rejected=3