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": "3d2e6c8c-9850-4ae8-ac94-5fabf69b9528", "company_id": "872fcb86-c5b6-49e6-a4dc-82c0cf7f4761", "company_code": "sample string 3", "db_address_type_id": "fd36c41c-7c83-491b-8664-8652c8bb18a1", "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": "00b470fa-348a-43fa-a45a-d61b9dbbf117", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-09-05T05:49:22.2552532+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": "e0402f3b-3e91-4374-a12c-b4d676463f54", "company_id": "992a3025-a618-48f8-add0-3de89581427e", "company_code": "sample string 3", "db_address_type_id": "6f5e2972-c2e9-491c-9afa-780138d4c9ee", "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": "83acfd73-e74c-45cf-8386-518a66530a44", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-09-05T05:49:22.2552532+00:00" }