Edara API v3: Sales Orders

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

• GET /v3/sales-orders: Lists sales orders.
• GET /v3/sales-orders/{id}: Gets a sales order by id.
• POST /v3/sales-orders: Creates a sales order.
• POST /v3/sales-orders/issued: Creates an issued sales order.
• PUT /v3/sales-orders/header: Updates a sales order header.
• PUT /v3/sales-orders/code/{code}: Updates a sales order by code.
• PATCH /v3/sales-orders/code/{code}/tags: Updates sales order tags by code.
• DELETE /v3/sales-orders/{id}: Deletes a sales order by id.
• PATCH /v3/sales-orders/{id}/cancel: Cancels a sales order by id.
• PATCH /v3/sales-orders/code/{code}/cancel: Cancels a sales order by code.
• PATCH /v3/sales-orders/code/{code}/status: Updates sales order status by code.
• PATCH /v3/sales-orders/code/{code}/unissue: Unissues a sales order by code.
• GET /v3/sales-orders/print-templates: Lists print templates.
• GET /v3/sales-orders/print-templates/{templateId}: Gets a print template by id.
• POST /v3/sales-orders/cash-in: Records a sales order cash-in.

Endpoints

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

Operation GetSalesOrders · permission read:sales-order

• offset is zero-based; limit defaults to 100.
• orderDateFrom and orderDateTo filter on or after / on or before the document date (inclusive bounds).

Query string: GetSalesOrdersQuery

Responses: OK PagedResult<SalesOrderHeaderListResponse>: Paged list of sales orders.

Notes

• onlyMyOrders defaults to true, so by default you get only the orders the calling user created. Set it to false to get orders from all users.
• onlyMyOrders goes by the user who created the order, not by the order's sales person.
• warehouseOnly defaults to true, which leaves out sales store (point of sale) orders. Set it to false to include them.
• You only get orders in warehouses or sales stores that the calling user has data permission for. A user with no such permission gets an empty list, not 403.
• documentCode, salesPersonId, warehouseId, customerId and orderStatus are exact matches. paperNumber is a partial match.
• orderDateFrom and orderDateTo compare the full date and time. An orderDateTo without a time means the start of that day, so send the end of the day to include it.
• createdBy is an exact match on the email of the user who created the order.
• tags takes a comma-separated list and returns orders that have at least one of those tags. Spaces around each tag and blank tags are ignored.
• paymentStatus Unpaid also matches orders that have no payment status.
• An empty documentCode, paperNumber or createdBy is treated as no filter.
• The list can include sales returns that match your filters. Check documentType in the response to tell them apart.
• Results are ordered by id, highest first.
• totalCount counts all orders that match your filters, but it is 0 when the page you asked for is empty, for example past the last page.
• An order whose customer record no longer exists is not returned.
• Each order in the list includes its full details and installments.

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

Operation GetSalesOrderById · permission read:sales-order

Parameters

Responses: OK SalesOrderResponse: The sales order.

Notes

• An id that belongs to a sales return is returned too. In that case the response carries relatedSalesOrderCodes instead of relatedSalesReturnCodes.
• isApproved is always true for an order that requires an automatic issue order. For other orders it shows whether the order has passed all approvals.
• For a sales order, the response also includes the codes of linked sales returns and the paid amount for each related document code.
• The response always includes the order lines and installments. The customer, sales person, warehouse and sales store are returned as reference objects.
• paperNumber falls back to the document number when the order has no paper number.

POST /v3/sales-orders: Creates a sales order.

Operation CreateSalesOrder · permission create:sales-order

Body: SalesOrderRequest

Responses: Created SalesOrderResponse: Sales order created.

Business errors (HTTP 409, match on errorCode):

