Matéria-prima

---

Cadastro de Matéria-prima

O endpoint PostAddRawMaterial é responsável pelo cadastro de uma nova matéria-prima no sistema MIMS.

---

Como cadastrar uma matéria-prima

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddRawMaterial
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddRawMaterial"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
RecipeNo	String(25)	Sim	Código externo da receita de matéria-prima
BranchNo	String(25)	Sim	Código externo da filial
RecipeName	String(25)	Sim	Nome da receita de matéria-prima
MainProductNo	String(25)	Sim	Código externo do produto principal
Standard	Boolean	Não	Flag que indica se a matéria-prima é padrão
OverwriteIfExists	Boolean	Não	Flag que indica que os dados devem ser sobrescritos caso o registro já exista
ItemList	AddRawMaterialItemList	Sim	Lista de itens da matéria-prima

📝 Objeto AddRawMaterialItemList

O objeto AddRawMaterialItemList representa uma lista com os itens da matéria-prima.

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ItemNo	String(25)	Sim	Código do item
MaterialNo	String(25)	Não	Código externo do material
ProductNo	String(25)	Não	Código externo do produto
Qty	Float	Sim	Quantidade (deve ser maior que zero)
MinTolerance	Integer	Não	Tolerância mínima
MaxTolerance	Integer	Não	Tolerância máxima
SubstitutedRawMaterial	Boolean	Não	Flag que indica se há matéria-prima substituta
SubstitutedProductNo	String(25)	Não	Código externo do produto substituto
SubstitutedMaterialNo	String(25)	Não	Código externo do material substituto
SubstitutedPercentage	Integer	Não	Percentual de substituição
Dosed	Boolean	Não	Flag que indica se o item é dosado
WarehouseNo	String(25)	Não	Código externo do almoxarifado
MeasurementUnitERP	String	Não	Unidade de medida no ERP

Observação

• É obrigatório informar MaterialNo OU ProductNo, mas não ambos ao mesmo tempo.
• Se SubstitutedRawMaterial for true, é necessário informar SubstitutedMaterialNo ou SubstitutedProductNo e SubstitutedPercentage.

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
RawMaterialCode	Integer	Sim	Código interno da matéria-prima gerado no sistema MIMS

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddRawMaterial"' \
--header 'Content-Type: application/json' \
--data '{
    "RecipeNo": "REC001",
    "BranchNo": "FIL001",
    "RecipeName": "Receita Padrão",
    "MainProductNo": "PROD001",
    "Standard": true,
    "OverwriteIfExists": true,
    "ItemList": [
        {
            "ItemNo": "1",
            "MaterialNo": "MAT001",
            "Qty": 10.5,
            "MinTolerance": 0,
            "MaxTolerance": 5,
            "SubstitutedRawMaterial": false,
            "Dosed": false,
            "WarehouseNo": "ALM001",
            "MeasurementUnitERP": "KG"
        }
    ]
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "RawMaterialCode": 123
}

---

🐞 Possíveis Erros

Código	Mensagem
ARM‑001	O Número do Material [valor enviado na requisição] não existe na Receita (Matéria-Prima) [valor enviado na requisição]!
ARM‑002	Você não pode informar Material e Produto ao mesmo tempo. Informe um Material ou um Produto!
ARM‑003	É necessário informar um Material ou um Produto!

Exclusão de Matéria-prima

O endpoint PostDeleteRawMaterial é responsável por executar a exclusão de uma matéria-prima no sistema MIMS.

---

Como excluir uma matéria-prima

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostDeleteRawMaterial
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteRawMaterial"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
MainProductNo	String(25)	Sim	Código externo do produto principal
RecipeNo	String(25)	Sim	Código externo da receita de matéria-prima
BranchNo	String(25)	Sim	Código externo da filial

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteRawMaterial"' \
--header 'Content-Type: application/json' \
--data '{
    "MainProductNo": "PROD001",
    "RecipeNo": "REC001",
    "BranchNo": "FIL001"
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}

---

🐞 Possíveis Erros

Código	Mensagem
DRM‑001	Matéria-prima não existe!
DRM‑002	A Matéria-prima já foi utilizada em um lote e não permite exclusão!
DRM‑003	A Matéria-prima é fixa e não permite exclusão!

Exclusão de Item de Matéria-prima

O endpoint PostDeleteRawMaterialItem é responsável por executar a exclusão de um item de uma matéria-prima no sistema MIMS.

---

Como excluir um item de matéria-prima

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostDeleteRawMaterialItem
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteRawMaterialItem"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
MainProductNo	String(25)	Sim	Código externo do produto principal
RecipeNo	String(25)	Sim	Código externo da receita de matéria-prima
BranchNo	String(25)	Sim	Código externo da filial
MaterialNo	String(25)	Não	Código externo do material
ProductNo	String(25)	Não	Código externo do produto

Observação

• É obrigatório informar MaterialNo OU ProductNo para identificar o item a ser excluído.

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteRawMaterialItem"' \
--header 'Content-Type: application/json' \
--data '{
    "MainProductNo": "PROD001",
    "RecipeNo": "REC001",
    "BranchNo": "FIL001",
    "MaterialNo": "MAT001"
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    }
}