Get customer data details
- 17 Jan 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get customer data details
- Updated on 17 Jan 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/customers/{id}/
Operation retrieves full details by given id.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of customer
Responses
200
Customer
object
Address
object (Address)
buildingId
string
Building id
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
zipcode
string
Building zipcode
Customer_language
object (SnConstants)
groupname
string
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
integer
Primary key
num_value
integer
Numerical value of the constant
orderno
integer
Order number
txt
string
Human readable textual representation
txt_2
string
Human readable textual representation
value
string
Logical textual value
Customer_restricted_type
object (TxtConstant)
groupname
string
Group name of constant. Same as groupname parameter.
id
integer
Unique id of constant
logical_txt
string
Logical textual value
txt
string
Human readable textual representation (translated)
Customer_state
object (SnConstants)
groupname
string
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
integer
Primary key
num_value
integer
Numerical value of the constant
orderno
integer
Order number
txt
string
Human readable textual representation
txt_2
string
Human readable textual representation
value
string
Logical textual value
Customer_type
object (SnConstants)
groupname
string
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
integer
Primary key
num_value
integer
Numerical value of the constant
orderno
integer
Order number
txt
string
Human readable textual representation
txt_2
string
Human readable textual representation
value
string
Logical textual value
Invoicing_address
object (Apartment)
address
object (Address)
buildingId
string
Building id
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
usagePurpose
object (ApartmentUsage)
Apartment Usage purpose
groupname
Group name of constant
Valid values[ "APARTMENT_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usageState
object (ApartmentStatus)
Apartment status
groupname
Group name of constant
Valid values[ "APARTMENT_STATUS" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
coop_date
string (date)
Cooperative date
coop_member
boolean
If customer is a member of cooperative or not
coop_reimburse_date
string (date)
Cooperative date of reimbursement
coop_sum
integer
Sum of cooperative
customer_country
string
Customer country
customer_email
string
Customer email address GDPR protected field
customer_name
string
Name of customer GDPR protected field
customer_name_ext
string
Customer name extension GDPR protected field
customer_number
string
Customer number
customer_phone
string
Primary phone number GDPR protected field
edited_by_customer_timestamp
string (date-time)
Customer modified date and time
id
integer
Primary key
identification
string
Identification of customer
invoicing_country
string
Invoicing country
invoicing_name
string
Invoice name GDPR protected field
is_edited_by_customer
boolean
If editable by customer
no_sms
boolean
If true sms sending is disabled otherwise, it is enabled
note
string
Customer note or additional details
phone2
string
Secondary phone number GDPR protected field
two_sms_numbers
boolean
If using two SMS numbers or not
vat_code
string
Personal/Business ID GDPR protected field
water_db_id
integer
Water database id
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