• BundleNotFound: A referenced bundle was not found.
• CannotAssignInactiveTax: An inactive tax cannot be assigned.
• CannotSetCreditPaymentForCustomersOfTypeCashPayment: Credit installments cannot be used for cash-payment customers.
• CostCenterNotFound: The specified cost center was not found.
• CostCenterNotPermitted: The user is not permitted to use the specified cost center.
• CostCenterRequiredOnSalesDocument: A cost center is required on the document.
• CustomerNotFound: The referenced customer was not found.
• DuplicatedRefenceDocuments: Another document already references the same source document.
• DupplicatedCode: Another sales order already uses the same document code.
• DupplicatedDate: Another sales order already exists with the same document date.
• EdaraBusinessError: A legacy business-rule violation occurred (see message for details).
• EInvoice_Egypt_MissingCustomersAddress: Egypt e-invoicing requires the customer address.
• EInvoice_Egypt_MissingCustomersTaxRegistrationID: Egypt e-invoicing requires the customer tax registration id.
• EInvoice_KSA_AllDetailsMustBeTaxable: KSA e-invoicing requires every detail line to be taxable.
• EInvoice_KSA_BundleDetailsMustHaveSameTaxRate: KSA e-invoicing requires all bundle items to share the same tax rate.
• EInvoice_KSA_MissingShippingDate: KSA e-invoicing requires a shipping date.
• EInvoice_KSA_SalesOrderMustBeTaxable: KSA e-invoicing requires the order to be taxable.
• ExchangeRateDecimalsExceedLimit: The exchange rate exceeds the allowed decimal precision.
• InvalidTaxScopeForItem: The tax scope is not valid for this item.
• InvalidTaxTypeForItem: The tax type is not valid for this item.
• MustSelectValidTaxType: A valid tax type must be selected.
• MustSelectValidWHTaxType: A valid withholding-tax type must be selected.
• NoSystemCurrency: A system currency must be configured before saving the document.
• PreventSaveDocumentsInFutureDate: The document date cannot be in the future.
• PrventStockItemsExceedStoreQuotaLimit: One or more items exceed the sales-store quota limit.
• SerialAlreadyReserved: One or more serials are already reserved on another document.
• SO_PO_TaxHasBeenDeleted: A tax referenced by the order has been deleted.
• TaxNotFound: The specified tax was not found.

Notes

• Send exactly one of warehouseId or salesStoreId. Sending both or neither returns 400.
• A customerId that does not exist returns 400, not 404.
• Each line needs one of stockItemId, serviceItemId or bundleId.
• Line comments cannot contain a comma or a vertical bar.
• A line taxId must point to an existing, active tax. Otherwise the request fails with TaxNotFound or CannotAssignInactiveTax.
• The line price is never looked up from the item. If you omit price, taxRate or itemDiscount, 0 is stored.
• A line with a zero price is rejected unless an organization setting allows zero prices. An order with a zero total is always rejected.
• Depending on organization settings, a price below the item's sales price, minimum price or cost is rejected with EdaraBusinessError. This differs between organizations, so handle the error.
• orderStatus defaults to Open and isApproved defaults to false. A new order always has isIssued false and documentType SO.
• When the organization does not use multiple currencies, the currency you send is ignored and the exchange rate is stored as 1.
• An unknown stock item, service item or unit of measure id is rejected with EdaraBusinessError. So are duplicated stock item lines.
• A duplicate paperNumber is rejected only when an organization setting that prevents duplicate reference documents is on. The error is DuplicatedRefenceDocuments and it includes the code of the existing order.
• externalId must be unique. A request that reuses one returns 400 with a generic message and no errorCode, and no second order is created.
• A retry without externalId creates a second order.
• Line quantities must fit the non-reserved stock balance, otherwise the order is rejected. A created order reserves stock.
• Creating an order does not create an issue order or a cash-in.
• The document number is generated automatically unless you send one.
• The order is saved all or nothing: if any step fails, nothing is stored.
• A document code that already exists is rejected with DupplicatedCode.
• The response is the created order, including its lines and installments.

POST /v3/sales-orders/issued: Creates an issued sales order.

Operation CreateIssuedSalesOrder · permission create:sales-order

• Preserves the legacy issued-create flow; the order is marked issued immediately on insert.
• The request validation matches the standard create endpoint, except that detail quantities are not required to be positive.

Body: SalesOrderRequest

Responses: Created SalesOrderResponse: Sales order created.

Business errors (HTTP 409, match on errorCode):

