Retrieves the db_address with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

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": "43bbb5bd-5468-4278-886e-65382166c5bc",
  "company_id": "a4812667-d9db-4f26-b0b9-56f5624498e9",
  "company_code": "sample string 3",
  "db_address_type_id": "c691036b-d989-405e-8b52-270332df0af9",
  "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": "bcaad278-f446-4adb-937b-7b7bd854637d",
  "db_country_code": "sample string 18",
  "street2": "sample string 19",
  "modified_dateutc": "2024-11-21T08:37:55.0968812+00:00"
}