BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
"use strict";
export class EAccountingPagination {
    /** @param {{PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Page number that will be fetched to e-accounting client; Default 1 */
    PageNumber;
    /**
     * @type {?number}
     * @description Page size that will be fetched to e-accounting client; Default 75~ */
    PageSize;
}
export class InvoiceAddress {
    /** @param {{CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CorporateIdentityNumber;
    /** @type {string} */
    InvoiceAddress1;
    /** @type {string} */
    InvoiceAddress2;
    /** @type {string} */
    InvoiceCity;
    /** @type {string} */
    InvoicePostalCode;
    /** @type {string} */
    InvoiceCountryCode;
}
export class EAccountingTermsOfPayment {
    /** @param {{Id?:string,Name?:string,NameEnglish?:string,NumberOfDays?:number,TermsOfPaymentTypeId?:number,TermsOfPaymentTypeText?:string,AvailableForSales?:boolean,AvailableForPurchase?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    NameEnglish;
    /** @type {number} */
    NumberOfDays;
    /** @type {number} */
    TermsOfPaymentTypeId;
    /** @type {string} */
    TermsOfPaymentTypeText;
    /** @type {boolean} */
    AvailableForSales;
    /** @type {boolean} */
    AvailableForPurchase;
}
export class CustomerLabel {
    /** @param {{Id?:string,Name?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
}
export class DirectDebitCustomerSettings {
    /** @param {{MandateId?:string,MandateType?:number,SequenceType?:number,SigningDate?:string,EndDate?:string,LatestDirectDebit?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MandateId;
    /** @type {number} */
    MandateType;
    /** @type {number} */
    SequenceType;
    /** @type {string} */
    SigningDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    LatestDirectDebit;
}
export class CreateEAccountingCustomer extends InvoiceAddress {
    /** @param {{CustomerNumber?:string,ContactPersonEmail?:string,ContactPersonMobile?:string,ContactPersonName?:string,ContactPersonPhone?:string,CurrencyCode?:string,GLN?:string,EmailAddress?:string,EmailAddressOrder?:string,EmailAddressQuote?:string,DeliveryCustomerName?:string,DeliveryAddress1?:string,DeliveryAddress2?:string,DeliveryCity?:string,DeliveryCountryCode?:string,DeliveryPostalCode?:string,DeliveryMethodId?:string,DeliveryTermId?:string,PayToAccountId?:string,Name?:string,Note?:string,ReverseChargeOnConstructionServices?:boolean,WebshopCustomerNumber?:number,MobilePhone?:string,Telephone?:string,TermsOfPaymentId?:string,EAccountingTermsOfPayment?:EAccountingTermsOfPayment,VatNumber?:string,WwwAddress?:string,LastInvoiceDate?:string,IsPrivatePerson?:boolean,IsNorthernIreland?:boolean,DiscountPercentage?:number,ChangedUtc?:string,IsActive?:boolean,ForceBookkeepVat?:boolean,EdiGlnNumber?:string,SalesDocumentLanguage?:string,ElectronicAddress?:string,ElectronicReference?:string,EdiServiceDelivererId?:string,AutoInvoiceActivationEmailSentDate?:string,AutoInvoiceRegistrationRequestSentDate?:string,EmailAddresses?:string[],CustomerLabels?:CustomerLabel[],MessageThreads?:string[],Notes?:string[],IsFutureInvoiceDateAllowed?:boolean,DeliveryBasedVat?:boolean,SalesPriceListId?:string,Iban?:string,DirectDebitCustomerSettings?:DirectDebitCustomerSettings,DiscountAgreementId?:string,UnpaidInvoicesAmount?:number,CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CustomerNumber;
    /** @type {string} */
    ContactPersonEmail;
    /** @type {string} */
    ContactPersonMobile;
    /** @type {string} */
    ContactPersonName;
    /** @type {string} */
    ContactPersonPhone;
    /** @type {string} */
    CurrencyCode;
    /** @type {string} */
    GLN;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    EmailAddressOrder;
    /** @type {string} */
    EmailAddressQuote;
    /** @type {string} */
    DeliveryCustomerName;
    /** @type {string} */
    DeliveryAddress1;
    /** @type {string} */
    DeliveryAddress2;
    /** @type {string} */
    DeliveryCity;
    /** @type {string} */
    DeliveryCountryCode;
    /** @type {string} */
    DeliveryPostalCode;
    /** @type {string} */
    DeliveryMethodId;
    /** @type {string} */
    DeliveryTermId;
    /** @type {string} */
    PayToAccountId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    ReverseChargeOnConstructionServices;
    /** @type {?number} */
    WebshopCustomerNumber;
    /** @type {string} */
    MobilePhone;
    /** @type {string} */
    Telephone;
    /** @type {string} */
    TermsOfPaymentId;
    /** @type {EAccountingTermsOfPayment} */
    EAccountingTermsOfPayment;
    /** @type {string} */
    VatNumber;
    /** @type {string} */
    WwwAddress;
    /** @type {string} */
    LastInvoiceDate;
    /** @type {boolean} */
    IsPrivatePerson;
    /** @type {boolean} */
    IsNorthernIreland;
    /** @type {number} */
    DiscountPercentage;
    /** @type {?string} */
    ChangedUtc;
    /** @type {boolean} */
    IsActive;
    /** @type {boolean} */
    ForceBookkeepVat;
    /** @type {string} */
    EdiGlnNumber;
    /** @type {string} */
    SalesDocumentLanguage;
    /** @type {string} */
    ElectronicAddress;
    /** @type {string} */
    ElectronicReference;
    /** @type {string} */
    EdiServiceDelivererId;
    /** @type {?string} */
    AutoInvoiceActivationEmailSentDate;
    /** @type {?string} */
    AutoInvoiceRegistrationRequestSentDate;
    /** @type {string[]} */
    EmailAddresses;
    /** @type {CustomerLabel[]} */
    CustomerLabels;
    /** @type {string[]} */
    MessageThreads;
    /** @type {string[]} */
    Notes;
    /** @type {boolean} */
    IsFutureInvoiceDateAllowed;
    /** @type {boolean} */
    DeliveryBasedVat;
    /** @type {string} */
    SalesPriceListId;
    /** @type {string} */
    Iban;
    /** @type {DirectDebitCustomerSettings} */
    DirectDebitCustomerSettings;
    /** @type {string} */
    DiscountAgreementId;
    /** @type {number} */
    UnpaidInvoicesAmount;
}
export class EAccountingCustomerResponse extends CreateEAccountingCustomer {
    /** @param {{Id?:string,CustomerNumber?:string,ContactPersonEmail?:string,ContactPersonMobile?:string,ContactPersonName?:string,ContactPersonPhone?:string,CurrencyCode?:string,GLN?:string,EmailAddress?:string,EmailAddressOrder?:string,EmailAddressQuote?:string,DeliveryCustomerName?:string,DeliveryAddress1?:string,DeliveryAddress2?:string,DeliveryCity?:string,DeliveryCountryCode?:string,DeliveryPostalCode?:string,DeliveryMethodId?:string,DeliveryTermId?:string,PayToAccountId?:string,Name?:string,Note?:string,ReverseChargeOnConstructionServices?:boolean,WebshopCustomerNumber?:number,MobilePhone?:string,Telephone?:string,TermsOfPaymentId?:string,EAccountingTermsOfPayment?:EAccountingTermsOfPayment,VatNumber?:string,WwwAddress?:string,LastInvoiceDate?:string,IsPrivatePerson?:boolean,IsNorthernIreland?:boolean,DiscountPercentage?:number,ChangedUtc?:string,IsActive?:boolean,ForceBookkeepVat?:boolean,EdiGlnNumber?:string,SalesDocumentLanguage?:string,ElectronicAddress?:string,ElectronicReference?:string,EdiServiceDelivererId?:string,AutoInvoiceActivationEmailSentDate?:string,AutoInvoiceRegistrationRequestSentDate?:string,EmailAddresses?:string[],CustomerLabels?:CustomerLabel[],MessageThreads?:string[],Notes?:string[],IsFutureInvoiceDateAllowed?:boolean,DeliveryBasedVat?:boolean,SalesPriceListId?:string,Iban?:string,DirectDebitCustomerSettings?:DirectDebitCustomerSettings,DiscountAgreementId?:string,UnpaidInvoicesAmount?:number,CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Id;
}
export class EAccountingCustomerQuery extends EAccountingPagination {
    /** @param {{CompanyId?:string,PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    CompanyId;
}

JavaScript EAccountingCustomerQuery 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 /eaccounting/customers HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":"String","CustomerNumber":"String","ContactPersonEmail":"String","ContactPersonMobile":"String","ContactPersonName":"String","ContactPersonPhone":"String","CurrencyCode":"String","GLN":"String","EmailAddress":"String","EmailAddressOrder":"String","EmailAddressQuote":"String","DeliveryCustomerName":"String","DeliveryAddress1":"String","DeliveryAddress2":"String","DeliveryCity":"String","DeliveryCountryCode":"String","DeliveryPostalCode":"String","DeliveryMethodId":"String","DeliveryTermId":"String","PayToAccountId":"String","Name":"String","Note":"String","ReverseChargeOnConstructionServices":false,"WebshopCustomerNumber":0,"MobilePhone":"String","Telephone":"String","TermsOfPaymentId":"String","EAccountingTermsOfPayment":{"Id":"String","Name":"String","NameEnglish":"String","NumberOfDays":0,"TermsOfPaymentTypeId":0,"TermsOfPaymentTypeText":"String","AvailableForSales":false,"AvailableForPurchase":false},"VatNumber":"String","WwwAddress":"String","LastInvoiceDate":"String","IsPrivatePerson":false,"IsNorthernIreland":false,"DiscountPercentage":0,"ChangedUtc":"0001-01-01T00:00:00","IsActive":false,"ForceBookkeepVat":false,"EdiGlnNumber":"String","SalesDocumentLanguage":"String","ElectronicAddress":"String","ElectronicReference":"String","EdiServiceDelivererId":"String","AutoInvoiceActivationEmailSentDate":"0001-01-01T00:00:00","AutoInvoiceRegistrationRequestSentDate":"0001-01-01T00:00:00","EmailAddresses":["String"],"CustomerLabels":[{"Id":"String","Name":"String","Description":"String"}],"MessageThreads":["String"],"Notes":["String"],"IsFutureInvoiceDateAllowed":false,"DeliveryBasedVat":false,"SalesPriceListId":"String","Iban":"String","DirectDebitCustomerSettings":{"MandateId":"String","MandateType":0,"SequenceType":0},"DiscountAgreementId":"String","UnpaidInvoicesAmount":0,"CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"}