• BundleNotFound: A referenced bundle was not found.
• CannotAssignInactiveTax: An inactive tax cannot be assigned.
• CannotSetCreditPaymentForCustomersOfTypeCashPayment: Credit installments cannot be used for cash-payment customers.
• CostCenterNotFound: The specified cost center was not found.
• CostCenterNotPermitted: The user is not permitted to use the specified cost center.
• CostCenterRequiredOnSalesDocument: A cost center is required on the document.
• CustomerNotFound: The referenced customer was not found.
• DuplicatedRefenceDocuments: Another document already references the same source document.
• DupplicatedCode: Another sales order already uses the same document code.
• DupplicatedDate: Another sales order already exists with the same document date.
• EdaraBusinessError: A legacy business-rule violation occurred (see message for details).
• EInvoice_Egypt_MissingCustomersAddress: Egypt e-invoicing requires the customer address.
• EInvoice_Egypt_MissingCustomersTaxRegistrationID: Egypt e-invoicing requires the customer tax registration id.
• EInvoice_KSA_AllDetailsMustBeTaxable: KSA e-invoicing requires every detail line to be taxable.
• EInvoice_KSA_BundleDetailsMustHaveSameTaxRate: KSA e-invoicing requires all bundle items to share the same tax rate.
• EInvoice_KSA_MissingShippingDate: KSA e-invoicing requires a shipping date.
• EInvoice_KSA_SalesOrderMustBeTaxable: KSA e-invoicing requires the order to be taxable.
• ExchangeRateDecimalsExceedLimit: The exchange rate exceeds the allowed decimal precision.
• InvalidTaxScopeForItem: The tax scope is not valid for this item.
• InvalidTaxTypeForItem: The tax type is not valid for this item.
• MustSelectValidTaxType: A valid tax type must be selected.
• MustSelectValidWHTaxType: A valid withholding-tax type must be selected.
• NoSystemCurrency: A system currency must be configured before saving the document.
• PreventSaveDocumentsInFutureDate: The document date cannot be in the future.
• PrventStockItemsExceedStoreQuotaLimit: One or more items exceed the sales-store quota limit.
• SerialAlreadyReserved: One or more serials are already reserved on another document.
• SO_PO_TaxHasBeenDeleted: A tax referenced by the order has been deleted.
• TaxNotFound: The specified tax was not found.

Notes

• Validation, defaults and duplicate rules are the same as for creating a sales order. A line quantity of zero or less is rejected.
• An issue order is always created from the stock item lines, whatever the organization's automatic issue setting is. It is saved together with the sales order: if either fails, nothing is stored.
• After the issue order is created, orderStatus is Shipped and issueDate is the current time.
• isIssued is true only when everything ordered on the stock item lines was issued. Check isIssued in the response.
• When an organization setting for selling over stock on automatically issued orders is on, lines are first adjusted to the available stock, so the order can be partially issued.
• An order with only service items gets no issue order. A services invoice is posted instead, and the order is marked as issued with orderStatus Shipped.
• When isWithholdingTax is true and withholdingTax is greater than 0, a withholding tax journal entry is also created.
• No cash-in is created.

PUT /v3/sales-orders/header: Updates a sales order header.

Operation UpdateSalesOrderHeader · permission update:sales-order

Body: SalesOrderRequest

Responses: OK SalesOrderResponse: The updated sales order. · NotFound ProblemDetails: Sales order not found.

Business errors (HTTP 409, match on errorCode):

• EdaraBusinessError: A legacy business-rule violation occurred (see message for details).
• ExchangeRateDecimalsExceedLimit: The exchange rate exceeds the allowed decimal precision.
• NoSystemCurrency: A system currency must be configured before saving the document.
• PhantomRead: The sales order was modified by another user; reload and retry.
• PreventSaveDocumentsInFutureDate: The document date cannot be in the future.

Notes

• The order is identified by id in the request body, not in the URL. An id that does not exist returns 404.
• Despite the PUT method, this is a partial update: a field you omit or send as null keeps its stored value. A blank string also keeps the old value, so you cannot clear a field.
• Tags are the exception: any tag list you send, including an empty one, replaces the whole tag set.
• Only the header changes. Lines and installments are never touched.
• isApproved, externalId, requireAutoWorkorder, shippmentCost and the related work order code and value are accepted but not saved. The request still returns 200, with those values unchanged.
• Concurrent updates are not detected: the last write wins. The PhantomRead error is not returned by this endpoint.
• An exchange rate with more than 4 decimal places is rejected with ExchangeRateDecimalsExceedLimit.
• When the organization does not allow saving documents with a future date, a document date up to 60 seconds ahead (the default tolerance) is changed to the current time. A later date is rejected with PreventSaveDocumentsInFutureDate.
• Setting orderStatus to Cancelled here gives back the sales store's consumed quota and the related customer purchase order's remaining amount, but does not release reserved stock. To cancel an order and recalculate reserved stock, use the cancel endpoints.
• If the order is issued, the update can regenerate its sales invoice number, depending on organization settings.
• The response is read back after the update, so it shows what was actually stored.

PUT /v3/sales-orders/code/{code}: Updates a sales order by code.

Operation UpdateSalesOrderByCode · permission update:sales-order

• When SalesOrderDetails is supplied, the full document (header + details + installments) is replaced.

