GET api/v1/entities/{id}

Get one entiy by the provided ID

Request Information

URI Parameters

Name Description Type Additional information
id Entity ID that you want to get integer Required

Response Information

Resource Description

No information available

Name Description Type Additional information
Number Entity unique number identifier integer No additional information available.
VatNumber Entity VAT number string No additional information available.
Status Entity status EntityStatus No additional information available.
Occupation Entity Occupation ID OccupationInfo No additional information available.
Iban Entity IBAN string No additional information available.
Contact Entity Contact ContactSimpleInfo No additional information available.
Balance Entity current balance decimal number No additional information available.
ChildrenCount Entity children number byte No additional information available.
BirthDate Entity birthdate. Can be null if no date is supplied date No additional information available.
CivilState Entity civil state CivilState No additional information available.
Type Entity type EntityType No additional information available.
CreationDate Entity creation date in the company date No additional information available.
Observation Entity observations string No additional information available.
EntityID Entity unique key integer No additional information available.
Name Entity name string No additional information available.
Address Entity Address AddressInfo No additional information available.

Response Formats

application/json, text/json

Sample:
                    
{
  "number": 1,
  "vatNumber": "sample string 2",
  "status": 0,
  "occupation": {
    "occupationID": 1,
    "name": "sample string 2"
  },
  "iban": "sample string 3",
  "contact": {
    "phone": "sample string 1",
    "mobile": "sample string 2",
    "fax": "sample string 3",
    "email": "sample string 4",
    "url": "sample string 5"
  },
  "balance": 4.0,
  "childrenCount": 64,
  "birthDate": "2021-07-29T08:47:54.1125276+01:00",
  "civilState": 0,
  "type": 0,
  "creationDate": "2021-07-29T08:47:54.1125276+01:00",
  "observation": "sample string 7",
  "entityID": 8,
  "name": "sample string 9",
  "address": {
    "street": "sample string 1",
    "city": "sample string 2",
    "code": "sample string 3",
    "region": "sample string 4",
    "country": {
      "countryID": 64,
      "name": "sample string 2",
      "isoCode": "sample string 3"
    }
  }
}