| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company | Get billing details for the company. | Get billing details for the company. |
|---|
"use strict";
export class QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
Skip;
/**
* @type {?number}
* @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
Take;
/**
* @type {string}
* @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
OrderBy;
/**
* @type {string}
* @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
OrderByDesc;
/**
* @type {string}
* @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
Include;
/** @type {string} */
Fields;
/** @type {{ [index: string]: string; }} */
Meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class BillingMethodQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Countries?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The billing method id */
Id;
/**
* @type {string}
* @description The billing method name */
Name;
/**
* @type {string}
* @description The billing method description */
Description;
/**
* @type {string[]}
* @description The billing method is valid for the following countries */
Countries;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class BillingMethodCountriesRelation extends BaseModel {
/** @param {{BillingMethodId?:number,CountryId?:string,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
BillingMethodId;
/** @type {string} */
CountryId;
/** @type {?string} */
ModifiedDate;
}
export class BillingMethod extends BaseModel {
/** @param {{BillingMethodCountriesRelation?:BillingMethodCountriesRelation[],Name?:string,Description?:string,ModifiedDate?:string,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {BillingMethodCountriesRelation[]} */
BillingMethodCountriesRelation;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {?string} */
ModifiedDate;
/** @type {number} */
Id;
}
export class BillingInformation extends BaseModel {
/** @param {{BillingMethod?:BillingMethod,BillingMethodId?:number,Name?:string,Attention?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,Email?:string,CreditCard?:string,CreditCardHolder?:string,CreditCardNumber?:string,ValidToYear?:number,ValidToMonth?:number,CSV?:string,Updated?:string,Created?:string,CountryId?:string,PaymentTermsDays?:number,VATRegistrationNumber?:string,GLN?:string,ReferenceLine1?:string,ReferenceLine2?:string,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {BillingMethod} */
BillingMethod;
/** @type {number} */
BillingMethodId;
/** @type {string} */
Name;
/** @type {string} */
Attention;
/** @type {string} */
Street1;
/** @type {string} */
Street2;
/** @type {string} */
ZipCode;
/** @type {string} */
City;
/** @type {string} */
Email;
/** @type {string} */
CreditCard;
/** @type {string} */
CreditCardHolder;
/** @type {string} */
CreditCardNumber;
/** @type {?number} */
ValidToYear;
/** @type {?number} */
ValidToMonth;
/** @type {string} */
CSV;
/** @type {string} */
Updated;
/** @type {string} */
Created;
/** @type {string} */
CountryId;
/** @type {number} */
PaymentTermsDays;
/** @type {string} */
VATRegistrationNumber;
/** @type {string} */
GLN;
/** @type {string} */
ReferenceLine1;
/** @type {string} */
ReferenceLine2;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class CompanyBillingInformation extends QueryDb {
/** @param {{CompanyId?:string,IncludeBillingMethodOptions?:boolean,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {boolean}
* @description If you want to include the billing methods to select from */
IncludeBillingMethodOptions;
}
export class AccessKeyTypeResponse {
/** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
KeyType;
/** @type {string} */
Description;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Offset;
/** @type {number} */
Total;
/** @type {T[]} */
Results;
/** @type {{ [index: string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript CompanyBillingInformation 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 /billing/company HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","Countries":["String"]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}