Parameters

Body: SalesOrderRequest

Responses: OK SalesOrderResponse: The updated sales order. · NotFound ProblemDetails: Sales order not found.

Business errors (HTTP 409, match on errorCode):

• CannotAssignInactiveTax: An inactive tax cannot be assigned.
• CannotDeleteOrderAsItHasRelatedManualDocuments: The order has related manual documents that prevent the update.
• DuplicatedRefenceDocuments: Another document already references the same source document.
• EdaraBusinessError: A legacy business-rule violation occurred (see message for details).
• ExchangeRateDecimalsExceedLimit: The exchange rate exceeds the allowed decimal precision.
• InvalidTaxScopeForItem: The tax scope is not valid for this item.
• InvalidTaxTypeForItem: The tax type is not valid for this item.
• MustSelectValidTaxType: A valid tax type must be selected.
• MustSelectValidWHTaxType: A valid withholding-tax type must be selected.
• NoSystemCurrency: A system currency must be configured before saving the document.
• PhantomRead: The sales order was modified by another user; reload and retry.
• PreventSaveDocumentsInFutureDate: The document date cannot be in the future.
• PrventStockItemsExceedStoreQuotaLimit: One or more items exceed the sales-store quota limit.
• SerialAlreadyReserved: One or more serials are already reserved on another document.
• StockItemAlreadyReturned: A detail line targets an item that has already been returned.
• TaxNotFound: The specified tax was not found.

Notes

• code is trimmed and then matched exactly. An unknown code returns 404.
• Header fields are a partial update, as in the header endpoint: a field you omit or send as null keeps its stored value.
• When salesOrderDetails is omitted or empty, only the header is updated. Lines and installments stay as they are, and reserved stock is not recalculated.
• When salesOrderDetails has lines, it replaces the stored lines: a stored line whose id is not in the request is deleted, and a line without id is added as new. Send every line you want to keep.
• In a full update, a business rule failure returns its specific errorCode when there is one, and EdaraBusinessError otherwise.
• The response is the order read back after the update.

PATCH /v3/sales-orders/code/{code}/tags: Updates sales order tags by code.

Operation UpdateSalesOrderTags · permission update:sales-order

• Supplying an empty array clears all tags.

Parameters

Body: SalesOrderTagsUpdateRequest

Responses: OK SalesOrderResponse: The updated sales order. · NotFound ProblemDetails: Sales order not found.

Business errors (HTTP 409, match on errorCode):

• PhantomRead: The sales order was modified by another user; reload and retry.

Notes

• code is trimmed and matched exactly. An unknown code returns 404, and a request without a body returns 400.
• The tags you send replace the whole tag set. Nothing is merged with the existing tags, and an empty list clears them.
• Tags can be changed whatever the order status is, including on cancelled and issued orders.

DELETE /v3/sales-orders/{id}: Deletes a sales order by id.

Operation DeleteSalesOrder · permission delete:sales-order

Parameters

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

Business errors (HTTP 409, match on errorCode):

• CannotDeleteOrderAsItHasRelatedManualDocuments: The order has related manual accounting documents (CI/NR/SI/JE) that prevent deletion.

Notes

• A successful delete returns 204 with no body. An id that does not exist returns 404.
• The delete is rejected with CannotDeleteOrderAsItHasRelatedManualDocuments when the order has a posted related accounting document, such as a cash-in, sales invoice or journal entry, or related documents that were created manually. The error names the blocking document code.
• The delete is permanent. It also removes the order's lines and installments and the related sales invoice, issue order and cash-in, together with their journal postings.
• Stock reserved by the order is released.
• If the order is still referenced elsewhere, the delete fails with ItemCannotDeleteItInUse.
• The order status is not checked: issued and cancelled orders can be deleted.

PATCH /v3/sales-orders/{id}/cancel: Cancels a sales order by id.

Operation CancelSalesOrderById · permission update:sales-order

Parameters

Responses: OK SalesOrderActionResponse: The cancelled sales order.

Business errors (HTTP 409, match on errorCode):

• CannotDeleteOrderAsItHasRelatedManualDocuments: The order has related manual accounting documents that prevent cancellation.

Notes

