Skip to main content

Price Table Information

The GetPriceTableInfo endpoint returns price table information in the MIMS system.


How to query price table information

HTTP POST Request

Request TypeExample URL
POST{{url_base}}/GetPriceTableInfo
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetPriceTableInfo"

Input Parameters

ParameterTypeRequiredDescription
PriceTableNoString(25)NoExternal code of the price table
ProductNoString(25)NoExternal code of the product
ProductionCodeString(10)NoProduct production code
CustomerNoString(25)NoExternal code of the customer
CustomerAuxiliaryNoString(25)NoAuxiliary external code of the customer
CustomerCodeIntegerNoInternal customer code
Note
  • At least one of the parameters must be provided: PriceTableNo or CustomerNo/CustomerAuxiliaryNo/CustomerCode
  • When CustomerNo/CustomerAuxiliaryNo/CustomerCode is provided, the price table linked to the customer will be returned
  • When ProductNo or ProductionCode is provided, only items related to the specified product will be returned

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
PriceTableInfoGetPriceTableInfoDataYesObject containing price table information

📝 GetPriceTableInfoData Object

The GetPriceTableInfoData object represents price table information.

Return Parameters

ParameterTypeRequiredDescription
PriceTableCodeIntegerYesInternal price table code
PriceTableNoString(15)YesExternal code of the price table
DescriptionTableString(40)YesPrice table description
IsInactiveValidityBooleanYesFlag indicating that the price table validity is inactive
ValidityStartDateDataHoraYesValidity start date
ValidityEndDateDataHoraYesValidity end date
ConversionCurrencyNoString(25)YesConversion currency code
ItemListGetPriceTableItemInfoListYesList of price table items

📝 GetPriceTableItemInfoList Object

The GetPriceTableItemInfoList object represents a list with price table items.

Return Parameters

ParameterTypeRequiredDescription
ProductNoString(25)YesExternal code of the product
NameString(60)YesProduct name
ReducedNameString(20)YesReduced product name
ProductionCodeString(10)YesProduct production code
IsInactiveItemBooleanYesFlag indicating that the price table item is inactive
IsFixedCommissionBooleanYesFlag indicating if commission is fixed
LimitCommissionBooleanYesFlag indicating if commission is limited
PayCommissionBooleanYesFlag indicating if commission is paid
ResetCommissionBooleanYesFlag indicating if commission is reset
SalePriceFloatYesItem sale price
MinSalePriceFloatNoMinimum item sale price
MaxSalePriceFloatNoMaximum 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

CodeMessage
GPT‑001The provided External Price Table/Product Code parameter (PriceTableNo/ProductNo) does not exist!
GPT‑002There is no price table for this customer!