BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingPagination:
    # @ApiMember(Description="Page number that will be fetched to e-accounting client; Default 1")
    page_number: Optional[int] = None
    """
    Page number that will be fetched to e-accounting client; Default 1
    """


    # @ApiMember(Description="Page size that will be fetched to e-accounting client; Default 75~")
    page_size: Optional[int] = None
    """
    Page size that will be fetched to e-accounting client; Default 75~
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceAddress:
    corporate_identity_number: Optional[str] = None
    invoice_address1: Optional[str] = None
    invoice_address2: Optional[str] = None
    invoice_city: Optional[str] = None
    invoice_postal_code: Optional[str] = None
    invoice_country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingTermsOfPayment:
    id: Optional[str] = None
    name: Optional[str] = None
    name_english: Optional[str] = None
    number_of_days: int = 0
    terms_of_payment_type_id: int = 0
    terms_of_payment_type_text: Optional[str] = None
    available_for_sales: bool = False
    available_for_purchase: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerLabel:
    id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectDebitCustomerSettings:
    mandate_id: Optional[str] = None
    mandate_type: int = 0
    sequence_type: int = 0
    signing_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    latest_direct_debit: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateEAccountingCustomer(InvoiceAddress):
    customer_number: Optional[str] = None
    contact_person_email: Optional[str] = None
    contact_person_mobile: Optional[str] = None
    contact_person_name: Optional[str] = None
    contact_person_phone: Optional[str] = None
    currency_code: Optional[str] = None
    gln: Optional[str] = None
    email_address: Optional[str] = None
    email_address_order: Optional[str] = None
    email_address_quote: Optional[str] = None
    delivery_customer_name: Optional[str] = None
    delivery_address1: Optional[str] = None
    delivery_address2: Optional[str] = None
    delivery_city: Optional[str] = None
    delivery_country_code: Optional[str] = None
    delivery_postal_code: Optional[str] = None
    delivery_method_id: Optional[str] = None
    delivery_term_id: Optional[str] = None
    pay_to_account_id: Optional[str] = None
    name: Optional[str] = None
    note: Optional[str] = None
    reverse_charge_on_construction_services: bool = False
    webshop_customer_number: Optional[int] = None
    mobile_phone: Optional[str] = None
    telephone: Optional[str] = None
    terms_of_payment_id: Optional[str] = None
    e_accounting_terms_of_payment: Optional[EAccountingTermsOfPayment] = None
    vat_number: Optional[str] = None
    www_address: Optional[str] = None
    last_invoice_date: Optional[str] = None
    is_private_person: bool = False
    is_northern_ireland: bool = False
    discount_percentage: Decimal = decimal.Decimal(0)
    changed_utc: Optional[datetime.datetime] = None
    is_active: bool = False
    force_bookkeep_vat: bool = False
    edi_gln_number: Optional[str] = None
    sales_document_language: Optional[str] = None
    electronic_address: Optional[str] = None
    electronic_reference: Optional[str] = None
    edi_service_deliverer_id: Optional[str] = None
    auto_invoice_activation_email_sent_date: Optional[datetime.datetime] = None
    auto_invoice_registration_request_sent_date: Optional[datetime.datetime] = None
    email_addresses: Optional[List[str]] = None
    customer_labels: Optional[List[CustomerLabel]] = None
    message_threads: Optional[List[str]] = None
    notes: Optional[List[str]] = None
    is_future_invoice_date_allowed: bool = False
    delivery_based_vat: bool = False
    sales_price_list_id: Optional[str] = None
    iban: Optional[str] = None
    direct_debit_customer_settings: Optional[DirectDebitCustomerSettings] = None
    discount_agreement_id: Optional[str] = None
    unpaid_invoices_amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingCustomerResponse(CreateEAccountingCustomer):
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingCustomerQuery(EAccountingPagination, ICompany):
    company_id: Optional[str] = None

Python 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: api.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"}