Retrieve comprehensive details about a specific Business Sales Information entity.

POST http://api.kompliant.com/business.salesInfo.get (OpenAPI specification)

Usage Info

Retrieve comprehensive sales information for a business, including card brand acceptance, sales channel distribution, and revenue metrics.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
sales_info_id	string	Yes	The identifier for the Sales Info entity.

Example

{
  "sales_info_id": "bsi_697YYEtrLpod105bhCoSjd"
}

Response

Data

Parameter	Type	Description
sales_info	object	The sales info parameter is defined in the table below.

Sales Info Parameters

Parameter	Type	Description
sales_info_id	string	The identifier for the Sales Info entity.
card_brands	array	List of additional card brands to accept beyond Visa and Mastercard. Must be one or more of the CARD_BRANDS. Currently only AMEX is supported.
sales_method	object	Distribution of sales across different channels. All percentages must total 100. The sales method parameter is defined in the table below.
sales_amount	array of objects	Sales revenue statistics for the business. Each entry requires a type, value, and currency. The sales amount parameters are defined in the table below.

Sales Method Parameters

Parameter	Type	Description
retail	integer	Percentage of retail sales (in-person transactions). For example, 25 means 25%.
telephone	integer	Percentage of telephone sales (phone-based transactions). For example, 25 means 25%.
online	integer	Percentage of online sales (web-based transactions). For example, 25 means 25%.
keyed	integer	Percentage of keyed sales (manually entered transactions). For example, 25 means 25%.

Sales Amount Parameters

Parameter	Type	Description
type	string	Statistic type. Must be one of SALES_AMOUNT_TYPES.
value	number	Monetary value for the sales statistic (e.g., 50000 for $50,000).
currency	string	Currency code for the sales amount information. Must be one of the CURRENCIES. Currently only USD is supported.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3XsPP17u8mU3k29x944ygx",
    "version": "2025-03-24"
  },
  "data": {
    "sales_info": {
      "sales_info_id": "bsi_697YYEtrLpod105bhCoSjd",
      "card_brands": [
        "AMEX"
      ],
      "sales_method": {
        "retail": 25,
        "telephone": 25,
        "online": 25,
        "keyed": 25
      },
      "sales_amount": [
        {
          "type": "AVERAGE_MONTHLY_CREDIT_SALES",
          "value": 999,
          "currency": "USD"
        },
        {
          "type": "AVERAGE_INDIVIDUAL_SALE",
          "value": 99,
          "currency": "USD"
        },
        {
          "type": "HIGHEST_TICKET_SALE",
          "value": 199,
          "currency": "USD"
        }
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `sales_info_id` provided does not exist.