Skip to main content

MRP APIs

More about MRP API

Deskera - MRP Service

MRP service APIs.

delivery-schedule-controller

Delivery Schedule Controller

/v1/mrp/deliveryschedule

GET

Summary

Get delivery schedule.

Description

API to get delivery schedule for given delivery schedule id.

Parameters
NameLocated inDescriptionRequiredSchema
documentCodequerydocumentCodeYesstring
documentTypequerydocumentTypeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Delivery schedule have been fetched successfully.ResponseEntity
401Unauthorized
403Forbidden
404Delivery schedule with id not found.
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Create new delivery schedule.

Description

API to create new delivery schedule.

Parameters
NameLocated inDescriptionRequiredSchema
deliveryScheduleRequestbodydeliveryScheduleRequestYesDeliveryScheduleRequest
Responses
CodeDescriptionSchema
200OKDeliveryScheduleResponse
201Delivery schedule has been created successfully.DeliveryScheduleResponse
400Delivery schedule creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete delivery schedule.

Description

API to delete existing delivery schedule.

Parameters
NameLocated inDescriptionRequiredSchema
deliveryScheduleIdsbodydeliveryScheduleIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Delivery schedule has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Delivery schedule with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/deliveryschedule/search

GET

Summary

Search delivery schedule.

Description

API to search existing delivery schedule.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Delivery schedule have been fetched successfully.Page«DeliveryScheduleResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/deliveryschedule/{id}

GET

Summary

Get delivery schedule.

Description

API to get delivery schedule for given delivery schedule id.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Delivery schedule have been fetched successfully.ResponseEntity
401Unauthorized
403Forbidden
404Delivery schedule with id not found.
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update existing delivery schedule.

Description

API to update existing delivery schedule.

Parameters
NameLocated inDescriptionRequiredSchema
deliveryScheduleRequestbodydeliveryScheduleRequestYesDeliveryScheduleRequest
idpathidYeslong
Responses
CodeDescriptionSchema
200Delivery schedule has been updated successfully.DeliveryScheduleResponse
201Created
401Unauthorized
403Forbidden
404Delivery schedule with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/deliveryschedule/{id}/wo/productioninfo

GET

Summary

Get delivery schedule work order production info.

Description

API to get delivery schedule work order production info for given delivery schedule id.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Delivery schedule work order production info have been fetched successfully.ResponseEntity
401Unauthorized
403Forbidden
404Delivery schedule with id not found.
Security
Security SchemaScopes
Authorizationglobal

forecast-controller

Forecast Controller

/v1/mrp/forecast

POST

Summary

Create new forecast.

Description

API to create new forecast.

Parameters
NameLocated inDescriptionRequiredSchema
forecastRequestbodyforecastRequestYesForecastRequest
Responses
CodeDescriptionSchema
200OKForecastResponse
201Forecast has been created successfully.ForecastResponse
400Forecast creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Forecast.

Description

API to delete existing forecast.

Parameters
NameLocated inDescriptionRequiredSchema
forecastIdsbodyforecastIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Forecast has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Forecast with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/forecast/forecastdetails

GET

Summary

getProductForecastDetails

