| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /voss/customers | Search voss customers by organization number, customer number or external id | Raw passthrough to the Voss customer search. Returns all matching customers with their full fields (externalId, customerNumber, expiryDate, ...). |
|---|
// @ts-nocheck
export enum CountryCodeEnum
{
AD = 'AD',
AE = 'AE',
AF = 'AF',
AG = 'AG',
AI = 'AI',
AL = 'AL',
AM = 'AM',
AO = 'AO',
AQ = 'AQ',
AR = 'AR',
AS = 'AS',
AT = 'AT',
AU = 'AU',
AW = 'AW',
AX = 'AX',
AZ = 'AZ',
BA = 'BA',
BB = 'BB',
BD = 'BD',
BE = 'BE',
BF = 'BF',
BG = 'BG',
BH = 'BH',
BI = 'BI',
BJ = 'BJ',
BL = 'BL',
BM = 'BM',
BN = 'BN',
BO = 'BO',
BQ = 'BQ',
BR = 'BR',
BS = 'BS',
BT = 'BT',
BV = 'BV',
BW = 'BW',
BY = 'BY',
BZ = 'BZ',
CA = 'CA',
CC = 'CC',
CD = 'CD',
CF = 'CF',
CG = 'CG',
CH = 'CH',
CI = 'CI',
CK = 'CK',
CL = 'CL',
CM = 'CM',
CN = 'CN',
CO = 'CO',
CR = 'CR',
CU = 'CU',
CV = 'CV',
CW = 'CW',
CX = 'CX',
CY = 'CY',
CZ = 'CZ',
DE = 'DE',
DJ = 'DJ',
DK = 'DK',
DM = 'DM',
DO = 'DO',
DZ = 'DZ',
EC = 'EC',
EE = 'EE',
EG = 'EG',
EH = 'EH',
ER = 'ER',
ES = 'ES',
ET = 'ET',
FI = 'FI',
FJ = 'FJ',
FK = 'FK',
FM = 'FM',
FO = 'FO',
FR = 'FR',
GA = 'GA',
GB = 'GB',
GD = 'GD',
GE = 'GE',
GF = 'GF',
GG = 'GG',
GH = 'GH',
GI = 'GI',
GL = 'GL',
GM = 'GM',
GN = 'GN',
GP = 'GP',
GQ = 'GQ',
GR = 'GR',
GS = 'GS',
GT = 'GT',
GU = 'GU',
GW = 'GW',
GY = 'GY',
HK = 'HK',
HM = 'HM',
HN = 'HN',
HR = 'HR',
HT = 'HT',
HU = 'HU',
ID = 'ID',
IE = 'IE',
IL = 'IL',
IM = 'IM',
IN = 'IN',
IO = 'IO',
IQ = 'IQ',
IR = 'IR',
IS = 'IS',
IT = 'IT',
JE = 'JE',
JM = 'JM',
JO = 'JO',
JP = 'JP',
KE = 'KE',
KG = 'KG',
KH = 'KH',
KI = 'KI',
KM = 'KM',
KN = 'KN',
KP = 'KP',
KR = 'KR',
KW = 'KW',
KY = 'KY',
KZ = 'KZ',
LA = 'LA',
LB = 'LB',
LC = 'LC',
LI = 'LI',
LK = 'LK',
LR = 'LR',
LS = 'LS',
LT = 'LT',
LU = 'LU',
LV = 'LV',
LY = 'LY',
MA = 'MA',
MC = 'MC',
MD = 'MD',
ME = 'ME',
MF = 'MF',
MG = 'MG',
MH = 'MH',
MK = 'MK',
ML = 'ML',
MM = 'MM',
MN = 'MN',
MO = 'MO',
MP = 'MP',
MQ = 'MQ',
MR = 'MR',
MS = 'MS',
MT = 'MT',
MU = 'MU',
MV = 'MV',
MW = 'MW',
MX = 'MX',
MY = 'MY',
MZ = 'MZ',
NA = 'NA',
NC = 'NC',
NE = 'NE',
NF = 'NF',
NG = 'NG',
NI = 'NI',
NL = 'NL',
NO = 'NO',
NP = 'NP',
NR = 'NR',
NU = 'NU',
NZ = 'NZ',
OM = 'OM',
PA = 'PA',
PE = 'PE',
PF = 'PF',
PG = 'PG',
PH = 'PH',
PK = 'PK',
PL = 'PL',
PM = 'PM',
PN = 'PN',
PR = 'PR',
PS = 'PS',
PT = 'PT',
PW = 'PW',
PY = 'PY',
QA = 'QA',
RE = 'RE',
RO = 'RO',
RS = 'RS',
RU = 'RU',
RW = 'RW',
SA = 'SA',
SB = 'SB',
SC = 'SC',
SD = 'SD',
SE = 'SE',
SG = 'SG',
SH = 'SH',
SI = 'SI',
SJ = 'SJ',
SK = 'SK',
SL = 'SL',
SM = 'SM',
SN = 'SN',
SO = 'SO',
SR = 'SR',
SS = 'SS',
ST = 'ST',
SV = 'SV',
SX = 'SX',
SY = 'SY',
SZ = 'SZ',
TC = 'TC',
TD = 'TD',
TF = 'TF',
TG = 'TG',
TH = 'TH',
TJ = 'TJ',
TK = 'TK',
TL = 'TL',
TM = 'TM',
TN = 'TN',
TO = 'TO',
TR = 'TR',
TT = 'TT',
TV = 'TV',
TW = 'TW',
TZ = 'TZ',
UA = 'UA',
UG = 'UG',
UM = 'UM',
US = 'US',
UY = 'UY',
UZ = 'UZ',
VA = 'VA',
VC = 'VC',
VE = 'VE',
VG = 'VG',
VI = 'VI',
VN = 'VN',
VU = 'VU',
WF = 'WF',
WS = 'WS',
YE = 'YE',
YT = 'YT',
ZA = 'ZA',
ZM = 'ZM',
ZW = 'ZW',
}
// @DataContract(Name="CustomerContactPersonDto")
export class CustomerContactPersonDto
{
// @DataMember(Name="email", IsRequired=true)
public email: string;
// @DataMember(Name="firstName", IsRequired=true)
public firstName: string;
// @DataMember(Name="lastName", IsRequired=true)
public lastName: string;
// @DataMember(Name="phoneNumber")
public phoneNumber: string;
public constructor(init?: Partial<CustomerContactPersonDto>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="CustomerTargetGroupDto")
export class CustomerTargetGroupDto
{
// @DataMember(Name="id", IsRequired=true)
public id: string;
// @DataMember(Name="name", IsRequired=true)
public name: string;
// @DataMember(Name="isDefault")
public isDefault: boolean;
// @DataMember(Name="externalId")
public externalId: string;
public constructor(init?: Partial<CustomerTargetGroupDto>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="CustomerResult")
export class CustomerResult
{
// @DataMember(Name="countryCode")
public countryCode?: CountryCodeEnum;
// @DataMember(Name="id", IsRequired=true)
public id: string;
// @DataMember(Name="name", IsRequired=true)
public name: string;
// @DataMember(Name="customerNumber")
public customerNumber?: number;
// @DataMember(Name="organizationNumber")
public organizationNumber: string;
// @DataMember(Name="email")
public email: string;
// @DataMember(Name="careOf")
public careOf: string;
// @DataMember(Name="address")
public address: string;
// @DataMember(Name="postalCode")
public postalCode: string;
// @DataMember(Name="city")
public city: string;
// @DataMember(Name="electronicInvoiceOperatorCode")
public electronicInvoiceOperatorCode: string;
// @DataMember(Name="electronicInvoiceAddress")
public electronicInvoiceAddress: string;
// @DataMember(Name="customerGroup")
public customerGroup?: number;
// @DataMember(Name="contactPerson")
public contactPerson: CustomerContactPersonDto;
// @DataMember(Name="targetGroups", EmitDefaultValue=false)
public targetGroups: CustomerTargetGroupDto[] = [];
// @DataMember(Name="expiryDate")
public expiryDate?: string;
// @DataMember(Name="created", IsRequired=true)
public created: string;
// @DataMember(Name="externalId")
public externalId: string;
public constructor(init?: Partial<CustomerResult>) { (Object as any).assign(this, init); }
}
export class SearchVossCustomersResponse
{
public TotalCount: number;
public Items: CustomerResult[] = [];
public constructor(init?: Partial<SearchVossCustomersResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class SearchVossCustomers
{
/** @description Organization number to search for. */
// @ApiMember(Description="Organization number to search for.")
public OrganizationNumber: string;
/** @description Voss customer number to search for. */
// @ApiMember(Description="Voss customer number to search for.")
public CustomerNumber?: number;
/** @description External id to search for. */
// @ApiMember(Description="External id to search for.")
public ExternalId: string;
public constructor(init?: Partial<SearchVossCustomers>) { (Object as any).assign(this, init); }
}
TypeScript SearchVossCustomers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /voss/customers HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"TotalCount":0,"Items":[{}]}