Create a a new db_address usable for a company

Request Information

URI Parameters :

None.

Body Parameters :

db_address
NameDescriptionTypeAdditional 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

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

Sample:
{
  "id": "985b73bd-8117-4d61-8394-6e51600fa400",
  "company_id": "639713cb-8766-4b5e-b805-0e2274e792a9",
  "company_code": "sample string 3",
  "db_address_type_id": "51c0ef7c-941b-4754-ba7e-27527cb42aa3",
  "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": "5a3f2dc1-a424-4277-85f8-a2de2a183b85",
  "db_country_code": "sample string 18",
  "street2": "sample string 19",
  "modified_dateutc": "2024-10-25T18:52:35.9427245+00:00"
}

Response Information

Resource Description :

db_address
NameDescriptionTypeAdditional 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

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

Sample:
{
  "id": "0665c9f0-9a77-4f08-b9b0-c8f3ca534781",
  "company_id": "94c29b86-744f-45e2-ac15-b1e5e6c5e446",
  "company_code": "sample string 3",
  "db_address_type_id": "e00e6113-a36d-498e-b43f-93a70a18d845",
  "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": "5010f267-8fa3-473a-ab34-b96e191e01c9",
  "db_country_code": "sample string 18",
  "street2": "sample string 19",
  "modified_dateutc": "2024-10-25T18:52:35.9427245+00:00"
}