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 net.servicestack.client.*


open class EAccountingCustomerQuery : EAccountingPagination(), ICompany
{
    var CompanyId:UUID? = null
}

open class EAccountingPagination
{
    /**
    * Page number that will be fetched to e-accounting client; Default 1
    */
    @DataMember(Order=1)
    @ApiMember(Description="Page number that will be fetched to e-accounting client; Default 1")
    var PageNumber:Int? = null

    /**
    * Page size that will be fetched to e-accounting client; Default 75~
    */
    @DataMember(Order=2)
    @ApiMember(Description="Page size that will be fetched to e-accounting client; Default 75~")
    var PageSize:Int? = null
}

open class EAccountingCustomerResponse : CreateEAccountingCustomer()
{
    var Id:String? = null
}

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

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

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

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

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

Kotlin EAccountingCustomerQuery DTOs

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

HTTP + CSV

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