Production APIs
Create new production work order
| HTTP method | POST |
| URI | https://api.rambase.net/production/work-orders |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4856, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>RequestedCompletionDate
Required/mandatory field
The requested date of completion for the production work order.
>{Date}</RequestedCompletionDate>Quantity
Required/mandatory field
The quantity that will be (or has been) produced
Minimum value: 0
>{Decimal}</Quantity>ManufacturingArea
This field is optional.
>ManufacturingAreaId
Manufacturing area identifier
Minimum value: 100000
This field is optional.
>{Integer}</ManufacturingAreaId>Location
The location of the production.
This field is optional.
>ShortName
Unique abbreviation/short name of the location
This field is optional.
>{String}</ShortName>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"RequestedCompletionDate
Required/mandatory field
The requested date of completion for the production work order.
": "{Date}",Quantity
Required/mandatory field
The quantity that will be (or has been) produced
Minimum value: 0
": "{Decimal}",ManufacturingArea
This field is optional.
": {ManufacturingAreaId
Manufacturing area identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Location
The location of the production.
This field is optional.
": {ShortName
Unique abbreviation/short name of the location
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>Status
Status of production work order
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>RegistrationDate
Date of registration
>{Date}</RegistrationDate>CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
>{String}</CustomersReferenceNumber>NetWeight
The net weight of object (excluding packing meterial) in kilograms
>{Decimal}</NetWeight>RequestedCompletionDate
The requested date of completion for the production work order.
>{Date}</RequestedCompletionDate>ConfirmedCompletionDate
The confirmed date of completion for the production work order
>{Date}</ConfirmedCompletionDate>IsConfirmedCompletionDateLocked
If true, confirmed delivery date is locked.
>{Boolean}</IsConfirmedCompletionDateLocked>ProductRevision
Product revision used for this production work order
>{String}</ProductRevision>Quantity
The quantity that will be (or has been) produced
>{Decimal}</Quantity>ScheduledStartDate
Scheduled/planned date of production start
>{Date}</ScheduledStartDate>ScheduledCompletionDate
Scheduled/planned date of production completion
>{Date}</ScheduledCompletionDate>EstimatedStartDate
Production work order estimated start date
>{Date}</EstimatedStartDate>RemainingQuantity
Remaining number of units to produce
>{Decimal}</RemainingQuantity>PotentialProductionQuantity
Number of products possible to produce with the current stock.
>{Decimal}</PotentialProductionQuantity>HasMaterialShortage
True if production has supply shortage (negative metarial trend)
>{Boolean}</HasMaterialShortage>MaterialDelayedDays
Number of days that material for the PWO is delayed.
>{Integer}</MaterialDelayedDays>IsBlockedForPurchase
True if materials in this production work order should not be purchased
>{Boolean}</IsBlockedForPurchase>HasPriority
Production Work Order priority
>{Boolean}</HasPriority>IsRework
Is Pwroduction Work Order a rework production
>{Boolean}</IsRework>CustomersReference
Customer reference
>{String}</CustomersReference>LatestStartAt
Latest possibile date of starting production
>{Datetime}</LatestStartAt>AvailableQuantity
The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned.
>{Decimal}</AvailableQuantity>AvailableQuantityInPercent
Remaining production available percent
>{Decimal}</AvailableQuantityInPercent>HasProcessRunning
Is Production Work Order is beeing currenlty processed by internal process
>{Boolean}</HasProcessRunning>IsInFaultyState
A flag to indicate if production work order is in faulty state (the work on the document should not be continueed until production work order got corrected)
>{Boolean}</IsInFaultyState>NeedsMaterialReplacementToRelease
Has replace before production material
>{Boolean}</NeedsMaterialReplacementToRelease>IsManufacturedInBatches
Is Production Work Order is batch type production
>{Boolean}</IsManufacturedInBatches>IsBlockedForProduction
Is Production Work Order blocked for production
>{Boolean}</IsBlockedForProduction>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>HasStandardStructure
Production Work Order has customers structure
>{Boolean}</HasStandardStructure>ManufacturedProductName
Name of production work order item
>{String}</ManufacturedProductName>PlanningCategory
Planning category
Possible domain values can be found here
>{String}</PlanningCategory>ProductUnitMarkingSpecification
Describes how to mark the product unit
>{String}</ProductUnitMarkingSpecification>IsOnHold
Flag to indicate if production work order is on hold
>{Boolean}</IsOnHold>OnHoldAt
Date of putting production work order on hold
>{Datetime}</OnHoldAt>OnHoldTo
Date and time production work order should be on hold to
>{Datetime}</OnHoldTo>Category
A category of production work order on hold reason
Possible domain values can be found here
>{Integer}</Category>CausedBy
A side responsible for causing production work order on hold
Possible domain values can be found here
>{String}</CausedBy>Reason
Reason of putting production work order on hold
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Database
Database of the object
>{String}</Database>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>CustomerLink
Customer reference
>{String}</CustomerLink>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>ConfirmedDeliveryDate
Confirmation date from linked order
>{Date}</ConfirmedDeliveryDate>Location
The location of the production.
>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>MeasurementUnitId
Material unit reference
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the item. If not specified, the description is by default copied from the product.
>{String}</Description>CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
>{String}</CountryOfOriginCode>CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField1>CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
>{String}</CustomField2>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ProductClassificationId
Product classification identifier
>{String}</ProductClassificationId>ProductClassificationLink
Product classification reference
>{String}</ProductClassificationLink>ProductLink
Product reference
>{String}</ProductLink>GrossPrice
Production Work Order article price
>{Decimal}</GrossPrice>Currency
Production Work Order article prices currency
>{String}</Currency>ProductStructureId
Product structure reference
>{Integer}</ProductStructureId>ProductStructureLink
Product structure reference
>{String}</ProductStructureLink>FinanceProjectId
Finance project identifier
>{Integer}</FinanceProjectId>FinanceProjectLink
Finance project reference
>{String}</FinanceProjectLink>SalesDeliveryProjectId
Sales delivery project identifier
>{Integer}</SalesDeliveryProjectId>Name
Name of sales delivery
>{String}</Name>SalesDeliveryProjectLink
Sales delivery project reference
>{String}</SalesDeliveryProjectLink>DepartmentId
Department identifier
>{Integer}</DepartmentId>DepartmentLink
Finance department reference
>{String}</DepartmentLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>InitialWorkOrder
Initial Production Work Order that current work order originated from
>ProductionWorkOrderId
Production work order identifier
>{Integer}</ProductionWorkOrderId>ProductionWorkOrderLink
Production work order reference
>{String}</ProductionWorkOrderLink>ForwardedFrom
The preceding/previous/source item.
>ForwardedQuantity
The quantity forwarded to this item.
>{Decimal}</ForwardedQuantity>ItemId
Identifier of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>IsScrapped
True, if element is being scrapped.
>{Boolean}</IsScrapped>OpenForwardedQuantity
When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
>{Decimal}</OpenForwardedQuantity>Item
Item this item was forwarded to.
>ItemId
Identifier of the object
>{Integer}</ItemId>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemLink
API reference to the item
>{String}</ItemLink>ManufacturingAreaId
Manufacturing area identifier
>{Integer}</ManufacturingAreaId>Name
Name of manufacturing area
>{String}</Name>ManufacturingAreaLink
Manufacturing area reference
>{String}</ManufacturingAreaLink>HasCostOverrun
Flag to indicate if product structure's operation has got cost deviation
>{Boolean}</HasCostOverrun>HasTimeOverrun
Flag to indicate if product structure's operation has got worklog deviation
>{Boolean}</HasTimeOverrun>ProjectLeader
Reference to the employee who is a production management project leader.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>DocumentController
Reference to the employee who is a production management document controller.
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProductionWorkOrderId
Production work order identifier
": "{Integer}",Status
Status of production work order
Possible domain values can be found here
": "{Integer}",Type
Type of production work order
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",RegistrationDate
Date of registration
": "{Date}",CustomersReferenceNumber
Customers order reference. If the production work order is derived from a sales order, the customers order reference will be the same as in the sales order. Typically a reference to an external system.
": "{String}",NetWeight
The net weight of object (excluding packing meterial) in kilograms
": "{Decimal}",RequestedCompletionDate
The requested date of completion for the production work order.
": "{Date}",ConfirmedCompletionDate
The confirmed date of completion for the production work order
": "{Date}",IsConfirmedCompletionDateLocked
If true, confirmed delivery date is locked.
": "{Boolean}",ProductRevision
Product revision used for this production work order
": "{String}",Quantity
The quantity that will be (or has been) produced
": "{Decimal}",ScheduledStartDate
Scheduled/planned date of production start
": "{Date}",ScheduledCompletionDate
Scheduled/planned date of production completion
": "{Date}",EstimatedStartDate
Production work order estimated start date
": "{Date}",RemainingQuantity
Remaining number of units to produce
": "{Decimal}",PotentialProductionQuantity
Number of products possible to produce with the current stock.
": "{Decimal}",HasMaterialShortage
True if production has supply shortage (negative metarial trend)
": "{Boolean}",MaterialDelayedDays
Number of days that material for the PWO is delayed.
": "{Integer}",IsBlockedForPurchase
True if materials in this production work order should not be purchased
": "{Boolean}",HasPriority
Production Work Order priority
": "{Boolean}",IsRework
Is Pwroduction Work Order a rework production
": "{Boolean}",CustomersReference
Customer reference
": "{String}",LatestStartAt
Latest possibile date of starting production
": "{Datetime}",AvailableQuantity
The available quantity to be assigned. The available quantitiy will be decresed with the quantities assigned.
": "{Decimal}",AvailableQuantityInPercent
Remaining production available percent
": "{Decimal}",HasProcessRunning
Is Production Work Order is beeing currenlty processed by internal process
": "{Boolean}",IsInFaultyState
A flag to indicate if production work order is in faulty state (the work on the document should not be continueed until production work order got corrected)
": "{Boolean}",NeedsMaterialReplacementToRelease
Has replace before production material
": "{Boolean}",IsManufacturedInBatches
Is Production Work Order is batch type production
": "{Boolean}",IsBlockedForProduction
Is Production Work Order blocked for production
": "{Boolean}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",HasStandardStructure
Production Work Order has customers structure
": "{Boolean}",ManufacturedProductName
Name of production work order item
": "{String}",PlanningCategory
Planning category
Possible domain values can be found here
": "{String}",ProductUnitMarkingSpecification
Describes how to mark the product unit
": "{String}",IsOnHold
Flag to indicate if production work order is on hold
": "{Boolean}",OnHoldAt
Date of putting production work order on hold
": "{Datetime}",OnHoldTo
Date and time production work order should be on hold to
": "{Datetime}",Category
A category of production work order on hold reason
Possible domain values can be found here
": "{Integer}",CausedBy
A side responsible for causing production work order on hold
Possible domain values can be found here
": "{String}",Reason
Reason of putting production work order on hold
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Database
Database of the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",CustomerLink
Customer reference
": "{String}"ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}",ConfirmedDeliveryDate
Confirmation date from linked order
": "{Date}"Location
The location of the production.
": {ShortName
Unique abbreviation/short name of the location
": "{String}"MeasurementUnitId
Material unit reference
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
": "{String}",CustomField1
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",CustomField2
Custom field for grouping, sorting, categorizing and other purposes.
": "{String}",Weight
The weight of the product in kilograms.
": "{Decimal}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"ProductClassificationId
Product classification identifier
": "{String}",ProductClassificationLink
Product classification reference
": "{String}"ProductLink
Product reference
": "{String}"GrossPrice
Production Work Order article price
": "{Decimal}",Currency
Production Work Order article prices currency
": "{String}"ProductStructureId
Product structure reference
": "{Integer}",ProductStructureLink
Product structure reference
": "{String}"FinanceProjectId
Finance project identifier
": "{Integer}",FinanceProjectLink
Finance project reference
": "{String}",SalesDeliveryProjectId
Sales delivery project identifier
": "{Integer}",Name
Name of sales delivery
": "{String}",SalesDeliveryProjectLink
Sales delivery project reference
": "{String}"DepartmentId
Department identifier
": "{Integer}",DepartmentLink
Finance department reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"InitialWorkOrder
Initial Production Work Order that current work order originated from
": {ProductionWorkOrderId
Production work order identifier
": "{Integer}",ProductionWorkOrderLink
Production work order reference
": "{String}"ForwardedFrom
The preceding/previous/source item.
": {ForwardedQuantity
The quantity forwarded to this item.
": "{Decimal}",ItemId
Identifier of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"ItemLink
API reference to the item
": "{String}"IsScrapped
True, if element is being scrapped.
": "{Boolean}",Reason
Reason for scrapping
Possible domain values can be found here
": "{Integer}",OpenForwardedQuantity
When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.
": "{Decimal}",ItemId
Identifier of the object
": "{Integer}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"ItemLink
API reference to the item
": "{String}"ManufacturingAreaId
Manufacturing area identifier
": "{Integer}",Name
Name of manufacturing area
": "{String}",ManufacturingAreaLink
Manufacturing area reference
": "{String}",HasCostOverrun
Flag to indicate if product structure's operation has got cost deviation
": "{Boolean}",HasTimeOverrun
Flag to indicate if product structure's operation has got worklog deviation
": "{Boolean}"ProjectLeader
Reference to the employee who is a production management project leader.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"DocumentController
Reference to the employee who is a production management document controller.
": {EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 105142 HTTP 404 | Project order item was not found |
| Error 103758 HTTP 400 | It is not allowed to reduce quantity when the source document has a reserved quantity |
| Error 103767 HTTP 400 | An item that has a product without assignments can't have a reserved quantity |
| Error 103243 HTTP 400 | Reserved quantity can not be negative. |
| Error 103682 HTTP 400 | The purchase order response item needs to be registered (status higher than 1) before quantity can be reserved. |
| Error 103849 HTTP 400 | Reserved quantity can not exceed remaining quantity. |
| Error 103244 HTTP 400 | Reserved quantity can not exceed available quantity. |
| Error 106477 HTTP 400 | Project order identifier is not defined |
| Error 106478 HTTP 400 | Project order item identifier is not defined |
| Error 108107 HTTP 400 | Linking is allowed only for registered (status 4) and paused (status 5) project order items |
| Error 108104 HTTP 400 | Linking is allowed only for project order items with category 'Expenses' |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |