Tabela de Preço
Cadastro de Tabela de Preço
O endpoint PostAddPriceTable é responsável pelo cadastro de uma nova tabela de preço no sistema MIMS e pode ser visualizado na tela CAD084.
Como cadastrar uma tabela de preço
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddPriceTable |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPriceTable" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| PriceTableNo | String(15) | Sim | Código externo da tabela de preço |
| DescriptionTable | String(40) | Sim | Descrição da tabela de preço |
| IsInactiveValidity | Boolean | Não | Flag que indica que a vigência da tabela de preço está inativa |
| ValidityStartDate | DataHora | Não | Data inicial da vigência |
| ValidityEndDate | DataHora | Não | Data final da vigência |
| ConversionCurrencyNo | String(25) | Não | Código da moeda de conversão |
| ItemList | AddPriceTableItemList | Não | Lista de itens da tabela de preço |
| OverwriteIfExists | Boolean | Não | Flag que indica que os dados devem ser sobrescritos caso o registro já exista |
📝 Objeto AddPriceTableItemList
O objeto AddPriceTableItemList representa uma lista com os itens da tabela de preço.
Parâmetros de Entrada
Parâmetro Tipo Obrigatório Descrição ProductNo String(25) Sim Código do produto IsInactiveItem Boolean Não Flag que indica que o item da tabela de preço está inativo IsFixedCommission Boolean Não Flag que indica se a comissão é fixa LimitCommission Boolean Não Flag que indica se limita comissão PayCommission Boolean Não Flag que indica se paga comissão ResetCommission Boolean Não Flag que indica se zera comissão SalePrice Float Sim Preço de Venda do item
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 |
| PriceTableCode | Integer | Sim | Código interno da tabela de preço gerado no sistema MIMS |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPriceTable"' \
--header 'Content-Type: application/json' \
--data '{
"PriceTableNo": "TAB001",
"DescriptionTable": "Tabela de preço Base 2025",
"IsInactiveValidity": false,
"ValidityStartDate": "2025-02-01T00:00:00Z",
"ValidityEndDate": "2025-12-31T23:59:59Z",
"ConversionCurrencyNo": "BRL",
"OverwriteIfExists": true,
"ItemList":[
{
"ProductNo": "PROD001",
"IsInactiveItem": false,
"IsFixedCommission": true,
"LimitCommission": true,
"PayCommission": true,
"ResetCommission": true,
"SalePrice": 15
}
]
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"PriceTableCode": 789
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| APT‑001 | Parâmetro Código Externo da Tabela de Preço (PriceTableNo) informado já existe! |
| APT‑002 | Parâmetro Data Final Vigência (ValidityEndDate) informado é menor que o parâmetro Data Início Vigência (ValidityStartDate) informado! |
| APT‑003 | Parâmetro Código Externo da Moeda de Conversão (ConversionCurrencyNo) informado não foi encontrado! |
Exclusão de Tabela de Preço
O endpoint PostDeletePriceTable é responsável por executar a exclusão de uma tabela de preço e seus itens no MIMS.
Como excluir uma tabela de preço
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostDeletePriceTable |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeletePriceTable" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| PriceTableNo | String(15) | Sim | Código externo da tabela de preço |
| ErrorIfNotFound | Boolean | Não | Retorna erro caso a tabela de preço informada não exista no banco de dados |
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 --request POST '{{url_base}}/PostDeletePriceTable' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"PriceTableNo": "TP001",
"ErrorIfNotFound": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| DPT‑001 | Parâmetro Código Externo da Tabela de Preço (PriceTableNo) informado não foi encontrado! |
| DPT‑002 | A tabela de preço informada pertence a um cliente, portanto não pode ser deletada! |