BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
EAccountingCustomerQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EAccountingCustomerQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
CustomerNumberformstringYes
CorporateIdentityNumberformstringYes
ContactPersonEmailformstringYes
ContactPersonMobileformstringYes
ContactPersonNameformstringYes
ContactPersonPhoneformstringYes
CurrencyCodeformstringYes
GLNformstringYes
InvoiceCityformstringYes
InvoicePostalCodeformstringYes
EmailAddressformstringYes
EmailAddressOrderformstringYes
EmailAddressQuoteformstringYes
InvoiceAddressformEAccountingInvoiceAddressYes
DeliveryCustomerNameformstringYes
DeliveryAddress1formstringYes
DeliveryAddress2formstringYes
DeliveryCityformstringYes
DeliveryCountryCodeformstringYes
DeliveryPostalCodeformstringYes
DeliveryMethodIdformstringYes
DeliveryTermIdformstringYes
PayToAccountIdformstringYes
NameformstringYes
NoteformstringYes
ReverseChargeOnConstructionServicesformboolNo
WebshopCustomerNumberformint?No
MobilePhoneformstringYes
TelephoneformstringYes
TermsOfPaymentIdformstringYes
EAccountingTermsOfPaymentformEAccountingTermsOfPaymentQueryResponseYes
VatNumberformstringYes
WwwAddressformstringYes
LastInvoiceDateformstringYes
IsPrivatePersonformboolNo
IsNorthernIrelandformboolNo
DiscountPercentageformdecimal?No
ChangedUtcformDateTime?No
IsActiveformboolNo
ForceBookkeepVatformboolNo
EdiGlnNumberformstringYes
SalesDocumentLanguageformstringYes
ElectronicAddressformstringYes
ElectronicReferenceformstringYes
EdiServiceDelivererIdformstringYes
AutoInvoiceActivationEmailSentDateformDateTime?No
AutoInvoiceRegistrationRequestSentDateformDateTime?No
EmailAddressesformList<string>Yes
CustomerLabelsformList<CustomerLabelQueryResponse>Yes
MessageThreadsformList<string>Yes
NotesformList<string>Yes
IsFutureInvoiceDateAllowedformboolNo
DeliveryBasedVatformboolNo
SalesPriceListIdformstringYes
IbanformstringYes
DirectDebitCustomerSettingsformDirectDebitCustomerSettingsQueryResponseYes
DiscountAgreementIdformstringYes
UnpaidInvoicesAmountformdecimalNo
EAccountingInvoiceAddress Parameters:
NameParameterData TypeRequiredDescription
CorporateIdentityNumberformstringYes
InvoiceAddress1formstringYes
InvoiceAddress2formstringYes
InvoiceCityformstringYes
InvoicePostalCodeformstringYes
InvoiceCountryCodeformstringYes
EAccountingTermsOfPaymentQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
NameformstringYes
NameEnglishformstringYes
NumberOfDaysformintNo
TermsOfPaymentTypeIdformintNo
TermsOfPaymentTypeTextformstringYes
AvailableForSalesformboolNo
AvailableForPurchaseformboolNo
CustomerLabelQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
NameformstringYes
DescriptionformstringYes
DirectDebitCustomerSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
MandateIdformstringYes
MandateTypeformintNo
SequenceTypeformintNo
SigningDateformDateTimeNo
EndDateformDateTimeNo
LatestDirectDebitformDateTimeNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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"}}}