BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
"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 T {any} */
export class QueryData 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 EAccountingInvoiceAddress {
    /** @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 EAccountingTermsOfPaymentQueryResponse {
    /** @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 CustomerLabelQueryResponse {
    /** @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 DirectDebitCustomerSettingsQueryResponse {
    /** @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 EAccountingCustomerQueryResponse {
    /** @param {{Id?:string,CustomerNumber?:string,CorporateIdentityNumber?:string,ContactPersonEmail?:string,ContactPersonMobile?:string,ContactPersonName?:string,ContactPersonPhone?:string,CurrencyCode?:string,GLN?:string,InvoiceCity?:string,InvoicePostalCode?:string,EmailAddress?:string,EmailAddressOrder?:string,EmailAddressQuote?:string,InvoiceAddress?:EAccountingInvoiceAddress,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?:EAccountingTermsOfPaymentQueryResponse,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?:CustomerLabelQueryResponse[],MessageThreads?:string[],Notes?:string[],IsFutureInvoiceDateAllowed?:boolean,DeliveryBasedVat?:boolean,SalesPriceListId?:string,Iban?:string,DirectDebitCustomerSettings?:DirectDebitCustomerSettingsQueryResponse,DiscountAgreementId?:string,UnpaidInvoicesAmount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CustomerNumber;
    /** @type {string} */
    CorporateIdentityNumber;
    /** @type {string} */
    ContactPersonEmail;
    /** @type {string} */
    ContactPersonMobile;
    /** @type {string} */
    ContactPersonName;
    /** @type {string} */
    ContactPersonPhone;
    /** @type {string} */
    CurrencyCode;
    /** @type {string} */
    GLN;
    /** @type {string} */
    InvoiceCity;
    /** @type {string} */
    InvoicePostalCode;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    EmailAddressOrder;
    /** @type {string} */
    EmailAddressQuote;
    /** @type {EAccountingInvoiceAddress} */
    InvoiceAddress;
    /** @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 {EAccountingTermsOfPaymentQueryResponse} */
    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 {CustomerLabelQueryResponse[]} */
    CustomerLabels = [];
    /** @type {string[]} */
    MessageThreads = [];
    /** @type {string[]} */
    Notes = [];
    /** @type {boolean} */
    IsFutureInvoiceDateAllowed;
    /** @type {boolean} */
    DeliveryBasedVat;
    /** @type {string} */
    SalesPriceListId;
    /** @type {string} */
    Iban;
    /** @type {DirectDebitCustomerSettingsQueryResponse} */
    DirectDebitCustomerSettings;
    /** @type {string} */
    DiscountAgreementId;
    /** @type {number} */
    UnpaidInvoicesAmount;
}
export class EAccountingCustomerQuery extends QueryData {
    /** @param {{CompanyId?:string,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} */
    CompanyId;
}
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 EAccountingCustomerQuery 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.

