BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class EAccountingCustomerQuery : QueryData<EAccountingCustomerQueryResponse>(), ICompany
{
    override var CompanyId:UUID? = null
}

open class QueryData<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var Skip:Int? = null

    @DataMember(Order=2)
    open var Take:Int? = null

    @DataMember(Order=3)
    open var OrderBy:String? = null

    @DataMember(Order=4)
    open var OrderByDesc:String? = null

    @DataMember(Order=5)
    open var Include:String? = null

    @DataMember(Order=6)
    open var Fields:String? = null

    @DataMember(Order=7)
    open var Meta:HashMap<String,String>? = null
}

open class EAccountingCustomerQueryResponse
{
    open var Id:String? = null
    open var CustomerNumber:String? = null
    open var CorporateIdentityNumber:String? = null
    open var ContactPersonEmail:String? = null
    open var ContactPersonMobile:String? = null
    open var ContactPersonName:String? = null
    open var ContactPersonPhone:String? = null
    open var CurrencyCode:String? = null
    open var GLN:String? = null
    open var InvoiceCity:String? = null
    open var InvoicePostalCode:String? = null
    open var EmailAddress:String? = null
    open var EmailAddressOrder:String? = null
    open var EmailAddressQuote:String? = null
    open var InvoiceAddress:EAccountingInvoiceAddress? = null
    open var DeliveryCustomerName:String? = null
    open var DeliveryAddress1:String? = null
    open var DeliveryAddress2:String? = null
    open var DeliveryCity:String? = null
    open var DeliveryCountryCode:String? = null
    open var DeliveryPostalCode:String? = null
    open var DeliveryMethodId:String? = null
    open var DeliveryTermId:String? = null
    open var PayToAccountId:String? = null
    open var Name:String? = null
    open var Note:String? = null
    open var ReverseChargeOnConstructionServices:Boolean? = null
    open var WebshopCustomerNumber:Int? = null
    open var MobilePhone:String? = null
    open var Telephone:String? = null
    open var TermsOfPaymentId:String? = null
    open var EAccountingTermsOfPayment:EAccountingTermsOfPaymentQueryResponse? = null
    open var VatNumber:String? = null
    open var WwwAddress:String? = null
    open var LastInvoiceDate:String? = null
    open var IsPrivatePerson:Boolean? = null
    open var IsNorthernIreland:Boolean? = null
    open var DiscountPercentage:BigDecimal? = null
    open var ChangedUtc:Date? = null
    open var IsActive:Boolean? = null
    open var ForceBookkeepVat:Boolean? = null
    open var EdiGlnNumber:String? = null
    open var SalesDocumentLanguage:String? = null
    open var ElectronicAddress:String? = null
    open var ElectronicReference:String? = null
    open var EdiServiceDelivererId:String? = null
    open var AutoInvoiceActivationEmailSentDate:Date? = null
    open var AutoInvoiceRegistrationRequestSentDate:Date? = null
    open var EmailAddresses:ArrayList<String> = ArrayList<String>()
    open var CustomerLabels:ArrayList<CustomerLabelQueryResponse> = ArrayList<CustomerLabelQueryResponse>()
    open var MessageThreads:ArrayList<String> = ArrayList<String>()
    open var Notes:ArrayList<String> = ArrayList<String>()
    open var IsFutureInvoiceDateAllowed:Boolean? = null
    open var DeliveryBasedVat:Boolean? = null
    open var SalesPriceListId:String? = null
    open var Iban:String? = null
    open var DirectDebitCustomerSettings:DirectDebitCustomerSettingsQueryResponse? = null
    open var DiscountAgreementId:String? = null
    open var UnpaidInvoicesAmount:BigDecimal? = null
}

open class EAccountingInvoiceAddress
{
    open var CorporateIdentityNumber:String? = null
    open var InvoiceAddress1:String? = null
    open var InvoiceAddress2:String? = null
    open var InvoiceCity:String? = null
    open var InvoicePostalCode:String? = null
    open var InvoiceCountryCode:String? = null
}

open class EAccountingTermsOfPaymentQueryResponse
{
    open var Id:String? = null
    open var Name:String? = null
    open var NameEnglish:String? = null
    open var NumberOfDays:Int? = null
    open var TermsOfPaymentTypeId:Int? = null
    open var TermsOfPaymentTypeText:String? = null
    open var AvailableForSales:Boolean? = null
    open var AvailableForPurchase:Boolean? = null
}

open class CustomerLabelQueryResponse
{
    open var Id:String? = null
    open var Name:String? = null
    open var Description:String? = null
}

open class DirectDebitCustomerSettingsQueryResponse
{
    open var MandateId:String? = null
    open var MandateType:Int? = null
    open var SequenceType:Int? = null
    open var SigningDate:Date? = null
    open var EndDate:Date? = null
    open var LatestDirectDebit:Date? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var Offset:Int? = null

    @DataMember(Order=2)
    open var Total:Int? = null

    @DataMember(Order=3)
    open var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    open var Id:Int? = null
    open var KeyType:String? = null
    open var Description:String? = null
}

Kotlin 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: testapi.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>