Get customer by ID
GET {{AppUrl}}/api/v1/agency/customer/{{Customer ID}}
Introduction
Retrieve a single customer with detailed information by ID.
Structure
| Item | Type | Plurality | Options | Required | Description | ||
|---|---|---|---|---|---|---|---|
| id | integer | 1 | yes | Customer identifier. | |||
| first_name | varchar(255) | 1 | yes | First name. | |||
| initials | varchar(255) | 1 | yes | Initials. | |||
| infix | varchar(255) | 1 | no | Infix. | |||
| last_name | varchar(255) | 1 | yes | Last name. | |||
| gender | varchar(1) | 1 | m f | yes | Gender (male or female). | ||
| customer_number | integer | 1 | yes | Customer number (identifier for municipalities). | |||
| phone_number | varchar(255) | 1 | yes | Phone number. | |||
| mobilephonenumber | varchar(255) | 1 | no | Mobile phone number. | |||
| varchar(255) | 1 | no | E-mail address. | ||||
| dateofbirth | DateTime | 1 | yes | Date of birth. | |||
| payment_method | varchar(50) | 1 | cash direct-debit | yes | Currently active payment method. | ||
| directdebitrequested_at | DateTime | 1 | no | Date/time customer requested direct-debit authorization. | |||
| directdebitauthorized_at | DateTime | 1 | no | Date/time the direct-debit request was authorized. | |||
| active | boolean | 1 | 0 1 | yes | Indicates whether the customer is active (1) or archived (0). | ||
| created_at | DateTime | 1 | yes | Date/time the customer was created. | |||
| updated_at | DateTime | 1 | yes | Date/time customer was last modified. | |||
| deleted_at | DateTime | 1 | no | Date/time customer was archived. | |||
| municipality | object | 1 | yes | The municipality information. | |||
| name | varchar(255) | 1 | yes | The name of the municipality. | |||
| code | varchar(4) | 1 | yes | The municipality code. | |||
| region | object | 1 | yes | The region information. | |||
| name | varchar(255) | 1 | yes | The name of the region. | |||
| addresses | array | N | yes | Home, post and billing are required. Extra custom addresses are optional. | |||
| type | varchar(255) | 1 | home post billing custom | yes | Type of address (home, post, billing or custom). | ||
| differentfromhome | boolean | 1 | 0 1 | yes | Indicates whether this address differs from the home address. | ||
| label | varchar(255) | 1 | yes* | Label to identify the type of custom address. *Only required on addresses of type 'custom'. | |||
| street | varchar(255) | 1 | yes* | Street name. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | |||
| number | varchar(255) | 1 | yes* | House number. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | |||
| addition | varchar(255) | 1 | no | House number addition. | |||
| postcode | varchar(255) | 1 | yes* | Postal code. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | |||
| city | varchar(255) | 1 | yes* | City. *Required on the home address and any addresses that have 'differentfromhome' set to 1. | |||
| indications | array | N | assistance scootmobile guide-dog solo rollator sit-in-front room low-entrance family push-wheelchair foldable-wheelchair electric-wheelchair extra-high-wheelchair extra-wide-wheelchair leg-support extra-large-entrance extra-large-seat sms-service call-service type-1 type-2 type-3 child pet free-counselor social-counselor | no | The indications for the customer. | ||
| cards | array | N | no | A list of all cards issued to the customer. | |||
| active | boolean | 1 | 0 1 | yes | Indicates whether card is currently active. | ||
| number | integer | 1 | yes | Card number. | |||
| contracts | array | N | no | A list of all contracts for the customer (including those that are not currently valid). | |||
| transport_type | varchar(255) | 1 | llv omd wmo | yes | Transport type. | ||
| valid_from | DateTime | 1 | yes | Validity start date. | |||
| valid_until | DateTime | 1 | no | Validity end date. If empty, the contract is indefinite. | |||
| start_budget | integer | 1 | no | The starting budget in kilometers (only relevant for transport_type 'wmo'). | |||
| current_budget | integer | 1 | no | The current budget in kilometers (only relevant for transport_type 'wmo'). | |||
| unit | varchar(255) | 1 | no | The unit type of the contract (km or zones) (only relevant for transport_type 'wmo'). | |||
| daysectionsper_week | integer | 1 | no | Number of daily sections per week (only relevant for transport_types 'llv' and 'omd'). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"id":7,"first_name":"Aiden","initials":"A","infix":"","last_name":"Willemsen","gender":"m","customer_number":77318,"phone_number":"+3177 1364761","mobile_phone_number":"+31(0)6-43813624","email":"hulskes.noah@example.com","date_of_birth":"1943-11-30T00:00:00+01:00","bankaccount":"NL27YBGI2209095944","bankaccount_name":"D Blewanus","payment_method":"direct-debit","direct_debit_requested_at":"2018-11-20T08:18:48+01:00","direct_debit_authorized_at":"2018-11-21T10:17:54+01:00","active":1,"blocked":false,"created_at":"2018-12-10T15:23:18+01:00","updated_at":"2019-01-22T11:39:56+01:00","deleted_at":null,"municipality":{"name":"Rheden","code":"3516","region":{"name":"Twente"}},"addresses":[{"type":"home","different_from_home":1,"label":null,"street":"Tinssteeg","number":"586","addition":null,"postcode":"8573WP","city":"Grave"},{"type":"post","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"billing","different_from_home":0,"label":null,"street":null,"number":null,"addition":null,"postcode":null,"city":null},{"type":"custom","different_from_home":0,"label":"Corrupti cupiditate","street":"de Langering","number":"39","addition":"c","postcode":"3573AL","city":"Rotstergaast"},{"type":"custom","different_from_home":0,"label":"Voluptas totam","street":"Ghoerlehof","number":"2656","addition":"b","postcode":"9999XK","city":"Midwolde"}],"indications":["call-service","extra-high-wheelchair","scootmobile","sms-service","solo","type-1","type-2"],"cards":[{"active":1,"number":973052009},{"active":0,"number":671085614}],"contracts":[{"transport_type":"omd","valid_from":"2019-01-10T00:00:00+01:00","valid_until":"2020-04-10T00:00:00+02:00","day_sections_per_week":6,"maximum_rides_per_week":12,"maximum_rides_total":780},{"transport_type":"wmo","valid_from":"2018-06-10T00:00:00+02:00","valid_until":"2020-05-10T00:00:00+02:00","start_budget":988,"current_budget":988,"unit":"zones"}]}}