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": "6adb3ae8-f7c2-4352-a509-297bf119661e", "company_id": "be39ab67-29d1-4191-8147-19607511e6d7", "company_code": "sample string 3", "db_address_type_id": "f58e9c7e-bc5f-4f81-a58a-88d86c477591", "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": "6863a1cf-97ea-4069-a378-e58a9626bd47", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-04-24T23:52:56.5278083+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": "e5a756c2-5d34-46ba-8f46-c0fedd19b2e6", "company_id": "c4c063a3-f14f-4152-b61a-b7cadf93573d", "company_code": "sample string 3", "db_address_type_id": "a6e9a57e-39a8-406e-8d96-ed2fd20ac881", "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": "4aa5c321-6414-4e15-8f51-40e2e5bb04c2", "db_country_code": "sample string 18", "street2": "sample string 19", "modified_dateutc": "2025-04-24T23:52:56.5278083+00:00" }