Pular para o conteúdo principal

Informações da Tabela de Preço

O endpoint GetPriceTableInfo retorna as informações de uma tabela de preço no sistema MIMS.


Como consultar informações de uma tabela de preço

Request HTTP POST

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/GetPriceTableInfo
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetPriceTableInfo"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
PriceTableNoString(25)NãoCódigo externo da tabela de preço
ProductNoString(25)NãoCódigo externo do produto
ProductionCodeString(10)NãoCódigo de produção do produto
CustomerNoString(25)NãoCódigo externo do cliente
CustomerAuxiliaryNoString(25)NãoCódigo externo auxiliar do cliente
CustomerCodeIntegerNãoCódigo interno do cliente
Observação
  • Ao menos um dos parâmetros deve ser informado: PriceTableNo ou CustomerNo/CustomerAuxiliaryNo/CustomerCode
  • Quando CustomerNo/CustomerAuxiliaryNo/CustomerCode for informado, será retornada a tabela de preço vinculada ao cliente
  • Quando ProductNo ou ProductionCode for informado, serão retornados apenas os itens relacionados ao produto especificado

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
PriceTableInfoGetPriceTableInfoDataSimObjeto contendo as informações da tabela de preço

📝 Objeto GetPriceTableInfoData

O objeto GetPriceTableInfoData representa as informações da tabela de preço.

Parâmetros de Retorno

ParâmetroTipoObrigatórioDescrição
PriceTableCodeIntegerSimCódigo interno da tabela de preço
PriceTableNoString(15)SimCódigo externo da tabela de preço
DescriptionTableString(40)SimDescrição da tabela de preço
IsInactiveValidityBooleanSimFlag que indica que a vigência da tabela de preço está inativa
ValidityStartDateDataHoraSimData inicial da vigência
ValidityEndDateDataHoraSimData final da vigência
ConversionCurrencyNoString(25)SimCódigo da moeda de conversão
ItemListGetPriceTableItemInfoListSimLista de itens da tabela de preço

📝 Objeto GetPriceTableItemInfoList

O objeto GetPriceTableItemInfoList representa uma lista com os itens da tabela de preço.

Parâmetros de Retorno

ParâmetroTipoObrigatórioDescrição
ProductNoString(25)SimCódigo externo do produto
NameString(60)SimNome do produto
ReducedNameString(20)SimNome reduzido do produto
ProductionCodeString(10)SimCódigo de produção do produto
IsInactiveItemBooleanSimFlag que indica que o item da tabela de preço está inativo
IsFixedCommissionBooleanSimFlag que indica se a comissão é fixa
LimitCommissionBooleanSimFlag que indica se limita comissão
PayCommissionBooleanSimFlag que indica se paga comissão
ResetCommissionBooleanSimFlag que indica se zera comissão
SalePriceFloatSimPreço de Venda do item
MinSalePriceFloatNãoPreço mínimo de venda do item
MaxSalePriceFloatNãoPreço máximo de venda do item


Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetPriceTableInfo"' \
--header 'Content-Type: application/json' \
--data '{
"PriceTableNo": "TAB001",
"ProductNo": "PROD001"
}'

Exemplo de Response

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"PriceTableInfo": {
"PriceTableCode": 789,
"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",
"ItemList": [
{
"ProductNo": "PROD001",
"Name": "Produto Exemplo",
"ReducedName": "Prod Ex",
"ProductionCode": "P1234",
"IsInactiveItem": false,
"IsFixedCommission": true,
"LimitCommission": true,
"PayCommission": true,
"ResetCommission": true,
"SalePrice": 15.50,
"MinSalePrice": 12.00,
"MaxSalePrice": 18.00
}
]
}
}

🐞 Possíveis Erros

CódigoMensagem
GPT‑001Parâmetro Código Externo da Tabela de Preço/Produto (PriceTableNo/ProductNo) informado não existe!
GPT‑002Não há tabela de preço para este cliente!