GET /eaccounting/customers HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEAccountingDtos.EAccountingCustomerQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:EAccountingDtos.EAccountingCustomerQueryResponse>
      <d2p1:AutoInvoiceActivationEmailSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceActivationEmailSentDate>
      <d2p1:AutoInvoiceRegistrationRequestSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceRegistrationRequestSentDate>
      <d2p1:ChangedUtc>0001-01-01T00:00:00</d2p1:ChangedUtc>
      <d2p1:ContactPersonEmail>String</d2p1:ContactPersonEmail>
      <d2p1:ContactPersonMobile>String</d2p1:ContactPersonMobile>
      <d2p1:ContactPersonName>String</d2p1:ContactPersonName>
      <d2p1:ContactPersonPhone>String</d2p1:ContactPersonPhone>
      <d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:CustomerLabels>
        <d2p1:EAccountingDtos.CustomerLabelQueryResponse>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:EAccountingDtos.CustomerLabelQueryResponse>
      </d2p1:CustomerLabels>
      <d2p1:CustomerNumber>String</d2p1:CustomerNumber>
      <d2p1:DeliveryAddress1>String</d2p1:DeliveryAddress1>
      <d2p1:DeliveryAddress2>String</d2p1:DeliveryAddress2>
      <d2p1:DeliveryBasedVat>false</d2p1:DeliveryBasedVat>
      <d2p1:DeliveryCity>String</d2p1:DeliveryCity>
      <d2p1:DeliveryCountryCode>String</d2p1:DeliveryCountryCode>
      <d2p1:DeliveryCustomerName>String</d2p1:DeliveryCustomerName>
      <d2p1:DeliveryMethodId>String</d2p1:DeliveryMethodId>
      <d2p1:DeliveryPostalCode>String</d2p1:DeliveryPostalCode>
      <d2p1:DeliveryTermId>String</d2p1:DeliveryTermId>
      <d2p1:DirectDebitCustomerSettings>
        <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
        <d2p1:LatestDirectDebit>0001-01-01T00:00:00</d2p1:LatestDirectDebit>
        <d2p1:MandateId>String</d2p1:MandateId>
        <d2p1:MandateType>0</d2p1:MandateType>
        <d2p1:SequenceType>0</d2p1:SequenceType>
        <d2p1:SigningDate>0001-01-01T00:00:00</d2p1:SigningDate>
      </d2p1:DirectDebitCustomerSettings>
      <d2p1:DiscountAgreementId>String</d2p1:DiscountAgreementId>
      <d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
      <d2p1:EAccountingTermsOfPayment>
        <d2p1:AvailableForPurchase>false</d2p1:AvailableForPurchase>
        <d2p1:AvailableForSales>false</d2p1:AvailableForSales>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NameEnglish>String</d2p1:NameEnglish>
        <d2p1:NumberOfDays>0</d2p1:NumberOfDays>
        <d2p1:TermsOfPaymentTypeId>0</d2p1:TermsOfPaymentTypeId>
        <d2p1:TermsOfPaymentTypeText>String</d2p1:TermsOfPaymentTypeText>
      </d2p1:EAccountingTermsOfPayment>
      <d2p1:EdiGlnNumber>String</d2p1:EdiGlnNumber>
      <d2p1:EdiServiceDelivererId>String</d2p1:EdiServiceDelivererId>
      <d2p1:ElectronicAddress>String</d2p1:ElectronicAddress>
      <d2p1:ElectronicReference>String</d2p1:ElectronicReference>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:EmailAddressOrder>String</d2p1:EmailAddressOrder>
      <d2p1:EmailAddressQuote>String</d2p1:EmailAddressQuote>
      <d2p1:EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:EmailAddresses>
      <d2p1:ForceBookkeepVat>false</d2p1:ForceBookkeepVat>
      <d2p1:GLN>String</d2p1:GLN>
      <d2p1:Iban>String</d2p1:Iban>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:InvoiceAddress>
        <d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
        <d2p1:InvoiceAddress1>String</d2p1:InvoiceAddress1>
        <d2p1:InvoiceAddress2>String</d2p1:InvoiceAddress2>
        <d2p1:InvoiceCity>String</d2p1:InvoiceCity>
        <d2p1:InvoiceCountryCode>String</d2p1:InvoiceCountryCode>
        <d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
      </d2p1:InvoiceAddress>
      <d2p1:InvoiceCity>String</d2p1:InvoiceCity>
      <d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsFutureInvoiceDateAllowed>false</d2p1:IsFutureInvoiceDateAllowed>
      <d2p1:IsNorthernIreland>false</d2p1:IsNorthernIreland>
      <d2p1:IsPrivatePerson>false</d2p1:IsPrivatePerson>
      <d2p1:LastInvoiceDate>String</d2p1:LastInvoiceDate>
      <d2p1:MessageThreads xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MessageThreads>
      <d2p1:MobilePhone>String</d2p1:MobilePhone>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Notes>
      <d2p1:PayToAccountId>String</d2p1:PayToAccountId>
      <d2p1:ReverseChargeOnConstructionServices>false</d2p1:ReverseChargeOnConstructionServices>
      <d2p1:SalesDocumentLanguage>String</d2p1:SalesDocumentLanguage>
      <d2p1:SalesPriceListId>String</d2p1:SalesPriceListId>
      <d2p1:Telephone>String</d2p1:Telephone>
      <d2p1:TermsOfPaymentId>String</d2p1:TermsOfPaymentId>
      <d2p1:UnpaidInvoicesAmount>0</d2p1:UnpaidInvoicesAmount>
      <d2p1:VatNumber>String</d2p1:VatNumber>
      <d2p1:WebshopCustomerNumber>0</d2p1:WebshopCustomerNumber>
      <d2p1:WwwAddress>String</d2p1:WwwAddress>
    </d2p1:EAccountingDtos.EAccountingCustomerQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfEAccountingDtos.EAccountingCustomerQueryResponseWg5EthtI>