Price Table Information
The GetPriceTableInfo endpoint returns price table information in the MIMS system.
How to query price table information
HTTP POST Request
| Request Type | Example URL |
|---|---|
| POST | {{url_base}}/GetPriceTableInfo |
| Example | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetPriceTableInfo" |
Input Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| PriceTableNo | String(25) | No | External code of the price table |
| ProductNo | String(25) | No | External code of the product |
| ProductionCode | String(10) | No | Product production code |
| CustomerNo | String(25) | No | External code of the customer |
| CustomerAuxiliaryNo | String(25) | No | Auxiliary external code of the customer |
| CustomerCode | Integer | No | Internal customer code |
Note
- At least one of the parameters must be provided:
PriceTableNoorCustomerNo/CustomerAuxiliaryNo/CustomerCode - When
CustomerNo/CustomerAuxiliaryNo/CustomerCodeis provided, the price table linked to the customer will be returned - When
ProductNoorProductionCodeis provided, only items related to the specified product will be returned
Return
| Parameter | Type | Required | Description |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Yes | Standard WebService response information in method execution |
| PriceTableInfo | GetPriceTableInfoData | Yes | Object containing price table information |
📝 GetPriceTableInfoData Object
The GetPriceTableInfoData object represents price table information.
Return Parameters
Parameter Type Required Description PriceTableCode Integer Yes Internal price table code PriceTableNo String(15) Yes External code of the price table DescriptionTable String(40) Yes Price table description IsInactiveValidity Boolean Yes Flag indicating that the price table validity is inactive ValidityStartDate DataHora Yes Validity start date ValidityEndDate DataHora Yes Validity end date ConversionCurrencyNo String(25) Yes Conversion currency code ItemList GetPriceTableItemInfoList Yes List of price table items
📝 GetPriceTableItemInfoList Object
The GetPriceTableItemInfoList object represents a list with price table items.
Return Parameters
Parameter Type Required Description ProductNo String(25) Yes External code of the product Name String(60) Yes Product name ReducedName String(20) Yes Reduced product name ProductionCode String(10) Yes Product production code IsInactiveItem Boolean Yes Flag indicating that the price table item is inactive IsFixedCommission Boolean Yes Flag indicating if commission is fixed LimitCommission Boolean Yes Flag indicating if commission is limited PayCommission Boolean Yes Flag indicating if commission is paid ResetCommission Boolean Yes Flag indicating if commission is reset SalePrice Float Yes Item sale price MinSalePrice Float No Minimum item sale price MaxSalePrice Float No Maximum item sale price
Request Example
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetPriceTableInfo"' \
--header 'Content-Type: application/json' \
--data '{
"PriceTableNo": "TAB001",
"ProductNo": "PROD001"
}'
Response Example
{
"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
}
]
}
}
🐞 Possible Errors
| Code | Message |
|---|---|
| GPT‑001 | The provided External Price Table/Product Code parameter (PriceTableNo/ProductNo) does not exist! |
| GPT‑002 | There is no price table for this customer! |