| 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, ...). |
|---|
"use strict";
/** @typedef {'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AX'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BQ'|'BR'|'BS'|'BT'|'BV'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CW'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'EH'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GF'|'GG'|'GH'|'GI'|'GL'|'GM'|'GN'|'GP'|'GQ'|'GR'|'GS'|'GT'|'GU'|'GW'|'GY'|'HK'|'HM'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IO'|'IQ'|'IR'|'IS'|'IT'|'JE'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MQ'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NF'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PS'|'PT'|'PW'|'PY'|'QA'|'RE'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SJ'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'SS'|'ST'|'SV'|'SX'|'SY'|'SZ'|'TC'|'TD'|'TF'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'UM'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW'} */
export var CountryCodeEnum;
(function (CountryCodeEnum) {
CountryCodeEnum["AD"] = "AD"
CountryCodeEnum["AE"] = "AE"
CountryCodeEnum["AF"] = "AF"
CountryCodeEnum["AG"] = "AG"
CountryCodeEnum["AI"] = "AI"
CountryCodeEnum["AL"] = "AL"
CountryCodeEnum["AM"] = "AM"
CountryCodeEnum["AO"] = "AO"
CountryCodeEnum["AQ"] = "AQ"
CountryCodeEnum["AR"] = "AR"
CountryCodeEnum["AS"] = "AS"
CountryCodeEnum["AT"] = "AT"
CountryCodeEnum["AU"] = "AU"
CountryCodeEnum["AW"] = "AW"
CountryCodeEnum["AX"] = "AX"
CountryCodeEnum["AZ"] = "AZ"
CountryCodeEnum["BA"] = "BA"
CountryCodeEnum["BB"] = "BB"
CountryCodeEnum["BD"] = "BD"
CountryCodeEnum["BE"] = "BE"
CountryCodeEnum["BF"] = "BF"
CountryCodeEnum["BG"] = "BG"
CountryCodeEnum["BH"] = "BH"
CountryCodeEnum["BI"] = "BI"
CountryCodeEnum["BJ"] = "BJ"
CountryCodeEnum["BL"] = "BL"
CountryCodeEnum["BM"] = "BM"
CountryCodeEnum["BN"] = "BN"
CountryCodeEnum["BO"] = "BO"
CountryCodeEnum["BQ"] = "BQ"
CountryCodeEnum["BR"] = "BR"
CountryCodeEnum["BS"] = "BS"
CountryCodeEnum["BT"] = "BT"
CountryCodeEnum["BV"] = "BV"
CountryCodeEnum["BW"] = "BW"
CountryCodeEnum["BY"] = "BY"
CountryCodeEnum["BZ"] = "BZ"
CountryCodeEnum["CA"] = "CA"
CountryCodeEnum["CC"] = "CC"
CountryCodeEnum["CD"] = "CD"
CountryCodeEnum["CF"] = "CF"
CountryCodeEnum["CG"] = "CG"
CountryCodeEnum["CH"] = "CH"
CountryCodeEnum["CI"] = "CI"
CountryCodeEnum["CK"] = "CK"
CountryCodeEnum["CL"] = "CL"
CountryCodeEnum["CM"] = "CM"
CountryCodeEnum["CN"] = "CN"
CountryCodeEnum["CO"] = "CO"
CountryCodeEnum["CR"] = "CR"
CountryCodeEnum["CU"] = "CU"
CountryCodeEnum["CV"] = "CV"
CountryCodeEnum["CW"] = "CW"
CountryCodeEnum["CX"] = "CX"
CountryCodeEnum["CY"] = "CY"
CountryCodeEnum["CZ"] = "CZ"
CountryCodeEnum["DE"] = "DE"
CountryCodeEnum["DJ"] = "DJ"
CountryCodeEnum["DK"] = "DK"
CountryCodeEnum["DM"] = "DM"
CountryCodeEnum["DO"] = "DO"
CountryCodeEnum["DZ"] = "DZ"
CountryCodeEnum["EC"] = "EC"
CountryCodeEnum["EE"] = "EE"
CountryCodeEnum["EG"] = "EG"
CountryCodeEnum["EH"] = "EH"
CountryCodeEnum["ER"] = "ER"
CountryCodeEnum["ES"] = "ES"
CountryCodeEnum["ET"] = "ET"
CountryCodeEnum["FI"] = "FI"
CountryCodeEnum["FJ"] = "FJ"
CountryCodeEnum["FK"] = "FK"
CountryCodeEnum["FM"] = "FM"
CountryCodeEnum["FO"] = "FO"
CountryCodeEnum["FR"] = "FR"
CountryCodeEnum["GA"] = "GA"
CountryCodeEnum["GB"] = "GB"
CountryCodeEnum["GD"] = "GD"
CountryCodeEnum["GE"] = "GE"
CountryCodeEnum["GF"] = "GF"
CountryCodeEnum["GG"] = "GG"
CountryCodeEnum["GH"] = "GH"
CountryCodeEnum["GI"] = "GI"
CountryCodeEnum["GL"] = "GL"
CountryCodeEnum["GM"] = "GM"
CountryCodeEnum["GN"] = "GN"
CountryCodeEnum["GP"] = "GP"
CountryCodeEnum["GQ"] = "GQ"
CountryCodeEnum["GR"] = "GR"
CountryCodeEnum["GS"] = "GS"
CountryCodeEnum["GT"] = "GT"
CountryCodeEnum["GU"] = "GU"
CountryCodeEnum["GW"] = "GW"
CountryCodeEnum["GY"] = "GY"
CountryCodeEnum["HK"] = "HK"
CountryCodeEnum["HM"] = "HM"
CountryCodeEnum["HN"] = "HN"
CountryCodeEnum["HR"] = "HR"
CountryCodeEnum["HT"] = "HT"
CountryCodeEnum["HU"] = "HU"
CountryCodeEnum["ID"] = "ID"
CountryCodeEnum["IE"] = "IE"
CountryCodeEnum["IL"] = "IL"
CountryCodeEnum["IM"] = "IM"
CountryCodeEnum["IN"] = "IN"
CountryCodeEnum["IO"] = "IO"
CountryCodeEnum["IQ"] = "IQ"
CountryCodeEnum["IR"] = "IR"
CountryCodeEnum["IS"] = "IS"
CountryCodeEnum["IT"] = "IT"
CountryCodeEnum["JE"] = "JE"
CountryCodeEnum["JM"] = "JM"
CountryCodeEnum["JO"] = "JO"
CountryCodeEnum["JP"] = "JP"
CountryCodeEnum["KE"] = "KE"
CountryCodeEnum["KG"] = "KG"
CountryCodeEnum["KH"] = "KH"
CountryCodeEnum["KI"] = "KI"
CountryCodeEnum["KM"] = "KM"
CountryCodeEnum["KN"] = "KN"
CountryCodeEnum["KP"] = "KP"
CountryCodeEnum["KR"] = "KR"
CountryCodeEnum["KW"] = "KW"
CountryCodeEnum["KY"] = "KY"
CountryCodeEnum["KZ"] = "KZ"
CountryCodeEnum["LA"] = "LA"
CountryCodeEnum["LB"] = "LB"
CountryCodeEnum["LC"] = "LC"
CountryCodeEnum["LI"] = "LI"
CountryCodeEnum["LK"] = "LK"
CountryCodeEnum["LR"] = "LR"
CountryCodeEnum["LS"] = "LS"
CountryCodeEnum["LT"] = "LT"
CountryCodeEnum["LU"] = "LU"
CountryCodeEnum["LV"] = "LV"
CountryCodeEnum["LY"] = "LY"
CountryCodeEnum["MA"] = "MA"
CountryCodeEnum["MC"] = "MC"
CountryCodeEnum["MD"] = "MD"
CountryCodeEnum["ME"] = "ME"
CountryCodeEnum["MF"] = "MF"
CountryCodeEnum["MG"] = "MG"
CountryCodeEnum["MH"] = "MH"
CountryCodeEnum["MK"] = "MK"
CountryCodeEnum["ML"] = "ML"
CountryCodeEnum["MM"] = "MM"
CountryCodeEnum["MN"] = "MN"
CountryCodeEnum["MO"] = "MO"
CountryCodeEnum["MP"] = "MP"
CountryCodeEnum["MQ"] = "MQ"
CountryCodeEnum["MR"] = "MR"
CountryCodeEnum["MS"] = "MS"
CountryCodeEnum["MT"] = "MT"
CountryCodeEnum["MU"] = "MU"
CountryCodeEnum["MV"] = "MV"
CountryCodeEnum["MW"] = "MW"
CountryCodeEnum["MX"] = "MX"
CountryCodeEnum["MY"] = "MY"
CountryCodeEnum["MZ"] = "MZ"
CountryCodeEnum["NA"] = "NA"
CountryCodeEnum["NC"] = "NC"
CountryCodeEnum["NE"] = "NE"
CountryCodeEnum["NF"] = "NF"
CountryCodeEnum["NG"] = "NG"
CountryCodeEnum["NI"] = "NI"
CountryCodeEnum["NL"] = "NL"
CountryCodeEnum["NO"] = "NO"
CountryCodeEnum["NP"] = "NP"
CountryCodeEnum["NR"] = "NR"
CountryCodeEnum["NU"] = "NU"
CountryCodeEnum["NZ"] = "NZ"
CountryCodeEnum["OM"] = "OM"
CountryCodeEnum["PA"] = "PA"
CountryCodeEnum["PE"] = "PE"
CountryCodeEnum["PF"] = "PF"
CountryCodeEnum["PG"] = "PG"
CountryCodeEnum["PH"] = "PH"
CountryCodeEnum["PK"] = "PK"
CountryCodeEnum["PL"] = "PL"
CountryCodeEnum["PM"] = "PM"
CountryCodeEnum["PN"] = "PN"
CountryCodeEnum["PR"] = "PR"
CountryCodeEnum["PS"] = "PS"
CountryCodeEnum["PT"] = "PT"
CountryCodeEnum["PW"] = "PW"
CountryCodeEnum["PY"] = "PY"
CountryCodeEnum["QA"] = "QA"
CountryCodeEnum["RE"] = "RE"
CountryCodeEnum["RO"] = "RO"
CountryCodeEnum["RS"] = "RS"
CountryCodeEnum["RU"] = "RU"
CountryCodeEnum["RW"] = "RW"
CountryCodeEnum["SA"] = "SA"
CountryCodeEnum["SB"] = "SB"
CountryCodeEnum["SC"] = "SC"
CountryCodeEnum["SD"] = "SD"
CountryCodeEnum["SE"] = "SE"
CountryCodeEnum["SG"] = "SG"
CountryCodeEnum["SH"] = "SH"
CountryCodeEnum["SI"] = "SI"
CountryCodeEnum["SJ"] = "SJ"
CountryCodeEnum["SK"] = "SK"
CountryCodeEnum["SL"] = "SL"
CountryCodeEnum["SM"] = "SM"
CountryCodeEnum["SN"] = "SN"
CountryCodeEnum["SO"] = "SO"
CountryCodeEnum["SR"] = "SR"
CountryCodeEnum["SS"] = "SS"
CountryCodeEnum["ST"] = "ST"
CountryCodeEnum["SV"] = "SV"
CountryCodeEnum["SX"] = "SX"
CountryCodeEnum["SY"] = "SY"
CountryCodeEnum["SZ"] = "SZ"
CountryCodeEnum["TC"] = "TC"
CountryCodeEnum["TD"] = "TD"
CountryCodeEnum["TF"] = "TF"
CountryCodeEnum["TG"] = "TG"
CountryCodeEnum["TH"] = "TH"
CountryCodeEnum["TJ"] = "TJ"
CountryCodeEnum["TK"] = "TK"
CountryCodeEnum["TL"] = "TL"
CountryCodeEnum["TM"] = "TM"
CountryCodeEnum["TN"] = "TN"
CountryCodeEnum["TO"] = "TO"
CountryCodeEnum["TR"] = "TR"
CountryCodeEnum["TT"] = "TT"
CountryCodeEnum["TV"] = "TV"
CountryCodeEnum["TW"] = "TW"
CountryCodeEnum["TZ"] = "TZ"
CountryCodeEnum["UA"] = "UA"
CountryCodeEnum["UG"] = "UG"
CountryCodeEnum["UM"] = "UM"
CountryCodeEnum["US"] = "US"
CountryCodeEnum["UY"] = "UY"
CountryCodeEnum["UZ"] = "UZ"
CountryCodeEnum["VA"] = "VA"
CountryCodeEnum["VC"] = "VC"
CountryCodeEnum["VE"] = "VE"
CountryCodeEnum["VG"] = "VG"
CountryCodeEnum["VI"] = "VI"
CountryCodeEnum["VN"] = "VN"
CountryCodeEnum["VU"] = "VU"
CountryCodeEnum["WF"] = "WF"
CountryCodeEnum["WS"] = "WS"
CountryCodeEnum["YE"] = "YE"
CountryCodeEnum["YT"] = "YT"
CountryCodeEnum["ZA"] = "ZA"
CountryCodeEnum["ZM"] = "ZM"
CountryCodeEnum["ZW"] = "ZW"
})(CountryCodeEnum || (CountryCodeEnum = {}));
export class CustomerContactPersonDto {
/** @param {{email?:string,firstName?:string,lastName?:string,phoneNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
email;
/** @type {string} */
firstName;
/** @type {string} */
lastName;
/** @type {string} */
phoneNumber;
}
export class CustomerTargetGroupDto {
/** @param {{id?:string,name?:string,isDefault?:boolean,externalId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {boolean} */
isDefault;
/** @type {string} */
externalId;
}
export class CustomerResult {
/** @param {{countryCode?:CountryCodeEnum,id?:string,name?:string,customerNumber?:number,organizationNumber?:string,email?:string,careOf?:string,address?:string,postalCode?:string,city?:string,electronicInvoiceOperatorCode?:string,electronicInvoiceAddress?:string,customerGroup?:number,contactPerson?:CustomerContactPersonDto,targetGroups?:CustomerTargetGroupDto[],expiryDate?:string,created?:string,externalId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?CountryCodeEnum} */
countryCode;
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {?number} */
customerNumber;
/** @type {string} */
organizationNumber;
/** @type {string} */
email;
/** @type {string} */
careOf;
/** @type {string} */
address;
/** @type {string} */
postalCode;
/** @type {string} */
city;
/** @type {string} */
electronicInvoiceOperatorCode;
/** @type {string} */
electronicInvoiceAddress;
/** @type {?number} */
customerGroup;
/** @type {CustomerContactPersonDto} */
contactPerson;
/** @type {CustomerTargetGroupDto[]} */
targetGroups = [];
/** @type {?string} */
expiryDate;
/** @type {string} */
created;
/** @type {string} */
externalId;
}
export class SearchVossCustomersResponse {
/** @param {{TotalCount?:number,Items?:CustomerResult[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TotalCount;
/** @type {CustomerResult[]} */
Items = [];
}
export class SearchVossCustomers {
/** @param {{OrganizationNumber?:string,CustomerNumber?:number,ExternalId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Organization number to search for. */
OrganizationNumber;
/**
* @type {?number}
* @description Voss customer number to search for. */
CustomerNumber;
/**
* @type {string}
* @description External id to search for. */
ExternalId;
}
JavaScript SearchVossCustomers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"TotalCount":0,"Items":[{}]}