Sales Type

Overview

The sales_type module synchronizes sales type master data for a company. This module depends on company. The referenced company_id must already exist.

Request

• Method: POST
• Path: {{base_url}}/api/sync-master-data

Request Envelope

The Sales Type module uses the standard Open API request envelope with sales_type as the module and an array of sales type objects as data.

{
  "module": "sales_type",
  "data": [
    {}
  ],
  "chunk_metadata": {}
}

Request Body Fields

Field	Type	Required	Description	Example
id	string	Yes	Sales type identifier.	ST-01
company_id	string	Yes	Identifier of the company the sales type belongs to. The company must already exist.	HTL-001
name	string	Optional	Sales type name.	Service Charge
type	string	Optiona;	Type associated with the sales type.	PERCENTAGE
type_value	number	Optional	Value associated with the sales type.	10
system_calculation	string	Optional	Indicates whether the sales type uses system calculation.	""

Request Example

{
  "module": "sales_type",
  "data": [
    {
      "id": "ST-01",
      "company_id": "HTL-001",
      "name": "Service Charge",
      "type": "PERCENTAGE",
      "type_value": 10,
      "system_calculation": ""
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-htl001-2026-08-30",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}