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 .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.bookmore.com 
Accept: application/json

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

{"Offset":0,"Total":0,"Results":[{"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":{"CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"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}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}