Create a a new db_address usable for a company
Request Information
URI Parameters :
None.
Body Parameters :
db_addressName | Description | Type | Additional information |
---|---|---|---|
id |
Primary key |
globally unique identifier | |
company_id |
The company owner of this address |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
company_code |
Embedded entity "company" using ERP PK when adding/updating address |
string |
Optionally required : company_id, company_code or company must be provided |
company |
Embedded entity "company" when adding/updating address |
company |
Optionally required : company_id, company_code or company must be provided |
db_address_type_id |
Foreign key to the db_address_type. Please use controller DbAddressType to find the correct it to use |
globally unique identifier | |
code |
Field used for Embedded entity (store there your ERP PK) |
string | |
archived |
You cannot delete an address. The only way is to archive it. |
boolean | |
name |
Name of the address |
string | |
street |
Street |
string |
Max length: 100 |
street_number |
Street number. Can be not used |
string |
Max length: 50 |
zip |
Zip code |
string |
Max length: 50 |
city |
City |
string |
Max length: 50 |
phone |
Phone number |
string | |
mobile |
Cell phone number |
string | |
fax |
Fax number |
string | |
Email address |
string |
Max length: 250 |
|
url |
Url |
string | |
db_country_id |
Foreign key to table Country |
globally unique identifier | |
db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{ "id": "32c920e9-4f9c-49f8-9384-55196b6d9b24", "company_id": "c8ca3274-ccb1-4739-8a53-522a2b92eb06", "company_code": "sample string 3", "db_address_type_id": "0c2abe8e-9459-475d-b145-2015819b2c24", "code": "sample string 5", "archived": true, "name": "sample string 7", "street": "sample string 8", "street_number": "sample string 9", "zip": "sample string 10", "city": "sample string 11", "phone": "sample string 12", "mobile": "sample string 13", "fax": "sample string 14", "email": "sample string 15", "url": "sample string 16", "db_country_id": "c7ddf78b-cc40-4f7b-a437-2cf93c20b7a3", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-09-18T18:11:06.5506155+00:00" }
Response Information
Resource Description :
db_addressName | Description | Type | Additional information |
---|---|---|---|
id |
Primary key |
globally unique identifier | |
company_id |
The company owner of this address |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
company_code |
Embedded entity "company" using ERP PK when adding/updating address |
string |
Optionally required : company_id, company_code or company must be provided |
company |
Embedded entity "company" when adding/updating address |
company |
Optionally required : company_id, company_code or company must be provided |
db_address_type_id |
Foreign key to the db_address_type. Please use controller DbAddressType to find the correct it to use |
globally unique identifier | |
code |
Field used for Embedded entity (store there your ERP PK) |
string | |
archived |
You cannot delete an address. The only way is to archive it. |
boolean | |
name |
Name of the address |
string | |
street |
Street |
string |
Max length: 100 |
street_number |
Street number. Can be not used |
string |
Max length: 50 |
zip |
Zip code |
string |
Max length: 50 |
city |
City |
string |
Max length: 50 |
phone |
Phone number |
string | |
mobile |
Cell phone number |
string | |
fax |
Fax number |
string | |
Email address |
string |
Max length: 250 |
|
url |
Url |
string | |
db_country_id |
Foreign key to table Country |
globally unique identifier | |
db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{ "id": "4e291887-92f9-48a7-8193-c45f6288c05f", "company_id": "18efa972-2dde-4782-9a08-933b2deadff1", "company_code": "sample string 3", "db_address_type_id": "9e0e66d7-1893-46a0-8f48-46f7b06e7be3", "code": "sample string 5", "archived": true, "name": "sample string 7", "street": "sample string 8", "street_number": "sample string 9", "zip": "sample string 10", "city": "sample string 11", "phone": "sample string 12", "mobile": "sample string 13", "fax": "sample string 14", "email": "sample string 15", "url": "sample string 16", "db_country_id": "06ae700e-7d56-46dd-acd2-7aa8bb6c1819", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-09-18T18:11:06.5506155+00:00" }