BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EAccountingInvoiceAddress() = 
        member val CorporateIdentityNumber:String = null with get,set
        member val InvoiceAddress1:String = null with get,set
        member val InvoiceAddress2:String = null with get,set
        member val InvoiceCity:String = null with get,set
        member val InvoicePostalCode:String = null with get,set
        member val InvoiceCountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type EAccountingTermsOfPaymentQueryResponse() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val NameEnglish:String = null with get,set
        member val NumberOfDays:Int32 = new Int32() with get,set
        member val TermsOfPaymentTypeId:Int32 = new Int32() with get,set
        member val TermsOfPaymentTypeText:String = null with get,set
        member val AvailableForSales:Boolean = new Boolean() with get,set
        member val AvailableForPurchase:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CustomerLabelQueryResponse() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type DirectDebitCustomerSettingsQueryResponse() = 
        member val MandateId:String = null with get,set
        member val MandateType:Int32 = new Int32() with get,set
        member val SequenceType:Int32 = new Int32() with get,set
        member val SigningDate:DateTime = new DateTime() with get,set
        member val EndDate:DateTime = new DateTime() with get,set
        member val LatestDirectDebit:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type EAccountingCustomerQueryResponse() = 
        member val Id:String = null with get,set
        member val CustomerNumber:String = null with get,set
        member val CorporateIdentityNumber:String = null with get,set
        member val ContactPersonEmail:String = null with get,set
        member val ContactPersonMobile:String = null with get,set
        member val ContactPersonName:String = null with get,set
        member val ContactPersonPhone:String = null with get,set
        member val CurrencyCode:String = null with get,set
        member val GLN:String = null with get,set
        member val InvoiceCity:String = null with get,set
        member val InvoicePostalCode:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val EmailAddressOrder:String = null with get,set
        member val EmailAddressQuote:String = null with get,set
        member val InvoiceAddress:EAccountingInvoiceAddress = null with get,set
        member val DeliveryCustomerName:String = null with get,set
        member val DeliveryAddress1:String = null with get,set
        member val DeliveryAddress2:String = null with get,set
        member val DeliveryCity:String = null with get,set
        member val DeliveryCountryCode:String = null with get,set
        member val DeliveryPostalCode:String = null with get,set
        member val DeliveryMethodId:String = null with get,set
        member val DeliveryTermId:String = null with get,set
        member val PayToAccountId:String = null with get,set
        member val Name:String = null with get,set
        member val Note:String = null with get,set
        member val ReverseChargeOnConstructionServices:Boolean = new Boolean() with get,set
        member val WebshopCustomerNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MobilePhone:String = null with get,set
        member val Telephone:String = null with get,set
        member val TermsOfPaymentId:String = null with get,set
        member val EAccountingTermsOfPayment:EAccountingTermsOfPaymentQueryResponse = null with get,set
        member val VatNumber:String = null with get,set
        member val WwwAddress:String = null with get,set
        member val LastInvoiceDate:String = null with get,set
        member val IsPrivatePerson:Boolean = new Boolean() with get,set
        member val IsNorthernIreland:Boolean = new Boolean() with get,set
        member val DiscountPercentage:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ChangedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val ForceBookkeepVat:Boolean = new Boolean() with get,set
        member val EdiGlnNumber:String = null with get,set
        member val SalesDocumentLanguage:String = null with get,set
        member val ElectronicAddress:String = null with get,set
        member val ElectronicReference:String = null with get,set
        member val EdiServiceDelivererId:String = null with get,set
        member val AutoInvoiceActivationEmailSentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AutoInvoiceRegistrationRequestSentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EmailAddresses:ResizeArray<String> = null with get,set
        member val CustomerLabels:ResizeArray<CustomerLabelQueryResponse> = null with get,set
        member val MessageThreads:ResizeArray<String> = null with get,set
        member val Notes:ResizeArray<String> = null with get,set
        member val IsFutureInvoiceDateAllowed:Boolean = new Boolean() with get,set
        member val DeliveryBasedVat:Boolean = new Boolean() with get,set
        member val SalesPriceListId:String = null with get,set
        member val Iban:String = null with get,set
        member val DirectDebitCustomerSettings:DirectDebitCustomerSettingsQueryResponse = null with get,set
        member val DiscountAgreementId:String = null with get,set
        member val UnpaidInvoicesAmount:Decimal = new Decimal() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryData<T>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type EAccountingCustomerQuery() = 
        inherit QueryData<EAccountingCustomerQueryResponse>()
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

    [<AllowNullLiteral>]
    type AccessKeyTypeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val KeyType:String = null with get,set
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# EAccountingCustomerQuery DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}