• An order whose orderStatus is Processing or Shipped cannot be cancelled: the request returns 409 with SalesOrderIsInProcessingOrShipped.
• Every other status is accepted, including OutForDelivery, Returned and an order that is already Cancelled. Only the status is checked, not whether the order is issued.
• An order with manually created related documents returns 409 with CannotDeleteOrderAsItHasRelatedManualDocuments and the code of the blocking document.
• Cancelling only sets orderStatus to Cancelled. The order is not deleted, and isIssued, the lines and any related sales invoice or issue order stay unchanged.
• Reserved stock is recalculated. When the status really changes to Cancelled, the sales store's consumed quota and the related customer purchase order's remaining amount are given back.
• The response is a short confirmation with the order code, the status Cancelled and the change time in UTC. It is not the full order.

PATCH /v3/sales-orders/code/{code}/cancel: Cancels a sales order by code.

Operation CancelSalesOrderByCode · permission update:sales-order

Parameters

Responses: OK SalesOrderActionResponse: The cancelled sales order. · NotFound ProblemDetails: Sales order not found or not in a cancellable state.

Business errors (HTTP 409, match on errorCode):

• CannotDeleteOrderAsItHasRelatedManualDocuments: The order has related manual accounting documents that prevent cancellation.

Notes

• This works like cancelling by id, except that the order is found by code, which is trimmed and matched exactly.
• The same rules apply: an order whose orderStatus is Processing or Shipped returns 409 with SalesOrderIsInProcessingOrShipped, and a successful cancel has the same effects.

PATCH /v3/sales-orders/code/{code}/status: Updates sales order status by code.

Operation UpdateSalesOrderStatus · permission update:sales-order

• Accepted values: Cancelled, Confirmed, OutForDelivery.

Parameters

Body: UpdateSalesOrderStatusRequest

Responses: OK SalesOrderActionResponse: The updated sales order. · NotFound ProblemDetails: Sales order not found.

Business errors (HTTP 409, match on errorCode):

• ExchangeRateDecimalsExceedLimit: The exchange rate exceeds the allowed decimal precision.

Notes

• Any status value is accepted: Cancelled, Confirmed, Pending, Processing, OutForDelivery, Shipped, Returned or Open.
• Transitions are not validated, so a change such as Shipped to Confirmed or Cancelled to Open is stored as sent. Validate transitions in your own code.
• Only orderStatus changes. isIssued stays as it is, and reserved stock is recalculated.
• Setting Cancelled from another status also gives back the sales store's consumed quota and the related customer purchase order's remaining amount.
• The response is a short confirmation with the order code, the status you sent and the change time in UTC. It is not read back from the stored order.

PATCH /v3/sales-orders/code/{code}/unissue: Unissues a sales order by code.

Operation UnIssueSalesOrderByCode · permission update:sales-order

Parameters

Responses: OK SalesOrderActionResponse: The unissued sales order. · NotFound ProblemDetails: Sales order not found.

Business errors (HTTP 409, match on errorCode):

• PhantomRead: The sales order was modified by another user; reload and retry.

Notes

• code is trimmed and matched exactly. A blank code returns 400 and an unknown code returns 404.
• If the related sales invoice is posted, the request returns 400 with no errorCode. Unpost the invoice first.
• An unposted related sales invoice is deleted. This happens as a separate step before the order is updated, so the invoice stays deleted even if the order update then fails.
• The endpoint does not check that the order is issued or what status it has. It always sets isIssued to false and orderStatus to Confirmed, so a cancelled or shipped order also becomes Confirmed.
• Reserved stock is recalculated.
• The response reports the status as Unissued, but the stored orderStatus is Confirmed.

GET /v3/sales-orders/print-templates: Lists print templates.

Operation GetSalesOrderPrintTemplates · permission print:sales-order

Query string: GetSalesOrderPrintTemplatesQuery

Responses: OK PagedResult<SalesOrderPrintTemplateResponse>: Paged list of print templates.

Notes

• The list always returns sales order templates for the small paper size. You cannot choose another module, page or paper size: the only parameters are offset, limit and updateDate.
• Only templates the calling user has permission for are returned. The others are left out without an error.
• Pre-printed templates are never returned.
• updateDate returns templates created or updated strictly after the value, not on it. A date without a time means the start of that day.
• limit defaults to 100. A value below 1 or above 1000 does not return 400: it is replaced by 100.
• Results are ordered by id.
• An offset past the end returns an empty list and a total count of 0, not the real total.
• Each item includes htmlContent and printTemplateDetails, a list of key and value pairs.
• direction is always ltr in this list. It does not reflect the template's real text direction.

GET /v3/sales-orders/print-templates/{templateId}: Gets a print template by id.

Operation GetSalesOrderPrintTemplateById · permission print:sales-order

Parameters

