CountryDto¶
Example Json Object
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "name": "string",
8 "schema": "string",
9 "taxJurisdictionEnabled": true,
10 "regionId": 0,
11 "companyId": 0,
12 "taxJurisdictionId": 0,
13 "taxCodeId": 0,
14 "paymentMethodId": 0
15}
📄 Description: Data transfer object representing a country, including essential attributes such as name, code, and region, facilitating international operations and compliance within global business frameworks.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
status |
string |
false |
none |
Status of the resource |
displayId |
string |
true |
none |
Unique identifier for the display |
erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
name |
string |
false |
none |
Name of the resource |
schema |
string |
false |
none |
Represents the country data structure utilized in the API, enabling the retrieval and management of country-specific information. |
taxJurisdictionEnabled |
boolean |
false |
none |
Indicates whether tax jurisdiction features are enabled for the specified country, facilitating compliance with local tax regulations. |
regionId |
integer(int64) |
false |
none |
Unique identifier for the region |
companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
taxJurisdictionId |
integer(int64) |
false |
none |
Unique identifier for the tax jurisdiction |
taxCodeId |
integer(int64) |
false |
none |
Unique identifier for the tax code |
paymentMethodId |
integer(int64) |
false |
none |
Unique identifier for the payment method |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |