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": "45f7533f-b013-4648-a640-eb3ab0754883", "company_id": "e9fbaac2-cf9b-4614-8e34-235eae5b3e33", "company_code": "sample string 3", "db_address_type_id": "5888f11a-8be4-4566-ac1e-d3cbb1fa5709", "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": "1f5ac7f9-bd0c-4bec-9a0f-67f0085915f1", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-06-07T22:29:45.6522644+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": "dc6316bf-9269-4d33-9ca8-33018896d943", "company_id": "3f773730-8fc9-47d5-9fa8-672fdde25b6b", "company_code": "sample string 3", "db_address_type_id": "397a4743-022b-44f4-8147-e576270a871c", "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": "333211f5-49de-4f3c-9417-fe66d988c69c", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-06-07T22:29:45.6522644+00:00" }