Pular para o conteúdo principal

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çãoURL Exemplo
POST{{url_base}}/PostAddPriceTable
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddPriceTable"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
PriceTableNoString(15)SimCódigo externo da tabela de preço
DescriptionTableString(40)SimDescrição da tabela de preço
IsInactiveValidityBooleanNãoFlag que indica que a vigência da tabela de preço está inativa
ValidityStartDateDataHoraNãoData inicial da vigência
ValidityEndDateDataHoraNãoData final da vigência
ConversionCurrencyNoString(25)NãoCódigo da moeda de conversão
ItemListAddPriceTableItemListNãoLista de itens da tabela de preço
OverwriteIfExistsBooleanNãoFlag 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âmetroTipoObrigatórioDescrição
ProductNoString(25)SimCódigo do produto
IsInactiveItemBooleanNãoFlag que indica que o item da tabela de preço está inativo
IsFixedCommissionBooleanNãoFlag que indica se a comissão é fixa
LimitCommissionBooleanNãoFlag que indica se limita comissão
PayCommissionBooleanNãoFlag que indica se paga comissão
ResetCommissionBooleanNãoFlag que indica se zera comissão
SalePriceFloatSimPreço de Venda do item

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
PriceTableCodeIntegerSimCó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ódigoMensagem
APT‑001Parâmetro Código Externo da Tabela de Preço (PriceTableNo) informado já existe!
APT‑002Parâmetro Data Final Vigência (ValidityEndDate) informado é menor que o parâmetro Data Início Vigência (ValidityStartDate) informado!
APT‑003Parâ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çãoURL Exemplo
POST{{url_base}}/PostDeletePriceTable
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeletePriceTable"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
PriceTableNoString(15)SimCódigo externo da tabela de preço
ErrorIfNotFoundBooleanNãoRetorna erro caso a tabela de preço informada não exista no banco de dados

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformaçõ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ódigoMensagem
DPT‑001Parâmetro Código Externo da Tabela de Preço (PriceTableNo) informado não foi encontrado!
DPT‑002A tabela de preço informada pertence a um cliente, portanto não pode ser deletada!