Responses: OK SalesOrderPrintTemplateResponse: The print template. · NotFound ProblemDetails: Print template not found.

Notes

• A templateId that does not exist or is not an integer returns 404. Zero or a negative value returns 400.
• htmlContent is always null on this endpoint. Use the list endpoint to get a template's HTML.

POST /v3/sales-orders/cash-in: Records a sales order cash-in.

Operation CreateCashInForSalesOrder · permission create:cash-transaction

Body: CashInForSalesOrderRequest

Responses: Created CashTransactionResponse: Cash-in document created. · NotFound ProblemDetails: Related sales order or cash account not found.

Business errors (HTTP 409, match on errorCode):

• CannotInsertDocumentBeforeClosingDate: The document date is before the closing date.
• CK_NoCustomerOrSupplierSelectedforAccount: The selected account requires a linked customer or supplier, but none was provided.
• CK_NocustomerSelectedforAR: The selected receivable account requires a linked customer, but none was provided.
• CK_NoSupplierSelectedforAP: The selected payable account requires a linked supplier, but none was provided.
• CustomerHaveNoRelatedAccount: The selected customer has no related GL account; raised when the journal entry for the cash-in is created (AccDocumentLogic).
• DocumentmainAccountHasNoAlias: The selected main account does not have the cash-account alias required by this document type.
• DupplicatedCode: Another document already uses the same document code.
• DupplicatedDate: Another document already exists with the same document date.
• ExchangeRateDecimalsExceedLimit: The exchange rate has too many decimal places.
• PreventSaveDocumentsInFutureDate: The document date is in the future.
• RelatedSalesOrderCancelled: Occurs when the linked sales order is already canceled, so the payment journal entry cannot be created from it.

Notes

• An unknown cashAccountId or relatedSalesOrderCode returns 404.
• documentDate defaults to the current time. The customer is always taken from the sales order, not from the request.
• The response is 201 with the documentCode of the new cash-in.
• A documentDate in the future is always rejected with PreventSaveDocumentsInFutureDate, whatever the organization's future-date setting is.
• The cash-in creates a journal entry for paidAmount that debits the cash account and credits the customer's related account.
• The customer must have a related accounts receivable account. Otherwise the request fails with CustomerHaveNoRelatedAccount.
• Whether the journal entry is posted immediately or in a batch depends on an organization setting.
• A cancelled sales order is rejected with RelatedSalesOrderCancelled.
• The cash-in is saved all or nothing: if any step fails, nothing is recorded.

Types

AccountReference

Lightweight account reference (id + code + name).

CashTransactionResponse

Response describing a created cash transaction.

CurrencyReference

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

CustomerReference

Lightweight customer reference (id + code + name).

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

InstallmentPaymentType

Payment method for a sales-order installment.

Values (sent/returned as the name): Cash=0, Installments=1

SalesOrderActionResponse

Response describing a sales-order state transition (issue / cancel / un-issue).

SalesOrderDetailRequest

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

SalesOrderDetailResponse

Response describing a sales-order line item.

SalesOrderHeaderListResponse

Response row for the sales-order header listing (one row per sales order).

SalesOrderInstallmentRequest

Request to create or update a sales-order payment installment.

SalesOrderInstallmentResponse

Response describing a sales-order payment installment.

SalesOrderPaymentStatus

Sales-order payment states. Matches Sales.Documents.PaymentStatus exactly: that column, and its CHECK constraint, only ever allow "Unpaid" or "Paid"; there is no third "partially paid" state anywhere in the schema or in a live code path that sets it.

Values (sent/returned as the name): Unpaid=0 (The order has not been marked as paid.), Paid=1 (The order has been marked as paid.)

SalesOrderPrintTemplateDetailResponse

A single key/value pair in a sales-order print template body.

SalesOrderPrintTemplateResponse

Response describing a sales-order print template.

SalesOrderResponse

Response describing a sales order.

SalesOrderStatus

Sales-order lifecycle states.

Values (sent/returned as the name): Cancelled=0, Confirmed=1, Pending=2, Processing=3, OutForDelivery=4, Shipped=5, Returned=6, Open=7

SalesPersonReference

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

SalesStoreReference

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

StockItemReference

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

TaxReference

Lightweight tax reference (id + name + rate).

UnitOfMeasureReference

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

UpdateableSalesOrderStatus

Sales-order statuses that may be set via the status-update endpoint.

Values (sent/returned as the name): Cancelled, Confirmed, OutForDelivery

WarehouseReference

Lightweight warehouse reference (id + code + name).