BokaMera.API.Host

CompanyBillingInformation

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
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} */
    Skip;
    /** @type {?number} */
    Take;
    /** @type {?string} */
    OrderBy;
    /** @type {?string} */
    OrderByDesc;
    /** @type {?string} */
    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,FirstName?:string,LastName?:string,PhoneNumber?: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,UpdatedDate?:string,CreatedDate?:string,CountryId?:string,PaymentTermsDays?:number,VatRegistrationNumber?:string,LicensePlanId?:number,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} */
    FirstName;
    /** @type {?string} */
    LastName;
    /** @type {?string} */
    PhoneNumber;
    /** @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} */
    UpdatedDate;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CountryId;
    /** @type {number} */
    PaymentTermsDays;
    /** @type {?string} */
    VatRegistrationNumber;
    /** @type {number} */
    LicensePlanId;
    /** @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

HTTP + JSON

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"}}}