Tabela de Preço

Descrição

O endpoint PostAddPriceTable é responsável pelo cadastro de uma nova tabela de preço no sistema MIMS e pode ser visualizado na CAD084.

---

Como cadastrar uma nova 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

Nome	Tipo	Obrigatório	Descrição
PriceTableNo	String(15)	Sim	Código Externo da Tabela de Preço
Description	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 da 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

Descrição

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

Nome	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 --request POST '{{url_base}}/PostAddPriceTable' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
  "PriceTableNo": "PT001",
  "Description": "Tabela de Preço Base 2025",
  "IsInactiveValidity": false,
  "ValidityStartDate": "2025-02-01T00:00:00Z",
  "ValidityEndDate": "2025-12-31T23:59:59Z",
  "ConversionCurrencyNo": "CUR001",
  "ItemList": [
    {
      "ProductNo": "PROD001",
      "IsInactiveItem": false,
      "IsFixedCommission": true,
      "LimitCommission": false,
      "PayCommission": true,
      "ResetCommission": false,
      "SalePrice": 25.50
    }
  ],
  "OverwriteIfExists": true
}'

---

Exemplo de Response

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

---

Excluir Tabela de Preço

Descrição

O endpoint PostDeletePriceTable executa uma 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 'Conten
{
  "PriceTableNo": "TP001",
  "ErrorIfNotFound": true
}

---

Exemplo de Response

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

---

Notas de Dev

• Certifique-se de que PriceTableNo, ProductNo, ConversionCurrencyNo e outros códigos externos sejam válidos e existentes no sistema MIMS.
• Os campos de data, como ValidityStartDate e ValidityEndDate, devem estar no formato ISO 8601 (ex.: 2025-02-01T00:00:00Z).
• O campo ItemList é opcional, mas deve ser fornecido se houver itens específicos a serem cadastrados na tabela de preço.
• O campo OverwriteIfExists, quando true, sobrescreve os dados existentes para a mesma tabela de preço, caso já exista um registro.
• As flags IsInactiveValidity, IsInactiveItem, IsFixedCommission, LimitCommission, PayCommission e ResetCommission controlam o comportamento da tabela e dos itens (inativo, tipo de comissão, etc.).