Skip to main content

Company Group

Overview

The company_group module synchronizes company group master data. A company group represents a chain or group that one or more companies belong to. This module has no dependency, and every company group field is required.

Request

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

Request Envelope

The Company Group module uses the standard Open API request envelope with company_group as the module and an array of company group objects as data.

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

Request Body Fields

FieldTypeRequiredDescriptionExample
idstringYesCompany group identifier.GRP-01
codestringYesCompany group code.GRP01
namestringYesCompany group name.Nusantara Hospitality Group
emailstringYesEmail address of the company group.info@example.com
tlpstringYesTelephone number of the company group.+622112345678
phonestringYesPhone number of the company group.+622112345678
addressstringYesAddress of the company group.Jl. Sudirman No. 1, Jakarta
websitestringYesWebsite URL of the company group.https://example.com
logostringYesURL of the company group logo.https://cdn.example.com/group/logo.png
email_formatstringYesEmail format used by the company group.{first}.{last}@example.com
activebooleanYesIndicates whether the company group is active.true
app_datestringYesApplication date of the company group.2024-01-01

Request Example

{
"module": "company_group",
"data": [
{
"id": "GRP-01",
"code": "GRP01",
"name": "Nusantara Hospitality Group",
"email": "info@example.com",
"tlp": "+622112345678",
"phone": "+622112345678",
"address": "Jl. Sudirman No. 1, Jakarta",
"website": "https://example.com",
"logo": "https://cdn.example.com/group/logo.png",
"email_format": "{first}.{last}@example.com",
"active": true,
"app_date": "2024-01-01"
}
],
"chunk_metadata": {
"process_id": "sync-grp01-2026-08-30",
"chunk_sequence": 1,
"is_last_chunk": true,
"total_records_in_chunk": 1
}
}