BusinessProfile

BusinessProfile is the master structure and represents data of the business entity, should it be a sole trader or company.

Type

General entity

Fields

Field name

Type

Writable

Required

Description

name

string

The legal name of business entity.

phone

string

The business phone number.

fax

string

The business fax number.

website

string

The business main website link.

email

string

The main contact email address of the business.

business_id

string

The legal registration number of the business.

tax_registered

boolean

The flag to indicate if the business has registered VAT or GST.

tax_registration_no

string

(if tax_registered is true)

The tax registration number, or tax payer ID (TIN).

head_quarter

boolean

The flag to indicate if this entity is the head company or a branch.

branch_number

string

✓ (if head_quarter is false)

The registered branch number.

company_address

Address

The business entity's address.

org_type

OrgTypes

The organization type.

business_type

BusinessTypes

The business type, or field.

financial_setting

FinancialSetting

The financial and accounting setting of the business.

Sample

{
"date_created": 1551030876371,
"date_updated": 1562059139955,
"name": "Losoftce Studio Inc.",
"phone": null,
"fax": null,
"website": null,
"email": null,
"business_id": null,
"tax_registered": true,
"tax_registration_no": "123456789",
"head_quarter": true,
"branch_number": null,
"company_address": {
"line1": "test rad",
"line2": "",
"city": "tt",
"province": "aa",
"country_code": "TH",
"postal_code": "12345"
},
"org_type": "CORPORATION",
"business_type": "GNL_SERVICE",
"financial_setting": {
"fiscal_year_end_month": "DECEMBER",
"fiscal_year_end_day_of_month": 31,
"date_format": "DDMonYYYY",
"currency_code": "THB",
"rounding_digits": 2,
"rounding_mode": "HALF_UP",
"start_date": "2019-03-60"
},
"_id": "4f320c75-8674-48a0-8339-7573f89daa66",
"_links": {
"self": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66"
},
"accounts": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/setting/accounts"
},
"products": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/setting/products"
},
"partners": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/setting/partners"
},
"taxes": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/setting/taxes"
},
"invoices": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/income/invoices"
},
"receipts": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/income/receipts"
},
"payments": {
"href": "https://api.pymlo.com/v1/businesses/4f320c75-8674-48a0-8339-7573f89daa66/income/payments"
}
}
}