BokaMera.API.Host

<back to all web services

AddBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/billing/company/Add new billing information.Add new billing information.
"use strict";
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 BillingInformationResponse {
    /** @param {{CompanyId?:string,BillingMethodId?:number,Name?:string,Attention?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,CountryId?:string,Email?:string,GLN?:string,ReferenceLine1?:string,ReferenceLine2?:string,PaymentTermsDays?:number,VatRegistrationNumber?:string,BillingMethodOptions?:BillingMethod[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {number}
     * @description The prefered billing method. */
    BillingMethodId;
    /**
     * @type {string}
     * @description The name that should be printed on the billing information, normally this would be your company name. */
    Name;
    /**
     * @type {string}
     * @description If you want to add the attention to the billing address. */
    Attention;
    /**
     * @type {string}
     * @description The street for the billing adress. This is required when having postal invoice as billing method. */
    Street1;
    /**
     * @type {string}
     * @description The street for the billing adress. */
    Street2;
    /**
     * @type {string}
     * @description The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method. */
    ZipCode;
    /**
     * @type {string}
     * @description The city for the billing adress. This is required when having postal invoice as billing method. */
    City;
    /**
     * @type {string}
     * @description The country for the billing adress. This is required when having postal invoice as billing method. */
    CountryId;
    /**
     * @type {string}
     * @description The billing email. This is required when having email invoice as billing method. */
    Email;
    /**
     * @type {string}
     * @description The company global location number. */
    GLN;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine1;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine2;
    /**
     * @type {number}
     * @description The billing payment terms in days. This is default 15 days. */
    PaymentTermsDays;
    /**
     * @type {string}
     * @description The company vat registration number. */
    VatRegistrationNumber;
    /**
     * @type {BillingMethod[]}
     * @description The billing method options to choose from */
    BillingMethodOptions;
}
export class AddBillingInformation {
    /** @param {{CompanyId?:string,BillingMethodId?:number,Name?:string,Attention?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,CountryId?:string,Email?:string,PaymentTermsDays?:number,VatRegistrationNumber?:string,GLN?:string,ReferenceLine1?:string,ReferenceLine2?:string}} [init] */
    constructor(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 {number}
     * @description The prefered billing method. */
    BillingMethodId;
    /**
     * @type {string}
     * @description The name that should be printed on the billing information, normally this would be your company name. */
    Name;
    /**
     * @type {string}
     * @description If you want to add the attention to the billing address. */
    Attention;
    /**
     * @type {string}
     * @description The street for the billing adress. This is required when having postal invoice as billing method. */
    Street1;
    /**
     * @type {string}
     * @description The street for the billing adress. */
    Street2;
    /**
     * @type {string}
     * @description The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method. */
    ZipCode;
    /**
     * @type {string}
     * @description The city for the billing adress. This is required when having postal invoice as billing method. */
    City;
    /**
     * @type {string}
     * @description The country for the billing adress. This is required when having postal invoice as billing method. */
    CountryId;
    /**
     * @type {string}
     * @description The billing email. This is required when having email invoice as billing method. */
    Email;
    /**
     * @type {?number}
     * @description The billing payment terms in days. This is default 15 days. */
    PaymentTermsDays;
    /**
     * @type {string}
     * @description The company vat registration number. */
    VatRegistrationNumber;
    /**
     * @type {string}
     * @description The company global location number. */
    GLN;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine1;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine2;
}

JavaScript AddBillingInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /billing/company/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddBillingInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Attention>String</Attention>
  <BillingMethodId>0</BillingMethodId>
  <City>String</City>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CountryId>String</CountryId>
  <Email>String</Email>
  <GLN>String</GLN>
  <Name>String</Name>
  <PaymentTermsDays>0</PaymentTermsDays>
  <ReferenceLine1>String</ReferenceLine1>
  <ReferenceLine2>String</ReferenceLine2>
  <Street1>String</Street1>
  <Street2>String</Street2>
  <VatRegistrationNumber>String</VatRegistrationNumber>
  <ZipCode>String</ZipCode>
</AddBillingInformation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Attention>String</Attention>
  <BillingMethodId>0</BillingMethodId>
  <BillingMethodOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
    <d2p1:BillingMethod>
      <d2p1:BillingMethodCountriesRelation>
        <d2p1:BillingMethodCountriesRelation>
          <d2p1:BillingMethodId>0</d2p1:BillingMethodId>
          <d2p1:CountryId>String</d2p1:CountryId>
          <d2p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </d2p1:ModifiedDate>
        </d2p1:BillingMethodCountriesRelation>
      </d2p1:BillingMethodCountriesRelation>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:ModifiedDate>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:BillingMethod>
  </BillingMethodOptions>
  <City>String</City>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CountryId>String</CountryId>
  <Email>String</Email>
  <GLN>String</GLN>
  <Name>String</Name>
  <PaymentTermsDays>0</PaymentTermsDays>
  <ReferenceLine1>String</ReferenceLine1>
  <ReferenceLine2>String</ReferenceLine2>
  <Street1>String</Street1>
  <Street2>String</Street2>
  <VatRegistrationNumber>String</VatRegistrationNumber>
  <ZipCode>String</ZipCode>
</BillingInformationResponse>