Skip to main content

Client

PropertyTypeDescriptionInformation
idintIdentifierUnique for single client.
namestringName of clientMaximal length is 150 characters.
goodday_idstringremote id for clientMaximal length is 255 characters.
addressstring/nullAddress of clientMaximal length is 255 characters.
citystring/nullCity of clientMaximal length is 255 characters.
postal_codestring/nullPostal code of clientMaximal length is 255 characters.
country_idstring/nullCountry id of clientMaximal length is 20 characters.
faxstring/nullFax of clientMaximal length is 100 characters.
websitestring/nullWebsite of clientMaximal length is 100 characters.
activebooleanActivity flag of clienttrue for active client, false for inactive client.
notestring/nullNote of clientNote for client.
degreestring/nullDegree of contact person of client--
first_namestring/nullFirst name of contact person--
last_namestring/nullLast name of contact person--
emailstring/nullEmail of contact person--
phonestring/nullPhone of contact person--
positionstring/nullNote of client--
created_atdateClient creation dateDate of Client creation
updated_atdateClient latest update dateDate of latest Client update

Example:

{
"id": 1,
"name": "demo clientx",
"goodday_id": "3MFGRZ",
"address": null,
"city": null,
"postal_code": null,
"country_id": null,
"phone": null,
"fax": null,
"email": null,
"website": null,
"active": true,
"note": null,
"current_hourly_pay": {
"id": 2,
"hourly_payable_type": "App\\Containers\\Clients\\Models\\Client",
"hourly_payable_id": 1,
"value": "1500",
"currency_id": "EUR",
"valid_from": "2019-12-31T23:00:00.000000Z",
"valid_to": null,
"created_at": "2022-11-29T15:20:30.000000Z",
"updated_at": "2022-11-29T15:20:30.000000Z"
},
"created_at": "2022-11-23T15:59:55+0100",
"updated_at": "2022-11-24T16:19:09+0100",
"_links": [
{
"href": "/api/v0/clients/1",
"rel": "self",
"type": "GET"
}
]
}