🔒 Update production V3

patch

https://{xentralId}.xentral.biz/api/v3/productions/{id}

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: production:update.

Update a production. Only the properties sent are changed. A different produceProduct replaces all line items from its bill of materials, a different produceQuantity scales them; both only while the production is a draft or released and none of its goods are booked into stock. Once a production has started it is write-protected: productionStartDate, productionEndDate, stockRetrievalDate and stockProvisioningDate can still be changed, any other change is rejected with a conflict.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

address

object

The customer the production is for. Changing it also sets the project and the preferred warehouse the new customer brings, unless they are sent in the same request.

project

object

salesOrder

The sales order the production is made for. Set to null to detach the production from its sales order.

preferredWarehouse

object | null

The warehouse the production takes its materials from and books the produced goods into. When the customer changes and this is omitted, it is set to the production warehouse of the new project. Set to null to remove it.

produceProduct

object

The product this production produces. Changing it replaces all line items: the materials are resolved anew from the bill of materials of the new product, so materials adjusted on this production are lost. Only possible while the production is a draft or released and none of its goods are booked into stock. Without produceQuantity the current quantity is kept.

produceQuantity

float

≤ 9999999999.9999

Quantity of the product to produce. Changing it scales the produced line and every material by the same factor, so materials adjusted on this production keep their proportion. At most four decimal places. Only possible while the production is a draft or released and none of its goods are booked into stock.

documentDate

date

Document creation date

productionStartDate

date | null

Production start date. Can still be changed after the production has started. Set to null to remove it.

productionEndDate

date | null

Production end date. Can still be changed after the production has started. Set to null to remove it.

stockRetrievalDate

date | null

Stock retrieval date. Can still be changed after the production has started. Set to null to remove it.

stockProvisioningDate

date | null

Stock provisioning date. Can still be changed after the production has started. Set to null to remove it.

batch

string | null

Batch number for the goods this production produces. Used when the production is completed, unless the completion gives a different one, and only booked into batch stock if the produced product is managed in batches. Set to null to remove it.

bestBeforeDate

date | null

Best-before date for the goods this production produces. Used when the production is completed, unless the completion gives a different one, and only booked if the produced product carries a best-before date. Set to null to remove it.

bodyText

string | null

Body text for production notes. Set to null to remove it.

internalDesignation

string | null

Internal designation for production. Set to null to remove it.

internalComment

string | null

Internal comment for production. Set to null to remove it.

functionTest

boolean

Whether function testing is required

createSerialNumbers

boolean

Whether to create serial numbers

recordSubSerialNumbers

boolean

Whether to record sub-serial numbers

materialReservation

string

enum

Material reservation method

Allowed:

materialRetrieval

string

enum

Material retrieval method

Allowed:

printSettings

object

Print settings for the production

resolveMultiLevelBOM

boolean

Whether to resolve multi-level bill of materials

400Failed validation

409Problem occurred

429Too Many Requests