Retrieves legal person customer details.

GET 
/Customers/legalperson/:code

Retrieves legal person customer details.

Request

Path Parameters

code stringrequired

Query Parameters

api-version string

Header Parameters

X-Request-ID stringrequired

Responses

200

application/json

Schema

Schema

id int32nullablerequired
code stringnullablerequired
organizationName stringnullablerequired
tin stringnullablerequired
relations object[]nullable
Array [
id int32nullablerequired
customerId int32nullablerequired
customerCode stringnullablerequired
customerName stringnullablerequired
customerRelatedId int32nullablerequired
customerRelatedCode stringnullablerequired
customerRelatedName stringnullablerequired
relationType object nullable
oneOf
Affinity
string
Possible values: [Child, Parent, Sibling, Spouse, ShareHolder, LegalRepresentitive, Administrator, LegalNoticeSignature]
notes stringnullablerequired
]
identificationDocuments object[]nullable
Array [
identificationId int32nullablerequired
identificationCode stringnullablerequired
identificationDescription stringnullablerequired
documentNumber stringnullablerequired
issuingAuthority stringnullablerequired
issuingDate date-timenullablerequired
expirationDate date-timenullablerequired
isDefault booleannullablerequired
countryId int32nullablerequired
countryCode stringnullablerequired
countryDescription stringnullablerequired
status object nullable
oneOf
IdentificationStatus
string
Possible values: [Active, Stolen, Lost, Expired]
]
addresses object[]nullable
Array [
id int32required
customerId int32required
countryId int32nullablerequired
countryCode stringnullablerequired
countryDescription stringnullablerequired
municipalityId int32nullablerequired
municipalityCode stringnullablerequired
municipalityDescription stringnullablerequired
addressType AddressType (string)required
Possible values: [Permanent, Work, Temporary, Other, Seat]
town stringnullablerequired
zipCode stringnullablerequired
street stringnullablerequired
additionalStreet stringnullablerequired
number stringnullablerequired
sendPost int32nullablerequired
shouldSendPost booleannullablerequired
defaultId int32nullablerequired
default booleannullablerequired
userCreated stringnullablerequired
dateCreated date-timerequired
userUpdated stringnullablerequired
dateUpdated date-timerequired
county stringnullablerequired
]
phone stringnullablerequired
mobilePhone stringnullablerequired
email stringnullablerequired
fullName stringnullablerequired

Example (from schema)

{
  "id": 0,
  "code": "string",
  "organizationName": "string",
  "tin": "string",
  "relations": [
    {
      "id": 0,
      "customerId": 0,
      "customerCode": "string",
      "customerName": "string",
      "customerRelatedId": 0,
      "customerRelatedCode": "string",
      "customerRelatedName": "string",
      "relationType": "Child",
      "notes": "string"
    }
  ],
  "identificationDocuments": [
    {
      "identificationId": 0,
      "identificationCode": "string",
      "identificationDescription": "string",
      "documentNumber": "string",
      "issuingAuthority": "string",
      "issuingDate": "2024-07-29T15:51:28.071Z",
      "expirationDate": "2024-07-29T15:51:28.071Z",
      "isDefault": true,
      "countryId": 0,
      "countryCode": "string",
      "countryDescription": "string",
      "status": "Active"
    }
  ],
  "addresses": [
    {
      "id": 0,
      "customerId": 0,
      "countryId": 0,
      "countryCode": "string",
      "countryDescription": "string",
      "municipalityId": 0,
      "municipalityCode": "string",
      "municipalityDescription": "string",
      "addressType": "Permanent",
      "town": "string",
      "zipCode": "string",
      "street": "string",
      "additionalStreet": "string",
      "number": "string",
      "sendPost": 0,
      "shouldSendPost": true,
      "defaultId": 0,
      "default": true,
      "userCreated": "string",
      "dateCreated": "2024-07-29T15:51:28.071Z",
      "userUpdated": "string",
      "dateUpdated": "2024-07-29T15:51:28.071Z",
      "county": "string"
    }
  ],
  "phone": "string",
  "mobilePhone": "string",
  "email": "string",
  "fullName": "string"
}

404

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...