Parameters
NameLocated inDescriptionRequiredSchema
forecastIdqueryforecastIdYeslong
Responses
CodeDescriptionSchema
200OK[ ProductForecastDetailsDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/forecast/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters
NameLocated inDescriptionRequiredSchema
productCodesbodyproductCodesYes[ string ]
Responses
CodeDescriptionSchema
200Product information has been fetched successfully.string
201Created
401Unauthorized
403Forbidden
404Products not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/forecast/saveforecastdetails

POST

Summary

Create new forecast.

Description

API to create new forecast.

Parameters
NameLocated inDescriptionRequiredSchema
forecastRequestbodyforecastRequestYes[ ProductForecastDetailsDto ]
Responses
CodeDescriptionSchema
200OKForecastResponse
201Forecast has been created successfully.ForecastResponse
400Forecast creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/forecast/search

GET

Summary

Search Forecast.

Description

API to search existing forecast.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Forecast have been fetched successfully.Page«ForecastResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/forecast/{id}

GET

Summary

Get Forecast.

Description

API to get forecast for given forecast id.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescriptionSchema
200OKResponseEntity
204Forecast have been fetched successfully.ResponseEntity
401Unauthorized
403Forbidden
404Forecast with id not found.
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update existing forecast.

Description

API to update existing forecast.

Parameters
NameLocated inDescriptionRequiredSchema
forecastRequestbodyforecastRequestYesForecastRequest
idpathidYeslong
Responses
CodeDescriptionSchema
200Forecast has been updated successfully.ForecastResponse
201Created
401Unauthorized
403Forbidden
404Forecast with id not found.
Security
Security SchemaScopes
Authorizationglobal

job-card-controller

Job Card APIs

/v1/mrp/jobcard

POST

Summary

Create new job card.

Description

API to create new job card.

Parameters
NameLocated inDescriptionRequiredSchema
jobCardRequestbodyjobCardRequestYesJobCardRequest
Responses
CodeDescriptionSchema
200OKJobCardResponse
201Job Card has been created successfully.JobCardResponse
400Job Card creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Job Card.

Description

API to delete existing Job Card.

Parameters
NameLocated inDescriptionRequiredSchema
jobCardIdbodyjobCardIdYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Job Card has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Job Card has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/jobcard/bulk

POST

Summary

Create multiple job card

Description

API to create job card.

Parameters
NameLocated inDescriptionRequiredSchema
jobCardRequestsbodyjobCardRequestsYes[ JobCardRequest ]
Responses
CodeDescriptionSchema
200OKJobCardResponse
201Job Card has been created successfully.JobCardResponse
400Job Card could not be created due to insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/jobcard/search

GET

Summary

Search Job Card.

Description

API to search existing Job Card.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Job Card have been fetched successfully.Page«JobCardResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/jobcard/updatestatus/{status}

PUT

Summary

Update Job Card status

Description

API to Update Job Card status

Parameters
NameLocated inDescriptionRequiredSchema
jobCardCodesbodyjobCardCodesYes[ string ]
statuspathstatusYesstring
Responses
CodeDescription
200OK
201Created
204job card has been updated successfully.
401Unauthorized
403Forbidden
404Job card with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/jobcard/workorder/{code}

GET

Summary

Search Job Card by work order

Description

API to search existing Job Card with work order code.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Job Card have been fetched successfully.[ JobCardResponse ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/jobcard/{id}

PUT

Summary

Update existing job card.

Description

API to update existing job card.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
jobCardRequestbodyjobCardRequestYesJobCardRequest
Responses
CodeDescriptionSchema
200job card has been updated successfully.JobCardResponse
201Created
401Unauthorized
403Forbidden
404job card with id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update job card attributes.

Description

API to update attributes of existing job card.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
jobCardRequestbodyjobCardRequestYesobject
Responses
CodeDescriptionSchema
200JC attributes has been updated successfully.JobCardResponse
204No Content
401Unauthorized
403Forbidden
404Job card with id not found.
Security
Security SchemaScopes
Authorizationglobal

mrp-master-data-controller

MRP Masters APIs

/v1/mrp/master/holidaylist

POST

Summary

Create Holiday list.

Description

API to create new Holiday list.

Parameters
NameLocated inDescriptionRequiredSchema
holidayListDtobodyholidayListDtoYesHolidayListDto
Responses
CodeDescriptionSchema
200OKHolidayListDto
201Holiday list has been created successfully.HolidayListDto
400Holiday list creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/holidaylist/all

GET

Summary

Get holiday list details.

Description

API to get All holiday list details.

Responses
CodeDescriptionSchema
200Holiday list details have been fetched successfully.HolidayListDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/holidaylist/holiday-ids

POST

Summary

Get holiday list details.

Description

API to get holiday list details for given holiday list ids.

Parameters
NameLocated inDescriptionRequiredSchema
holidayListIdsbodyholidayListIdsYes[ long ]
Responses
CodeDescriptionSchema
200Holiday list details have been fetched successfully.HolidayListDto
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/holidaylist/search

GET

Summary

Search Holiday list.

Description

API to search existing holiday list.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Holiday list have been fetched successfully.Page«HolidayListDto»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/holidaylist/{id}

PUT

Summary

Update holiday list.

Description

API to update existing holiday list.

Parameters
NameLocated inDescriptionRequiredSchema
holidayListDtobodyholidayListDtoYesHolidayListDto
idpathidYeslong
Responses
CodeDescriptionSchema
200Holiday list has been updated successfully.HolidayListDto
201Created
401Unauthorized
403Forbidden
404Holiday list with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete holiday list

Description

Api to delete holiday list

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescription
200OK
204Holiday list has been deleted successfully.
401Unauthorized
403Forbidden
404Holiday list with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters
NameLocated inDescriptionRequiredSchema
productCodesbodyproductCodesYes[ string ]
Responses
CodeDescriptionSchema
200Product information has been fetched successfully.[ LinkedDocumentsDto ]
201Created
401Unauthorized
403Forbidden
404Products not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/workstation

POST

Summary

Create Workstation.

Description

API to create new Workstation.

Parameters
NameLocated inDescriptionRequiredSchema
workstationDtobodyworkstationDtoYesWorkstationDto
Responses
CodeDescriptionSchema
200OKWorkstationDto
201Workstation has been created successfully.WorkstationDto
400Workstation creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/workstation/import

POST

Summary

Import Workstations

Description

API to import workstations.

Parameters
NameLocated inDescriptionRequiredSchema
workstationDtosbodyworkstationDtosYes[ WorkstationDto ]
Responses
CodeDescriptionSchema
200OK[ WorkstationDto ]
201Workstations have been imported successfully.[ WorkstationDto ]
400Workstation import failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/workstation/search

GET

Summary

Search Workstations.

Description

API to search existing Workstations.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Workstations have been fetched successfully.Page«WorkstationDto»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/master/workstation/{id}

PUT

Summary

Update workstation.

Description

API to update existing workstation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
workstationDtobodyworkstationDtoYesWorkstationDto
Responses
CodeDescriptionSchema
200Workstation has been updated successfully.WorkstationDto
201Created
401Unauthorized
403Forbidden
404Workstation with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete workstation

Description

Api to delete workstation

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
Responses
CodeDescription
200OK
204Workstation has been deleted successfully.
401Unauthorized
403Forbidden
404Workstation with id not found.
Security
Security SchemaScopes
Authorizationglobal

operation-controller

Operation APIs

/v1/mrp/operation

POST

Summary

Create new operation.

Description

API to create new operation.

Parameters
NameLocated inDescriptionRequiredSchema
operationRequestbodyoperationRequestYesOperationRequest
Responses
CodeDescriptionSchema
200OKProductResponse
201Operation has been created successfully.ProductResponse
400Operation creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete product.

Description

API to delete existing operation.

Parameters
NameLocated inDescriptionRequiredSchema
operationIdsbodyoperationIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Operation has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Operation has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operation/ids

POST

Summary

Get operation details.

Description

API to get operation details for given operation ids.

Parameters
NameLocated inDescriptionRequiredSchema
idsbodyidsYes[ long ]
Responses
CodeDescriptionSchema
200Operation details have been fetched successfully.OperationResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operation/search

GET

Summary

Search Operations.

Description

API to search existing Operations.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Operations have been fetched successfully.Page«OperationResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operation/{id}

PUT

Summary

Update existing operation.

Description

API to update existing operation.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
operationRequestbodyoperationRequestYesOperationRequest
Responses
CodeDescriptionSchema
200Operation has been updated successfully.OperationResponse
201Created
401Unauthorized
403Forbidden
404Operation with id not found.
Security
Security SchemaScopes
Authorizationglobal

operator-controller

Operator APIs

/v1/mrp/operator

POST

Summary

Create new operator.

Description

API to create new operator.

Parameters
NameLocated inDescriptionRequiredSchema
operatorRequestbodyoperatorRequestYesOperatorRequest
Responses
CodeDescriptionSchema
200OKOperatorResponse
201Operator has been created successfully.OperatorResponse
400Operator creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete operator.

Description

API to delete existing operator.

Parameters
NameLocated inDescriptionRequiredSchema
operatorIdsbodyoperatorIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Operator has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Operator has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operator/ids

POST

Summary

Get operator details.

Description

API to get operator details for given operator ids.

Parameters
NameLocated inDescriptionRequiredSchema
idsbodyidsYes[ long ]
Responses
CodeDescriptionSchema
200Operator details have been fetched successfully.OperatorResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operator/import

POST

Summary

Import operators

Description

API to import operators.

Parameters
NameLocated inDescriptionRequiredSchema
operatorRequestbodyoperatorRequestYes[ OperatorRequest ]
Responses
CodeDescriptionSchema
200OK[ OperatorResponse ]
201Operator have been imported successfully.[ OperatorResponse ]
400Operator import failed.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operator/search

GET

Summary

Search Operators.

Description

API to search existing Operators.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Operators have been fetched successfully.Page«OperatorResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operator/worker-ids

POST

Summary

Get operator details.

Description

API to get operator details for given worker ids.

Parameters
NameLocated inDescriptionRequiredSchema
workerIdsbodyworkerIdsYes[ string ]
Responses
CodeDescriptionSchema
200Operator details have been fetched successfully.OperatorResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/operator/{id}

PUT

Summary

Update existing operator.

Description

API to update existing operator.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
operatorRequestbodyoperatorRequestYesOperatorRequest
Responses
CodeDescriptionSchema
200Operator has been updated successfully.OperatorResponse
201Created
401Unauthorized
403Forbidden
404Operator with id not found.
Security
Security SchemaScopes
Authorizationglobal

production-plan-controller

Production plan APIs

/v1/mrp/productionplan

POST

Summary

Create new production plan.

Description

API to create new production plan.

Parameters
NameLocated inDescriptionRequiredSchema
productionPlanRequestbodyproductionPlanRequestYesProductionPlanRequest
Responses
CodeDescriptionSchema
200OKProductionPlanResponse
201Production plan has been created successfully.ProductionPlanResponse
400Production plan creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Production plan.

Description

API to delete existing Production plan.

Parameters
NameLocated inDescriptionRequiredSchema
productionPlanIdbodyproductionPlanIdYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Production plan has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Production plan has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/productionplan/search

GET

Summary

Search Production plan.

Description

API to search existing Production plan.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Production plan have been fetched successfully.Page«ProductionPlanResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/productionplan/{id}

PUT

Summary

Update existing Production plan.

Description

API to update existing Production plan.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
productionPlanRequestbodyproductionPlanRequestYesProductionPlanRequest
Responses
CodeDescriptionSchema
200Production plan has been updated successfully.ProductionPlanResponse
201Created
401Unauthorized
403Forbidden
404Production plan with id not found.
Security
Security SchemaScopes
Authorizationglobal

quality-control-template-controller

Quality Control APIs

/v1/mrp/qualitycontroltemplate

POST

Summary

Create new QC Template.

Description

API to create new QC Template.

Parameters
NameLocated inDescriptionRequiredSchema
controlTemplateDtobodycontrolTemplateDtoYesQualityControlTemplateDto
Responses
CodeDescriptionSchema
200OKQualityControlTemplateDto
201QC Template has been created successfully.QualityControlTemplateDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Template.

Description

API to delete existing Template.

Parameters
NameLocated inDescriptionRequiredSchema
templateIdsbodytemplateIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Template has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Template with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualitycontroltemplate/search

GET

Summary

Search Template.

Description

API to search existing Operations.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Operations have been fetched successfully.Page«QualityControlTemplateDto»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualitycontroltemplate/template-ids

POST

Summary

Get Template details.

Description

API to get Template details for given template ids.

Parameters
NameLocated inDescriptionRequiredSchema
templateIdsbodytemplateIdsYes[ long ]
Responses
CodeDescriptionSchema
200Template details have been fetched successfully.OperatorResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualitycontroltemplate/template-product-code/{product_code}

GET

Summary

Get Template details.

Description

API to get Template details for given product code.

Parameters
NameLocated inDescriptionRequiredSchema
product_codepathproduct_codeYesstring
Responses
CodeDescriptionSchema
200Template details have been fetched successfully.OperatorResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualitycontroltemplate/template-usage-by-product

POST

Summary

API to get the template usage by product codes

Description

Product template usage note.

Parameters
NameLocated inDescriptionRequiredSchema
productCodesbodyproductCodesYes[ string ]
Responses
CodeDescriptionSchema
200Product template usage have been fetched successfully.OperatorResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualitycontroltemplate/{id}

PUT

Summary

Update existing template.

Description

API to update existing template.

Parameters
NameLocated inDescriptionRequiredSchema
controlTemplateDtobodycontrolTemplateDtoYesQualityControlTemplateDto
idpathidYeslong
Responses
CodeDescriptionSchema
200Template has been updated successfully.JobCardResponse
201Created
401Unauthorized
403Forbidden
404Template with id not found.
Security
Security SchemaScopes
Authorizationglobal

quality-inspection-controller

Quality Inspection APIs

/v1/mrp/qualityinspection/createparameter

POST

Summary

Create Quality Inspection Parameter.

Description

API to create Quality Inspection Parameter.

Parameters
NameLocated inDescriptionRequiredSchema
qcParameterRequestbodyqcParameterRequestYesQCParameterRequest
Responses
CodeDescriptionSchema
200OKQCParameterGroupDto
201Quality Inspection Parameter has been created successfully.QCParameterGroupDto
400Quality Inspection Parameter creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualityinspection/createparametergroup

POST

Summary

Create Quality Inspection Parameter Group.

Description

API to create Quality Inspection Parameter Group.

Parameters
NameLocated inDescriptionRequiredSchema
namebodynameYesstring
Responses
CodeDescriptionSchema
200OKQCParameterGroupDto
201Quality Inspection Parameter Group has been created successfully.QCParameterGroupDto
400Quality Inspection Parameter Group creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualityinspection/createtemplate

POST

Summary

Create Quality Inspection Template.

Description

API to create Quality Inspection Template.

Parameters
NameLocated inDescriptionRequiredSchema
QCTemplateRequestbodyQCTemplateRequestYesQCTemplateRequest
Responses
CodeDescriptionSchema
200OKQCParameterGroupDto
201Quality Inspection Template has been created successfully.QCParameterGroupDto
400Quality Inspection Template creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualityinspection/parametergroupsearch

GET

Summary

Search QC Parameter Group.

Description

API to search existing QC Parameter Group.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200QC Parameter Group have been fetched successfully.Page«QCParameterGroupDto»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualityinspection/parametersearch

GET

Summary

Search QC Parameter Group.

Description

API to search existing QC Parameter Group.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200QC Parameter Group have been fetched successfully.Page«QCParameterResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/qualityinspection/templatesearch

GET

Summary

Search QC Parameter Group.

Description

API to search existing QC Parameter Group.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200QC Parameter Group have been fetched successfully.Page«QCTemplateResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

work-order-controller

work Order APIs

/v1/mrp/workorder

POST

Summary

Create work order

Description

API to create work order.

Parameters
NameLocated inDescriptionRequiredSchema
workOrderRequestbodyworkOrderRequestYesAbstractWorkOrderRequest
Responses
CodeDescriptionSchema
200OKAbstractWorkOrderResponse
201work order has been created successfully.AbstractWorkOrderResponse
400work order could not be created due to insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete Work Order.

Description

API to delete existing Work Order.

Parameters
NameLocated inDescriptionRequiredSchema
workOrderIdsbodyworkOrderIdsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Work Order has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Work Order has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/bulk

POST

Summary

Create multiple job card

Description

API to create job card.

Parameters
NameLocated inDescriptionRequiredSchema
workOrderRequestsbodyworkOrderRequestsYes[ AbstractWorkOrderRequest ]
Responses
CodeDescriptionSchema
200OKAbstractWorkOrderResponse
201Job Card has been created successfully.AbstractWorkOrderResponse
400Job Card could not be created due to insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/bulk/workIds

POST

Summary

Api to fetch work orders in bulk based on work order Ids

Description

Api to fetch work orders

Parameters
NameLocated inDescriptionRequiredSchema
workOrderCodesbodyworkOrderCodesYes[ string ]
Responses
CodeDescriptionSchema
200Api to fetch work orders in bulkAbstractWorkOrderResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/getUsedBomCodes

GET

Summary

Get Used Bom codes by product code.

Description

API to get used bom codes by product code.

Parameters
NameLocated inDescriptionRequiredSchema
codequerycodeYesstring
Responses
CodeDescriptionSchema
200Used Bom codes by product code.[ object ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/schedule-plan

GET

Summary

Work Order Scheduling Plan

Description

Work Order Scheduling Plan API

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Work Order Scheduling Plan fetched successfully.SchedulePlanDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/search

GET

Summary

Search Work Order.

Description

API to search existing Work Order.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Work Order have been fetched successfully.Page«AbstractWorkOrderResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/unreserve-work-orders

POST

Summary

Api to Unreserve quantity in work orders only

Description

Api to Unreserve quantity in work orders only

Parameters
NameLocated inDescriptionRequiredSchema
updatedWorkOrderCodesbodyupdatedWorkOrderCodesYes[ string ]
Responses
CodeDescription
200Api to Unreserve quantity in work orders only
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/update-so-column

POST

Summary

Api to update sales order code in work orders for all tenants

Description

Api to update sales order code in work orders

Responses
CodeDescription
200Api to fetch work orders in bulk
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/updateQCStatus/{workOrderDocSeqCode}

PUT

Summary

Update work order QC status

Description

API to Update work order QC status

Parameters
NameLocated inDescriptionRequiredSchema
bomAssemblyCodebodybomAssemblyCodeYesstring
workOrderDocSeqCodepathworkOrderDocSeqCodeYesstring
Responses
CodeDescription
200OK
201Created
204Work Order QC status has been updated successfully.
401Unauthorized
403Forbidden
404Work Order with given work order code and BOM code not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/updateRequisitionStatus/{workOrderCode}

PUT

Summary

Update work order Requisition pending status

Description

API to Update work order Requisition pending status

Parameters
NameLocated inDescriptionRequiredSchema
isRequisitionPendingbodyisRequisitionPendingYesboolean
workOrderCodepathworkOrderCodeYesstring
Responses
CodeDescription
200OK
201Created
204Work order requisition pending status has been updated successfully.
401Unauthorized
403Forbidden
404Work order code not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/{code}

GET

Summary

Work Order By Code.

Description

API to search existing Work Order.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Work Order have been fetched successfully.AbstractWorkOrderResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/{id}

PUT

Summary

Update work order.

Description

API to update existing work order.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
workOrderRequestbodyworkOrderRequestYesAbstractWorkOrderRequest
Responses
CodeDescriptionSchema
200Work Order has been updated successfully.AbstractWorkOrderResponse
201Created
401Unauthorized
403Forbidden
404Work Order with given id not found.
Security
Security SchemaScopes
Authorizationglobal

PATCH

Summary

Update work Order attributes.

Description

API to update attributes of existing work order.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
workOrderRequestbodyworkOrderRequestYesobject
Responses
CodeDescriptionSchema
200WO attributes has been updated successfully.AbstractWorkOrderResponse
204No Content
401Unauthorized
403Forbidden
404WorkOrder with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorder/{id}/{status}

PUT

Summary

Update work order status

Description

API to Update work order status

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
statuspathstatusYesstring
Responses
CodeDescription
200OK
201Created
204Work Order has been updated successfully.
401Unauthorized
403Forbidden
404Work Order with given id not found.
Security
Security SchemaScopes
Authorizationglobal

wip-consumption-production-controller

Work Order WIP Consumption and Production log APIs

/v1/mrp/workorderconsumption

POST

Summary

Create Work Order WIP Consumption and Production logs

Description

API to create work order WIP consumption and production logs.

Parameters
NameLocated inDescriptionRequiredSchema
wipConsumptionProductionRequestsbodywipConsumptionProductionRequestsYes[ WIPConsumptionProductionRequest ]
Responses
CodeDescriptionSchema
200OK[ object ]
201Work Order WIP Consumption and Production logs has been created successfully.[ object ]
400Work Order WIP Consumption and Production logs creation failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

PUT

Summary

Update existing WIP Consumption and Production log.

Description

API to update existing WIP Consumption and Production log.

Parameters
NameLocated inDescriptionRequiredSchema
wipConsumptionProductionRequestsbodywipConsumptionProductionRequestsYes[ WIPConsumptionProductionRequest ]
Responses
CodeDescriptionSchema
200WIP Consumption and Production log has been updated successfully.[ object ]
201Created
401Unauthorized
403Forbidden
404WIP Consumption and Production log with id not found.
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete WIP Consumption and Production log.

Description

API to delete existing WIP Consumption and Production log.

Parameters
NameLocated inDescriptionRequiredSchema
idsbodyidsYes[ long ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204WIP Consumption and Production log has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404WIP Consumption and Production log has been created successfully.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorderconsumption/ids

POST

Summary

Get WIP Consumption and Production log details.

Description

API to get WIP Consumption and Production log details for given operation ids.

Parameters
NameLocated inDescriptionRequiredSchema
idsbodyidsYes[ long ]
Responses
CodeDescriptionSchema
200WIP Consumption and Production log details have been fetched successfully.WIPConsumptionProductionResponse
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorderconsumption/search

GET

Summary

Search WIP Consumption and Production data.

Description

API to search existing WIP Consumption and Production data.

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
productCodesqueryproductCodesNostring
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200WIP Consumption and Production data have been fetched successfully.Page«WIPConsumptionProductionResponse»
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorderconsumption/updateQCStatus/{workOrderDocSeqCode}

PUT

Summary

Update WIP Production QC status

Description

API to Update WIP Production QC status

Parameters
NameLocated inDescriptionRequiredSchema
stockAdjustmentCodebodystockAdjustmentCodeYesstring
workOrderDocSeqCodepathworkOrderDocSeqCodeYesstring
Responses
CodeDescription
200OK
201Created
204WIP Production QC status has been updated successfully.
401Unauthorized
403Forbidden
404WIP Production with given work order code and BOM code not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/mrp/workorderconsumption/workOrderCode

POST

Summary

Get WIP Consumption and Production productwise data for given work order.

Description

API to get WIP Consumption and Production productwise data for given work order code.

Parameters
NameLocated inDescriptionRequiredSchema
workOrderCodebodyworkOrderCodeYesstring
Responses
CodeDescriptionSchema
200WIP Consumption and Production product wise data for work order have been fetched successfully.WIPConsumptionProductionProductwiseData
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Models

AbstractWorkOrderItemDetails

NameTypeDescriptionRequired
addToRequisitionbooleanNo
costPerUnitnumberPer Unit Price
Example: 3
No
documentSequenceCodestringProduct Document Sequence Code
Example: "WOI-0000001"
Yes
idlongID
Example: 2
No
plannedQuantitynumberPlanned Product quantity
Example: 3
No
produceProductTypestringProduce Product type
Enum: "NONE", "SCRAP", "COPRODUCT"
Example: "SCRAP"
Yes
producedQuantitynumberProduce Product quantity
Example: 3
No
productCodestringProduct code
Example: "P00001"
Yes
productCustomField[ CustomFieldItem ]Product custom fields
Example: []
No
productNamestringProduct Name
Example: "Test Product"
No
productSubstitutesDetails[ ProductSubstiteItemDetails ]Substitute item detailsNo
requisitionQuantitynumberNo
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
reservedStockbooleanReserved stock enabled
Example: true
No
sourceWarehouseCodestringsource warehouse code
Example: "WH-000001"
No
warehouseInventoryData[ WarehouseInventoryData ]Work Order DetailsYes
workOrderItemCodestringItem Sequence Code
Example: "WOI-0000001"
Yes

AbstractWorkOrderOperationDetails

NameTypeDescriptionRequired
completedQuantitynumberCompleted quantity
Example: 3
No
descriptionstringdescriptionNo
documentSequenceCodestringWork Order Operation Document Sequence Code
Example: "WOO-0000001"
Yes
idlongID
Example: 2
No
operationCodestringoperation code
Example: "O-000001"
No
operationCostnumberNo
operationIdlongOperation IdNo
operationTimenumberOperation time
Example: 3
No
operatorCostnumberNo
plannedStartTimedateTimeplanned start timeNo
statusstringoperation status
Enum: "COMPLETED", "IN_PROGRESS", "PENDING"
Example: "COMPLETED"
No
workerIdstringNo
workstationCodestringworkstation code
Example: "WS-000001"
No
workstationCostnumberNo

AbstractWorkOrderRequest

NameTypeDescriptionRequired
actualEndDatedateTimeActual end date
Example: "25-10-2019"
No
actualQuantitynumberManufacturing quantity
Example: 2
No
actualStartDatedateTimeActual start date
Example: "25-10-2019"
No
actualYieldnumberNo
additionalChargesAdditionalChargesAdditional chargesNo
bomAssemblyCodestringNo
bomMetaCodestringBOM Meta Code
Example: "000001"
No
bomMetaDetailsBomMetaDetailsDtoBOM Meta detailsNo
deliveryDatedateTimeDelivery date
Example: "25-10-2019"
No
documentSequenceCodestringWork Order Code
Example: "0000001"
No
inProgressWarehouseCodestringIn Progress Warehouse Code
Example: "WH-0000001"
No
includeByProductCostbooleanInclude By product cost
Example: true
No
isQcEnabledbooleanFlag will pass as true for QC work flow. Possible value - TRUE | FALSE
Example: false
No
isRequisitionPendingbooleanNo
jobWorkOutOrderCostnumberNo
manufactureQuantitynumberManufacturing quantity
Example: 2
No
operationCostDetailsOperationCostDetailsWork Order cost detailsNo
parentWorkOrderCodestringParent Work Order code
Example: "WO-0000001"
No
parentWorkOrderSeqCodestringParent Work Order seq code
Example: "WO-0000001"
No
plannedEndDatedateTimePlanned start date
Example: "25-10-2019"
No
plannedStartDatedateTimePlanned start date
Example: "25-10-2019"
No
plannedYieldnumberNo
productCodestringProduct Code
Example: "P-000001"
No
productCustomField[ CustomFieldItem ]No
productDocSeqCodestringProduct document sequence code
Example: "P-000001"
Yes
productNamestringProduct Name
Example: "Test Product"
No
qcDetailsQCDetailsQC Template detailsNo
qcRecordIdlongNo
qcStatusstringEnum: "PENDING", "COMPLETED", "NONE"No
reservedStockbooleanReserved stock enabled
Example: true
No
sequenceFormatstringSequence Format Id
Example: 1
No
sourceWarehouseCodestringSource Warehouse Code
Example: "WH-0000001"
No
statusstringEnum: "OPEN", "IN_PROGRESS", "ON_HOLD", "COMPLETED"No
targetWarehouseCodestringTarget Warehouse Code
Example: "WH-0000001"
No
warehouseInventoryData[ WarehouseInventoryData ]Bom Assembly DetailsYes
workOrderChildDetails[ WorkOrderChildDetails ]Work order child details.No
workOrderItems[ AbstractWorkOrderItemDetails ]Work Order item detailsNo
workOrderOperations[ AbstractWorkOrderOperationDetails ]Work Order operation detailsNo
workOrderSourceDetailsWorkOrderSourceDetailswork order source details
Example: {"workOrderSource":"SALES_ORDER"}
No

AbstractWorkOrderResponse

NameTypeDescriptionRequired
actualEndDatedateTimeActual end date
Example: "25-10-2019"
No
actualQuantitynumberManufacturing quantity
Example: 2
No
actualStartDatedateTimeActual start date
Example: "25-10-2019"
No
actualTimelongNo
actualYieldnumberNo
additionalChargesAdditionalChargesAdditional chargesNo
allJobCardsCompletedbooleanNo
bomAssemblyCodestringNo
bomMetaCodestringBOM Meta Code
Example: "000001"
No
bomMetaDetailsBomMetaDetailsDtoBOM Meta detailsNo
deliveryDatedateTimeDelivery date
Example: "25-10-2019"
No
documentSequenceCodestringSales invoice Sequence Code
Example: "0000001"
No
estimatedTimelongNo
idlongSales invoice id
Example: 1
No
inProgressWarehouseCodestringIn Progress Warehouse Code
Example: "WH-0000001"
No
includeByProductCostbooleanInclude By product cost
Example: true
No
isQcEnabledbooleanFlag will pass as true for QC work flow. Possible value - TRUE | FALSE
Example: false
No
isRequisitionPendingbooleanNo
isWIPConsumptionProductionbooleanNo
jobWorkOutOrderCostnumberNo
manufactureQuantitynumberManufacturing quantity
Example: 2
No
operationCostDetailsOperationCostDetailsWork Order cost detailsNo
parentWorkOrderCodestringParent Work Order code
Example: "WO-0000001"
No
parentWorkOrderSeqCodestringParent Work Order seq code
Example: "WO-0000001"
No
plannedEndDatedateTimePlanned start date
Example: "25-10-2019"
No
plannedStartDatedateTimePlanned start date
Example: "25-10-2019"
No
plannedYieldnumberNo
productCodestringProduct Code
Example: "P-000001"
No
productCustomField[ CustomFieldItem ]No
productDocSeqCodestringProduct document sequence code
Example: "P-000001"
Yes
productNamestringProduct Name
Example: "Test Product"
No
qcDetailsQCDetailsQC Template detailsNo
qcRecordIdlongNo
qcStatusstringEnum: "PENDING", "COMPLETED", "NONE"No
reservedStockbooleanReserved stock enabled
Example: true
No
sourceWarehouseCodestringSource Warehouse Code
Example: "WH-0000001"
No
statusstringEnum: "OPEN", "IN_PROGRESS", "ON_HOLD", "COMPLETED"No
targetWarehouseCodestringTarget Warehouse Code
Example: "WH-0000001"
No
totalCompletedJobCardsintegerNo
totalJobCardsintegerNo
warehouseInventoryData[ WarehouseInventoryData ]Bom Assembly DetailsYes
workOrderChildDetails[ WorkOrderChildDetails ]Work order child details.No
workOrderCodestringSales invoice code
Example: "SI001"
No
workOrderItems[ AbstractWorkOrderItemDetails ]Work Order item detailsNo
workOrderOperations[ AbstractWorkOrderOperationDetails ]Work Order operation detailsNo
workOrderSourceDetailsWorkOrderSourceDetailswork order source details
Example: {"workOrderSource":"SALES_ORDER"}
No

AdditionalCharges

NameTypeDescriptionRequired
additionalChargeAmountnumberNo
additionalChargeTaxAmountnumberNo
additionalChargesDetails[ AdditionalChargesDetails ]No
globalDiscountGlobalDiscountDetailsNo
globalDiscounts[ GlobalDiscountDetails ]No

AdditionalChargesDetails

NameTypeDescriptionRequired
additionalChargestringNo
additionalChargeAccountCodestringNo
addtionalChargeTaxstringNo
addtionalChargeTaxCodestringNo
apportionFlagbooleanNo
apportionValuestringEnum: "APPORTION_MANUAL", "APPORTION_ON_QTY", "APPORTION_ON_VALUE"No
cgstnumberNo
chargeAmountnumberNo
igstnumberNo
isPercentbooleanNo
isPreChargebooleanNo
percentnumberNo
sgstnumberNo
taxAmountnumberNo

Address

NameTypeDescriptionRequired
address1stringAddress line 1
Example: "218, Robinson Road"
No
address2stringAddress line 2
Example: "Downtown"
No
citystringCity
Example: "C001"
No
contactNamestringcontact name for address
Example: "John Smith"
No
countrystringCountry
Example: "C001"
No
destinationOfSupplystringstate in India
Example: "Maharashtra"
No
placeOfSupplystringstate in India
Example: "Punjab"
No
postalCodestringPostal Code
Example: 123456
No
preferredbooleanIs this a default address?
Example: true
No
statestringState
Example: "CS001"
No

AdvancedTrackingBOMDto

NameTypeDescriptionRequired
costPerUnitnumberNo
expiryDatedateTimeExpiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
manufacturingDatedateTimeManufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
qtyToFulfildoubleBatch qty to fulfill
Example: 1
No
remainingQuantitynumberNo
serialBatchNumberstringBatch or serial number to be fulfilled
Example: "Batch-001"
No

AdvancedTrackingMetaDto

NameTypeDescriptionRequired
acquiredCostnumberAcquired cost of the entire serial or batch
Example: 1
No
advancedTrackingReturnedAdvancedTrackingReturnedNo
batchSizedoubleSerial Number or Batch size
Example: 1
Yes
batchSizeAvailableForReturndoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeFulfilleddoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeReturneddoubleHow much of the batch or serial is returned
Example: 1
Yes
batchSizeReturnedPurchasedoubleHow much of the batch or serial is returned
Example: 1
Yes
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin Name
Example: "Bin 1"
Yes
expiryDatedateTimeExpiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
idlongNo
manufacturingDatedateTimeManufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
productVariantCodestringProduct code
Example: "P-001"
Yes
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack Name
Example: "Rack 1"
Yes
reservedQuantitydoubleReserved Serial Number or Batch size
Example: 1
No
reservedQuantityFulfilleddoubleFulfilled reserved serial number or batch size
Example: 1
Yes
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow Name
Example: "Row 1"
Yes
sequencelongSequence number
Example: 1
No
serialBatchNumberstringSerial Number or Batch Number
Example: "BATCH-001"
Yes
subSequencelongSubsequence number
Example: 1
No
warehouseCodestringPrimary Warehouse
Example: "WH-0000001"
No
warehouseNamestringPrimary Warehouse
Example: "warehouse name"
No

AdvancedTrackingReturned

NameTypeDescriptionRequired
batchSizeReturneddoubleNo
batchSizeReturnedPurchasedoubleNo
returnsByDoc[ AdvancedTrackingReturnedByDoc ]No

AdvancedTrackingReturnedByDoc

NameTypeDescriptionRequired
documentCodestringNo
qtyReturneddoubleNo
returnTypestringEnum: "SALES_RETURN", "PURCHASE_RETURN"No
transactionRefCodestringNo

AssemblyItemsInfoProdPlan

NameTypeDescriptionRequired
plannedQuantitynumberNo
plannedStartDatestringPlanned Start Date
Example: "2020-06-17"
No
productCodestringProduct Code.
Example: "P-0000001"
No
requiredQuantitynumberNo
scheduledDatestringScheduled Date
Example: "2020-06-17"
No
warehouseCodestringNo

AttributeDetails

NameTypeDescriptionRequired
idlongAttribute ID
Example: "Id"
No
namestringAttribute Name
Example: "Colour"
No
values[ string ]Attribute valuesNo

BarcodeDetails

NameTypeDescriptionRequired
barcodeFieldstringNo
hideBarcodeLabelbooleanNo

BomAdditionalCostDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
labelstringName of manufacturing service
Example: "Labour charges"
No
pricenumberQuantity of product in bom
Example: 10.5
No

BomMetaDetailsDto

NameTypeDescriptionRequired
activebooleanbom meta details status
Example: true
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
codestringbom meta details code
Example: "code"
No
deletedbooleanbom meta details delete status
Example: true
No
idlongid of bom meta details
Example: 1234
No
isDefaultbooleanbom default
Example: true
No
namestringbom meta details name
Example: "bom meta name"
No
productIdstringid of bom product
Example: 1234
No

BomMetaDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
bomProductSubstitutesDetails[ ProductSubstitutesDetails ]No
costnumberCost of product in bom
Example: 10.5
No
itemIdlongid of item in bom
Example: 1234
No
itemNamestringProduct Name
Example: "Apple"
Yes
produceProductTypestringProduce Product type
Enum: "NONE", "SCRAP", "COPRODUCT"
Example: "SCRAP"
Yes
productCodestringNo
quantitynumberQuantity of product in bom
Example: 10.5
No
stockUomlongNo

BomOperationDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
costPerHournumberCost of operation in bom
Example: 10.5
No
fixedRatenumberCost of operation in bom
Example: 10.5
No
operationIdlongid of operation in bom
Example: 1234
No
operationNamestringOperation Name
Example: "Apple"
Yes
totalCostnumberCost of operation in bom
Example: 10.5
No

BomProductCostDetails

NameTypeDescriptionRequired
operationCostnumberOperation Cost
Example: 15
No
rawMaterialCostnumberRaw material cost
Example: 20
No
totalCostnumberTotal cost
Example: 35
No

BulkApiResponse

NameTypeDescriptionRequired
failure[ object ]No
statusCodeintegerNo
success[ object ]No

BulkApiResponse«OperatorResponse»

NameTypeDescriptionRequired
failure[ OperatorResponse ]No
statusCodeintegerNo
success[ OperatorResponse ]No

BulkApiResponse«WorkstationDto»

NameTypeDescriptionRequired
failure[ WorkstationDto ]No
statusCodeintegerNo
success[ WorkstationDto ]No

BulkApiResponse«string»

NameTypeDescriptionRequired
failure[ string ]No
statusCodeintegerNo
success[ string ]No

CostDetails

NameTypeDescriptionRequired
actualCostnumberActual cost of operation/operator
Example: 2.2
No
additionalCostnumberAdditional cost of operation/operator
Example: 1.5
No
plannedCostnumberPLanned cost of operation/operator
Example: 1.2
No

CustomFieldItem

NameTypeDescriptionRequired
idlongDimension Id
Example: 11567
No
labelstringCustom Field Name
Example: "Label"
Yes
modulestringSupported ModulesNo
valueobjectDimension Value
Example: "XYZ"
No

DeliveryScheduleItemRequest

NameTypeDescriptionRequired
deliveryScheduleDatedateTimeNo
idlongNo
productCodestringNo
productQuantitynumberNo

DeliveryScheduleItemResponse

NameTypeDescriptionRequired
deliveryScheduleDatedateTimeNo
deliveryScheduleStatusstringEnum: "DELIVERED_ON_TIME", "DELIVERED_LATE", "DELAYED", "NO_STATUS", "IN_PROGRESS"No
idlongNo
productProductShortInfoNo
productCodestringNo
productQuantitynumberNo

DeliveryScheduleRequest

NameTypeDescriptionRequired
contactCodestringNo
deliveryScheduleItems[ DeliveryScheduleItemRequest ]No
linkedDocumentDocumentInfoNo

DeliveryScheduleResponse

NameTypeDescriptionRequired
contactCodestringNo
contactNamestringNo
deliveryScheduleItems[ DeliveryScheduleItemResponse ]No
deliveryScheduleStatusstringEnum: "DELIVERED_ON_TIME", "DELIVERED_LATE", "DELAYED", "NO_STATUS", "IN_PROGRESS"No
idlongNo
linkedDocumentDocumentInfoNo

DeliveryScheduleWipProductionInfo

NameTypeDescriptionRequired
deliveryScheduleDatedateTimeNo
productCodestringNo
productionQuantitynumberNo

DocumentInfo

NameTypeDescriptionRequired
documentCodestringDocument Code.
Example: "QO-0000001"
No
documentCreatedDatedateTimePurchase creation date
Example: "2023-01-01T00:00:00.000+0000"
No
documentSequenceCodestringPurchase Order Code
Example: "0000001"
No
documentTypestringType of document.
Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "PURCHASE_REQUEST", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"
Example: "QUOTATION"
No

ForecastRequest

NameTypeDescriptionRequired
fromDatedateTimeNo
fromPeriodstringNo
namestringNo
periodFrequencystringEnum: "MONTHLY", "QUARTERLY", "YEARLY"No
productCodestringNo
productIdlongNo
toDatedateTimeNo
toPeriodstringNo

ForecastResponse

NameTypeDescriptionRequired
fromDatedateTimeNo
fromPeriodstringNo
idlongNo
namestringNo
periodFrequencystringEnum: "MONTHLY", "QUARTERLY", "YEARLY"No
productCodestringNo
productIdlongNo
productNamestringNo
toDatedateTimeNo
toPeriodstringNo

ForecastingDetails

NameTypeDescriptionRequired
forecastQuantitydoubleNo
frequencyNamestringNo
periodFrequencystringEnum: "MONTHLY", "QUARTERLY", "YEARLY"No

GlobalDiscountDetails

NameTypeDescriptionRequired
accountCodestringNo
amountnumberNo
isPercentbooleanNo
isSubTotalOnlybooleanNo
namestringNo
percentnumberNo

HolidayListDetails

NameTypeDescriptionRequired
descriptionstringNo
holidayDatestringNo
srNostringNo

HolidayListDto

NameTypeDescriptionRequired
fromDatestringFrom date
Example: "25-10-2019"
Yes
holidayListDetails[ HolidayListDetails ]Holiday list details.
Example: "Holiday list details"
No
namestringHoliday list name
Example: "Holiday 2022"
Yes
toDatestringTo date
Example: "25-10-2019"
Yes

IncomingDetails

NameTypeDescriptionRequired
incomingQtynumberNo
outgoingQtynumberNo
periodNamestringNo

InventoryDto

NameTypeDescriptionRequired
availableQuantitydoubleAvailable quantity
Example: 100
No
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin name
Example: "BIN-NAME"
No
costOfGoodsSoldAccountCodestringCost of goods sold account code
Example: "A-10231"
Yes
inventoryAccountCodestringInventory account code
Example: "A-10232"
Yes
inventoryAccountNamestringInventory account name
Example: "Inventory Account"
Yes
landedCostWeightnumberLanded cost weight value
Example: 10.5
No
openingQuantitydoubleOpening quantity
Example: 10
No
openingValuationdoubleOpening valuation
Example: 100.4
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack name
Example: "RACK-NAME"
No
reservedQuantitydoubleReserved quantity
Example: 100
No
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow name
Example: "ROW-NAME"
No
stockAdjustmentAccountCodestringStock adjustment account code
Example: "A-10234"
Yes
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes
wipInventoryAccountCodestringWIP Inventory account code
Example: "A-10233"
Yes

InventoryWarehouseDetails

NameTypeDescriptionRequired
availableQuantitynumberAvailable quantity
Example: 100
No
openingQuantitynumberOpening quantity
Example: 10
No
openingValuationnumberOpening Valuation
Example: 1000
No
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes

JobCardBatchSerialDetails

NameTypeDescriptionRequired
batchSerialNamestringBatch Serial name
Example: "batch1"
No
productCodestringProduct Code
Example: "P-000001"
No
quantitynumberquantity
Example: 1
No
warehouseCodestringWarehouse Code
Example: "P-000001"
No

JobCardRequest

NameTypeDescriptionRequired
actualTimelongNo
documentSequenceCodestringNo
fgquantityTransferredRawMaterialslongNo
instructionsstringInstructions
Example: "Instructions details"
No
jobCardBatchSerialDetails[ JobCardBatchSerialDetails ]No
jobCardDatedateTimeNo
jobCardTimeLogs[ JobCardTimeLogs ]No
operationCostDetailsCostDetailsOperator Cost DetailsNo
operationIdlongNo
operatorCostDetailsCostDetailsOperator Cost DetailsNo
operatorDetailsOperatorDetailsOperator DetailsNo
plannedTimelongNo
remarksstringNo
requestedQuantitynumberNo
sequenceFormatstringNo
statusstringEnum: "OPEN", "IN_PROGRESS", "ON_HOLD", "CANCELLED", "COMPLETED"No
totalCompletedQuantitynumberNo
wipWarehouseCodestringNo
workOrderCodestringNo
workOrderItemCodestringNo
workOrderItemNamestringNo
workstationIdlongNo

JobCardResponse

NameTypeDescriptionRequired
actualTimelongNo
allJobCardsCompletedbooleanNo
documentSequenceCodestringNo
fgquantityTransferredRawMaterialslongNo
idlongNo
instructionsstringInstructions
Example: "Instructions details"
No
isDeletedbooleanNo
jobCardBatchSerialDetails[ JobCardBatchSerialDetails ]No
jobCardCodestringNo
jobCardDatedateTimeNo
jobCardTimeLogs[ JobCardTimeLogs ]No
operationCostDetailsCostDetailsOperator Cost DetailsNo
operationIdlongNo
operationNamestringNo
operatorCostDetailsCostDetailsOperator Cost DetailsNo
operatorDetailsOperatorDetailsOperator DetailsNo
plannedTimelongNo
remarksstringNo
requestedQuantitynumberNo
salesOrderSequenceCodestringNo
sequenceFormatstringNo
statusstringEnum: "OPEN", "IN_PROGRESS", "ON_HOLD", "CANCELLED", "COMPLETED"No
totalCompletedQuantitynumberNo
wipWarehouseCodestringNo
workOrderCodestringNo
workOrderItemCodestringNo
workOrderItemDocSeqCodestringNo
workOrderItemNamestringNo
workOrderSequenceCodestringNo
workstationIdlongNo

JobCardTimeLogs

NameTypeDescriptionRequired
completedQuantitydoublecompleted quantity
Example: 12
No
employeeIdlongEmployee Id
Example: 1
No
employeeNamestringEmployee name
Example: 1
No
fromTimestringTime Log From TimeNo
timeInMinuteslongLog in minutes
Example: 1
No
toTimestringTime Log TO timeNo

LandedCostCategory

NameTypeDescriptionRequired
allocationTypestringEnum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY"No
namestringNo

LinkedDocumentsDto

NameTypeDescriptionRequired
codestringNo
usedbooleanNo

LinkedDocumentsInfoProdPlan

NameTypeDescriptionRequired
documentCodestringDocument Code.
Example: "SO-0000001"
No
documentDatestringSales Order Date
Example: "2020-06-17"
No
documentSequenceCodestringSales Order Code
Example: "0000001"
No
documentTypestringType of document.
Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "PURCHASE_REQUEST", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"
Example: "SALES_ORDER"
No

OperationCostDetails

NameTypeDescriptionRequired
actualOperatingCostnumberActual cost of operation in bom
Example: 10.5
No
additionalOperatingCostnumberAdditional cost of operation in bom
Example: 10.5
No
plannedOperatingCostnumberPlanned cost of operation in bom
Example: 10.5
No
plannedOperatorCostnumberPlanned cost of operator in bom
Example: 10.5
No
plannedWorkstationCostnumberPlanned cost of workstation in bom
Example: 10.5
No
totalOperatingCostnumberTotal cost of operation in bom
Example: 10.5
No

OperationJobCard

NameTypeDescriptionRequired
batchSizedoubleBatch Size
Example: 12
No
createJobCardOnBatchSizebooleanCreate Job Card based on Batch Size
Example: true
No
qualityInspectionTemplateIdlongQuality Inspection Template idNo
qualityInspectionTemplateNamestringQuality Inspection Template nameNo

OperationRequest

NameTypeDescriptionRequired
attachmentIds[ integer ]list of attachment id's for this grNo
attachments[ string ]Attachments url'sNo
costPerHournumberNo
defaultWorkstationlongNo
descriptionstringNo
fixedRatenumberNo
instructionsstringInstructions
Example: "Instructions details"
No
isCorrectivebooleanNo
isDeletedbooleanNo
namestringNo
operationJobCardOperationJobCardOperation Job CardNo
operationTimedoubleNo
operators[ OperatorDetails ]OperatorsNo
subOperations[ SubOperations ]Sub OperationsNo

OperationResponse

NameTypeDescriptionRequired
attachmentIds[ integer ]list of attachment id's for this grNo
attachments[ string ]Attachments url'sNo
costPerHournumberNo
defaultWorkstationlongNo
descriptionstringNo
fixedRatenumberNo
idlongNo
instructionsstringInstructions
Example: "Instructions details"
No
isCorrectivebooleanNo
isDeletedbooleanNo
namestringNo
operationCodestringNo
operationJobCardOperationJobCardOperation Job CardNo
operationTimedoubleNo
operators[ OperatorDetails ]OperatorsNo
subOperations[ SubOperations ]Sub OperationsNo
workstationDetailsWorkstationDtoWorkstation detailsNo
workstationNamestringNo

OperatorDetails

NameTypeDescriptionRequired
costPerHournumbercost per hour
Example: 100
No
costPerHourPerUnitnumbercost per hour
Example: 100
No
fixedRatenumberfixed rate
Example: 40.5
No
fixedRatePerUnitnumberfixed rate
Example: 40.5
No
operatorIdlongOperator Id
Example: 1
No
operatorNamestringOperator nameNo
workerIdstringEmployee Id
Example: 1
No

OperatorRequest

NameTypeDescriptionRequired
addressAddressOperator addressNo
contactNumberstringNo
costPerHournumberNo
dateOfBirthstringNo
emailstringNo
fixedRatenumberNo
jobTitlestringNo
namestringNo
timelongNo
workerIdstringNo

OperatorResponse

NameTypeDescriptionRequired
addressAddressOperator addressNo
contactNumberstringNo
costPerHournumberNo
dateOfBirthstringNo
emailstringNo
fixedRatenumberNo
idlongNo
jobTitlestringNo
namestringNo
timelongNo
workerIdstringNo

Pageable

NameTypeDescriptionRequired
offsetlongNo
pageNumberintegerNo
pageSizeintegerNo
pagedbooleanNo
sortSortNo
unpagedbooleanNo

Page«AbstractWorkOrderResponse»

NameTypeDescriptionRequired
content[ AbstractWorkOrderResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«DeliveryScheduleResponse»

NameTypeDescriptionRequired
content[ DeliveryScheduleResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«ForecastResponse»

NameTypeDescriptionRequired
content[ ForecastResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«HolidayListDto»

NameTypeDescriptionRequired
content[ HolidayListDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«JobCardResponse»

NameTypeDescriptionRequired
content[ JobCardResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«OperationResponse»

NameTypeDescriptionRequired
content[ OperationResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«OperatorResponse»

NameTypeDescriptionRequired
content[ OperatorResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«ProductionPlanResponse»

NameTypeDescriptionRequired
content[ ProductionPlanResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QCParameterGroupDto»

NameTypeDescriptionRequired
content[ QCParameterGroupDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QCParameterResponse»

NameTypeDescriptionRequired
content[ QCParameterResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QCTemplateResponse»

NameTypeDescriptionRequired
content[ QCTemplateResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«QualityControlTemplateDto»

NameTypeDescriptionRequired
content[ QualityControlTemplateDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«SchedulePlanDto»

NameTypeDescriptionRequired
content[ SchedulePlanDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«WIPConsumptionProductionResponse»

NameTypeDescriptionRequired
content[ WIPConsumptionProductionResponse ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

Page«WorkstationDto»

NameTypeDescriptionRequired
content[ WorkstationDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

ProductForecastDetailsDto

NameTypeDescriptionRequired
availableQuantitydoubleNo
foreCastingDetails[ ForecastingDetails ]No
forecastIdlongNo
idlongNo
incomingDetailsList[ IncomingDetails ]No
parentCodestringNo
productCodestringNo
productIdlongNo
productNamestringNo
productSeqCodestringNo
quantityRequiredToBuildnumberNo
typestringEnum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"No

ProductResponse

NameTypeDescriptionRequired
activebooleanProduct status
Example: true
No
advancedTrackingstringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
Example: "NONE"
No
advancedTrackingMetaData[ AdvancedTrackingMetaDto ]Advanced Tracking Meta data
Example: {"field1":"value1","field2":"value2"}
No
amortizationPeriodintegerAmortization template period
Example: 36
No
amortizationTemplateCodestringAmortization template code
Example: "0000001"
No
attributes[ AttributeDetails ]Attribute DetailsNo
autoFulfillmentEnabledbooleanIs Auto-Fulfillment enable?
Example: false
No
barcodestringProduct barcode
Example: 2365234
No
barcodeDetailsBarcodeDetailsbarcode details
Example: {"barcodeField":"Samsung"}
No
basePricedoubleRevenue Base price
Example: 120
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomMetaDetailsList[ BomMetaDetailsDto ]multiple bom configuration
Example: "Bom Configuration"
No
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
categoryCodestringCategory code
Example: "AB0001"
No
categoryDescstringCategory description
Example: "Medical Equipment"
No
customField[ CustomFieldItem ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
deferredExpenseAccountCodestringDeferred Expense account code
Example: "A-0015"
No
deferredRevenueAccountCodestringDeferred Revenue account code
Example: "A-0015"
No
deletedbooleanProduct delete status
Example: true
No
descriptionstringProduct description
Example: "Description"
No
documentSequenceCodestringProduct Sequence code
Example: "P-0000001"
No
hasBuildAssemblybooleanHas Build Assembly
Example: true
No
hasVariantsbooleanProduct has variants
Example: false
No
idlongProduct ID
Example: 1234
No
images[ string ]Product image url'sNo
incomingQtynumberProduct incoming QtyNo
inventoryInventoryDtoInventory information required for Tracked Products.No
inventoryWarehouseDetails[ InventoryWarehouseDetails ]Inventory warehouse details
Example: {"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"}
No
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isFinishedProductbooleanIs finished product?
Example: false
No
isUiProductUpdatebooleanProduct is update by UI.
Example: false
No
isVariantbooleanIs a variant
Example: false
No
landedCostCategory[ LandedCostCategory ]Landed cost category detailsNo
manufacturingCostAccountCodestringManufacturing Cost Account Code
Example: "AC-0000012"
No
masterProductCodestringMaster Product Code
Example: "P-0000001"
No
multipleUomSchemabooleanIs multiple Uom Schema?
Example: true
No
namestringProduct Name
Example: "Apple"
Yes
outgoingQtynumberProduct outgoing QtyNo
productIdstringProduct ID
Example: "P000011"
No
productSubstitutesDetails[ ProductSubstitutesDetails ]No
productTransactionTypestringProduct Transaction Type
Enum: "BOTH", "PURCHASE", "SALES"
Example: "BOTH"
Yes
purchaseAccountCodestringPurchase account code
Example: "A-0012"
Yes
purchasePricedoublePurchase price
Example: 123.33
Yes
purchasePriceTaxInclusivebooleanIs purchase price tax inclusive?
Example: true
No
purchaseReturnAccountCodestringPurchase return account code
Example: "A-0014"
No
purchaseTaxCodestringPurchase tax code
Example: "T-001"
No
recommendedUomlongRecommended product uomNo
reorderEnabledbooleanFlag to enable reorder level
Example: true
No
reorderLevellongReorder level of the Products.
Example: 100
No
reorderLevelReachedbooleanHas Reorder level reachedNo
reorderQuantitylongQuantity to be reordered
Example: 50
No
reorderVendorCodestringVendor code for reorder
Example: "C-000001"
No
reorderVendorNamestringReorder Vendor NameNo
revenueRecognitionInfoProductRevenueRecognitionInfoProduct Revenue Recognition Information ObjectNo
rowRackBinDataRowRackBinDataRow Rack Bin information required for Tracked Products.No
salesAccountCodestringSales account code
Example: "A-0013"
Yes
salesPricedoubleSales price
Example: 120
Yes
salesPriceTaxInclusivebooleanIs sales price tax inclusive?
Example: false
No
salesReturnAccountCodestringSales return account code
Example: "A-0015"
No
salesTaxCodestringSales tax code
Example: "T-002"
No
sequenceFormatstringSequence Format
Example: 1
No
sourcestringIdentify this is ecom sync product
Example: "SHOPIFY"
No
stockUomlongStock UOM
Example: 2
Yes
taxablebooleanIs taxable?
Example: true
No
typestringProduct type
Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"
Example: "TRACKED"
Yes
uomSchemalongReorder level of the Products.
Example: 100
No
uomSchemaDtoUOMSchemaDtoProduct uom schema informationNo
valuationMethodstringValuation Method
Enum: "FIFO", "AVERAGE"
Example: "FIFO"
Yes
variantAttributesobjectAttribute Details specific to a variantNo
variantCountintegerVariant CountNo

ProductRevenueRecognitionInfo

NameTypeDescriptionRequired
allocationTypestringAllocation Type
Example: "Normal/Exclude"
No
createRevenuePlanOnstringCreate Revenue Plan On
Example: "Fulfillment"
No
isDirectRevenuePositingbooleanDirect Revenue Positing
Example: true
No
itemRevenueCategorystringItem Revenue Category
Example: "Licence"
No
revRecForecastRulestringRevenue Recognition Forecast Rule
Example: "Rule Forecast 1"
No
revRecRulestringRevenue Recognition Rule
Example: "Rule 1"
No

ProductShortInfo

NameTypeDescriptionRequired
advancedTrackingstringEnum: "NONE", "BATCH", "SERIAL"No
availableQuantitynumberNo
barcodestringNo
categoryCodestringNo
customField[ CustomFieldItem ]No
descriptionstringNo
documentSequenceCodestringNo
hasVariantsbooleanNo
incomingQtynumberNo
isVariantbooleanNo
landedCostCategory[ LandedCostCategory ]No
masterProductCodestringNo
multipleUomSchemabooleanNo
namestringNo
openingQuantitynumberNo
outgoingQtynumberNo
pidstringNo
product_transaction_typestringNo
purchasePricenumberNo
recommendedUomlongNo
reorderLevellongNo
reorderQuantitylongNo
reservedQuantitynumberNo
salesPricenumberNo
statusbooleanNo
stockUomintegerNo
taxablebooleanNo
typestringNo
unitPricenumberNo
uomSchemalongNo
uomSchemaDtoUOMSchemaDtoNo
valuationMethodstringEnum: "FIFO", "AVERAGE"No

ProductSubstiteItemDetails

NameTypeDescriptionRequired
documentSequenceCodestringProduct Document Sequence Code
Example: "WOI-0000001"
Yes
inventoryPricenumberNo
productCodestringProduct code
Example: "P00001"
Yes
productQuantitynumberProduct quantity
Example: 3
No
reservedQuantitiesData[ ReservedQuantityData ]Reserved quantity data
Example: []
No
sourceWarehouseCodestringsource warehouse code
Example: "WH-000001"
No
warehouseInventoryData[ WarehouseInventoryData ]Work Order DetailsYes

ProductSubstitutesDetails

NameTypeDescriptionRequired
advancedTrackingstringAdvanced Tracking Type
Enum: "NONE", "BATCH", "SERIAL"
Example: "NONE"
No
availableQuantitynumberQuantity of product available
Example: 10
No
productDocumentSeqCodestringDoc seq code of Product
Example: "P-00001"
No
productIdstringProduct Id
Example: "P-00001"
No
productNamestringName of Product
Example: "Test Product"
No
stockUomlongStock UOM
Example: 2
Yes
typestringProduct type
Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"
Example: "TRACKED"
Yes

ProductionPlanRequest

NameTypeDescriptionRequired
assemblyItemsInfo[ AssemblyItemsInfoProdPlan ]No
documentSequenceCodestringNo
linkedDocumentTypestringNo
linkedDocumentsInfo[ LinkedDocumentsInfoProdPlan ]No
postingDatedateTimeNo
rawMaterialsInfo[ RawMaterialsInfoProdPlan ]No
sequenceFormatstringNo
statusstringEnum: "DRAFT", "OPEN", "CLOSED"No
totalPlannedQuantitynumberNo
totalProducedQuantitynumberNo

ProductionPlanResponse

NameTypeDescriptionRequired
assemblyItemsInfo[ AssemblyItemsInfoProdPlan ]No
documentSequenceCodestringNo
idlongNo
isDeletedbooleanNo
linkedDocumentTypestringNo
linkedDocumentsInfo[ LinkedDocumentsInfoProdPlan ]No
postingDatedateTimeNo
productionPlanCodestringNo
rawMaterialsInfo[ RawMaterialsInfoProdPlan ]No
sequenceFormatstringNo
statusstringEnum: "DRAFT", "OPEN", "CLOSED"No
totalPlannedQuantitynumberNo
totalProducedQuantitynumberNo

QCDetails

NameTypeDescriptionRequired
commentstringNo
noOfQuantitynumberNo
passedQuantitynumberNo
rejectedQuantitynumberNo
templateParameterDetails[ TemplateParameterDetails ]List of template parametersNo

QCParameterGroupDto

NameTypeDescriptionRequired
namestringQC Parameter Group id
Example: "Test"
Yes

QCParameterRequest

NameTypeDescriptionRequired
descriptionstringNo
namestringNo
qcParameterGrouplongNo

QCParameterResponse

NameTypeDescriptionRequired
descriptionstringNo
idlongNo
namestringNo
qcParameterGrouplongNo

QCTemplateItemsDto

NameTypeDescriptionRequired
acceptanceCriteriaValuestringNo
isNumericbooleanNo
maximumValuelongNo
minimumValuelongNo
qcParameterlongNo

QCTemplateProductDetails

NameTypeDescriptionRequired
productCodestringProduct code
Example: "P00001"
Yes
productIdlongProduct id
Example: 123456
Yes
productNamestringname of product
Example: "Product"
No

QCTemplateRequest

NameTypeDescriptionRequired
namestringNo
qcTemplateItems[ QCTemplateItemsDto ]No

QCTemplateResponse

NameTypeDescriptionRequired
idlongNo
namestringNo
qcTemplateItems[ QCTemplateItemsDto ]No

QualityControlTemplateDto

NameTypeDescriptionRequired
descriptionstringParameter description
Example: "Template for Brand"
Yes
namestringParameter Label
Example: "Label"
Yes
parameterDtos[ TemplateParameterDto ]Set of possible parameterNo
productDetails[ QCTemplateProductDetails ]List of product detailsNo

RawMaterialsInfoProdPlan

NameTypeDescriptionRequired
availableQuantitynumberNo
productCodestringProduct Code.
Example: "P-0000001"
No
quantityAsPerBOMnumberNo
quantityToRequestnumberNo
warehouseCodestringNo

ReservedQuantityData

NameTypeDescriptionRequired
advancedTrackingMetaDtos[ AdvancedTrackingMetaDto ]Advance tracking type
Example: "SERIAL"
No
advancedTrackingTypestringAdvance tracking type
Enum: "NONE", "BATCH", "SERIAL"
Example: "SERIAL"
No
availableQuantitydoubleAvailable quantity in warehouse
Example: 100
No
binCodestringbin code
Example: "BIN-00001"
Yes
documentCodestringDocument code
Example: "000005"
No
documentItemCodestringDocument item code
Example: "000005"
No
documentTypestringDocument type
Example: "SALES_INVOICE"
No
productCodestringProduct Code
Example: 10
No
rackCodestringRack code
Example: "RACK-00001"
Yes
reservedDatedateTimereserved date
Example: "20-10-2022"
No
reservedQuantitydoubleReserved quantity
Example: 100
No
rowCodestringRow code
Example: "ROW-00001"
Yes
warehouseCodestringWarehouse Code
Example: 100.4
No
wipProcessTypestringWork Order WIP Process Type
Enum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"
Example: "CONSUMPTION"
No

ResponseEntity

NameTypeDescriptionRequired
bodyobjectNo
statusCodestringEnum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"No
statusCodeValueintegerNo

RowRackBinData

NameTypeDescriptionRequired
binIdlongRow Id
Example: 1
Yes
binNamestringRow Name
Example: "Row1"
Yes
rackIdlongRow Id
Example: 1
Yes
rackNamestringRow Name
Example: "Row1"
Yes
rowIdlongRow Id
Example: 1
Yes
rowNamestringRow Name
Example: "Row1"
Yes

SchedulePlanDto

NameTypeDescriptionRequired
actualWoEndDatedateTimeActual end date
Example: "25-10-2019"
No
actualWoStartDatedateTimeActual start date
Example: "25-10-2019"
No
idlongNo
parentWorkOrderCodestringParent Work Order code
Example: "WO-0000001"
No
parentWorkOrderSeqCodestringParent Work Order seq code
Example: "WO-0000001"
No
plannedWoEndDatedateTimePlanned start date
Example: "25-10-2019"
No
plannedWoStartDatedateTimePlanned start date
Example: "25-10-2019"
No
schedulePlanJCDto[ SchedulePlanJCDto ]work order source detailsNo
workOrderIdlongWork Order id
Example: 1
No
workOrderStatusstringWork Order Status
Example: "OPEN"
No

SchedulePlanJCDto

NameTypeDescriptionRequired
actualJcTimelongNo
jobCardCodestringJob card code
Example: "0000001"
No
jobCardDatedateTimejob card date
Example: "25-10-2019"
No
jobCardIdlongJob card id
Example: 1
No
jobCardSeqCodestringJob card seq code
Example: "JC-0000001"
No
jobCardStatusstringNo
operatorIdlongNo
operatorNamestringNo
plannedJcTimelongNo

Sort

NameTypeDescriptionRequired
emptybooleanNo
sortedbooleanNo
unsortedbooleanNo

SubOperations

NameTypeDescriptionRequired
operationIdlongSub Operation Id
Example: 1
No
operationNamestringSub Operation nameNo
operationTimedoubleSub Operation Time
Example: 12
No

TemplateAttributeDto

NameTypeDescriptionRequired
valuestringAttribute Value
Example: "value"
No

TemplateParameterDetails

NameTypeDescriptionRequired
parameterIdlongTemplate Parameter Id
Example: 1
No
parameterNamestringTemplate Parameter nameNo
parameterValuestringTemplate Parameter value
Example: 12
No
templateIdlongNo

TemplateParameterDto

NameTypeDescriptionRequired
attributes[ TemplateAttributeDto ]Set of possible attributesNo
defaultValuestringParameter Default Value
Example: "XYZ"
No
descriptionstringParameter description
Example: "Parameter for Brand"
Yes
fieldTypestringParameter Type
Enum: "NUMBER", "TEXT", "DROPDOWN", "MULTI_SELECT"
Example: "TEXT"
No
labelstringParameter Label
Example: "Label"
Yes
mandatorybooleanParameter Mandatory
Example: false
No
maxLengthintegerMaximum length of value
Example: 25
No

UOMDto

NameTypeDescriptionRequired
activebooleanIs active or not
Example: true
No
deletedbooleanIs deleted or not
Example: false
No
descriptionstringUOM description
Example: "UOM to measure weight"
No
idlongUOM Id
Example: 1
No
isSystemGeneratedbooleanFlag to specify if the UOM is system or user generated
Example: false
No
namestringUOM name
Example: "LB"
No
tenantIdlongTenant Id
Example: 1233
No

UOMSchemaDefinitionDto

NameTypeDescriptionRequired
sinkConversionFactornumber10
Example: 10
No
sinkUOMlong2
Example: 2
No
sourceConversionFactornumber1
Example: 1
No
sourceUOMlong4
Example: 4
No
uidstring (uuid)UOM Schema Definition Id
Example: 1
No

UOMSchemaDto

NameTypeDescriptionRequired
activebooleanIs active or not
Example: true
No
baseUOMUOMDtoBase UOM
Example: "LB"
No
idlongUOM Id
Example: 1
No
namestringUOM name
Example: "LB"
No
uomSchemaDefinitions[ UOMSchemaDefinitionDto ]UOM schema definitionsNo

WIPConsumptionProductionProductwiseData

NameTypeDescriptionRequired
productCodestringProduct Code
Example: "P-0000001"
Yes
quantitynumberQuantity
Example: 1
Yes
wipProcessTypesstringWIP Process Types e.g. Consumption, Production etc
Enum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"
Example: "NONE"
No
workOrderCodestringpid
Example: "P-0000001"
Yes

WIPConsumptionProductionRequest

NameTypeDescriptionRequired
costPerUnitnumberNo
documentDatestringNo
idlongNo
includeByProductCostbooleanNo
isQcEnabledbooleanFlag will pass as true for QC work flow. Possible value - TRUE | FALSE
Example: false
No
productCodestringNo
qcRecordIdlongNo
qcStatusstringEnum: "PENDING", "COMPLETED", "NONE"No
quantitynumberNo
substituteParentProductCodestringNo
typestringEnum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"No
warehouseInventoryData[ WarehouseInventoryData ]No
workOrderCodestringNo
workOrderIdlongNo
workOrderItemCodestringNo

WIPConsumptionProductionResponse

NameTypeDescriptionRequired
childScrapCoproductItems[ WIPConsumptionProductionResponse ]No
costPerUnitnumberNo
dateStampdateTimeNo
documentDatestringNo
idlongNo
includeByProductCostbooleanNo
isDeletedbooleanNo
isQcEnabledbooleanFlag will pass as true for QC work flow. Possible value - TRUE | FALSE
Example: false
No
productCodestringNo
qcRecordIdlongNo
qcStatusstringEnum: "PENDING", "COMPLETED", "NONE"No
quantitynumberNo
substituteParentProductCodestringNo
typestringEnum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"No
warehouseInventoryData[ WarehouseInventoryData ]No
workOrderCodestringNo
workOrderIdlongNo
workOrderItemCodestringNo

WarehouseInventoryData

NameTypeDescriptionRequired
advancedTrackingData[ AdvancedTrackingBOMDto ]Advanced tracking to fulfil listNo
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin name
Example: "BIN-00001"
No
idlongId
Example: 1
No
quantitynumberWarehouse Code
Example: 1
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack name
Example: "RACK-00001"
No
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow Nane
Example: "ROW-00001"
No
warehouseCodestringWarehouse Code
Example: "WH-0000001"
No
warehouseNamestringWarehouse Name
Example: "Warehouse name"
No

WorkOrderChildDetails

NameTypeDescriptionRequired
productCodestringProduct Code
Example: "P-000001"
No
workOrderCodestringChild Work order codeNo
workOrderSeqCodestringChild Work order seq code
Example: "WO-00002"
No

WorkOrderSourceDetails

NameTypeDescriptionRequired
linkedDocumentCodestringNo
salesOrderSequenceCodestringNo
workOrderSourcestringEnum: "SALES_ORDER", "NONE"No

WorkingHours

NameTypeDescriptionRequired
endTimestringNo
isEnabledbooleanNo
srNostringNo
startTimestringNo

WorkstationDto

NameTypeDescriptionRequired
consumableCostnumberConsumable Cost.
Example: 100
No
descriptionstringWorkstation description.
Example: "Description"
No
electricityCostnumberElectricity Cost.
Example: 100
No
holidayListlongNo
productionCapacitynumberProduction Capacity.
Example: 100
No
rentCostnumberRent Cost.
Example: 100
No
wagesnumberWages.
Example: 100
No
workingHours[ WorkingHours ]Working hours list.
Example: "Working Hours"
No
workstationCodestringNo
workstationNamestringWorkstation name.
Example: "Waorkstation1"
No