Gets all the entities or it filters them using specific parameters in the URI
Name | Description | Type | Additional information |
---|---|---|---|
Name | Entity name. Uses SQL Like search | string | No additional information available. |
VatNumber | Entity vat number. Uses SQL Like search | string | No additional information available. |
Entity Email. Uses SQL Like search | string | No additional information available. | |
Phone | Entity Phone number. Uses SQL Like search | string | No additional information available. |
Mobile | Entity Mobile number. Uses SQL Like search | string | No additional information available. |
City | Entity City. Uses SQL Like search | string | No additional information available. |
MinBalance | Entity Minimum Balance | decimal number | No additional information available. |
MaxBalance | Entity Maximum Balance | decimal number | No additional information available. |
MinBirthDate | Entity Minimum BirthDate | date | No additional information available. |
MaxBirthDate | Entity Maximum BirthDate | date | No additional information available. |
CivilState | Entity Civil State | CivilState | No additional information available. |
OccupationID | Entity OccupationID | integer | No additional information available. |
Number | Entity Number | integer | No additional information available. |
Status | Entity Status | EntityStatus | No additional information available. |
MinCreationDate | Entity Minimum CreationDate | date | No additional information available. |
MaxCreationDate | Entity Maximum CreationDate | date | No additional information available. |
MinModifiednDate | Entity Minimum ModifiedDate | date | No additional information available. |
MaxModifiedDate | Entity Maximum ModifiedDate | date | No additional information available. |
Ordering | EntityOrderOptions | No additional information available. | |
Desc | boolean | No additional information available. | |
Skip | How many items you want to skip. Usually we skip the item amount we already have | integer | No additional information available. |
Take | Number of items you want per page | integer | Range: inclusive between 0 and 50 |
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. |
[
{
"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": "2022-08-15T07:37:27.2028381+01:00",
"civilState": 0,
"type": 0,
"creationDate": "2022-08-15T07:37:27.2028381+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"
}
}
},
{
"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": "2022-08-15T07:37:27.2028381+01:00",
"civilState": 0,
"type": 0,
"creationDate": "2022-08-15T07:37:27.2028381+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"
}
}
}
]