| 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
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
skip: Optional[int] = None
take: Optional[int] = None
order_by: Optional[str] = None
order_by_desc: Optional[str] = None
include: Optional[str] = None
fields: Optional[str] = None
meta: Optional[Dict[str, str]] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryData(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
@staticmethod
def response_type(): return QueryResponse[T]
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingInvoiceAddress:
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 EAccountingTermsOfPaymentQueryResponse:
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 CustomerLabelQueryResponse:
id: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DirectDebitCustomerSettingsQueryResponse:
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 EAccountingCustomerQueryResponse:
id: Optional[str] = None
customer_number: Optional[str] = None
corporate_identity_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
invoice_city: Optional[str] = None
invoice_postal_code: Optional[str] = None
email_address: Optional[str] = None
email_address_order: Optional[str] = None
email_address_quote: Optional[str] = None
invoice_address: Optional[EAccountingInvoiceAddress] = 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[EAccountingTermsOfPaymentQueryResponse] = 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: Optional[Decimal] = None
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: List[str] = field(default_factory=list)
customer_labels: List[CustomerLabelQueryResponse] = field(default_factory=list)
message_threads: List[str] = field(default_factory=list)
notes: List[str] = field(default_factory=list)
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[DirectDebitCustomerSettingsQueryResponse] = 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 EAccountingCustomerQuery(QueryData[EAccountingCustomerQueryResponse], ICompany):
company_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
id: int = 0
key_type: Optional[str] = None
description: Optional[str] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: int = 0
total: int = 0
results: List[AccessKeyTypeResponse] = field(default_factory=list)
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
Python EAccountingCustomerQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfEAccountingDtos.EAccountingCustomerQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:EAccountingDtos.EAccountingCustomerQueryResponse>
<d2p1:AutoInvoiceActivationEmailSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceActivationEmailSentDate>
<d2p1:AutoInvoiceRegistrationRequestSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceRegistrationRequestSentDate>
<d2p1:ChangedUtc>0001-01-01T00:00:00</d2p1:ChangedUtc>
<d2p1:ContactPersonEmail>String</d2p1:ContactPersonEmail>
<d2p1:ContactPersonMobile>String</d2p1:ContactPersonMobile>
<d2p1:ContactPersonName>String</d2p1:ContactPersonName>
<d2p1:ContactPersonPhone>String</d2p1:ContactPersonPhone>
<d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
<d2p1:CurrencyCode>String</d2p1:CurrencyCode>
<d2p1:CustomerLabels>
<d2p1:EAccountingDtos.CustomerLabelQueryResponse>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:EAccountingDtos.CustomerLabelQueryResponse>
</d2p1:CustomerLabels>
<d2p1:CustomerNumber>String</d2p1:CustomerNumber>
<d2p1:DeliveryAddress1>String</d2p1:DeliveryAddress1>
<d2p1:DeliveryAddress2>String</d2p1:DeliveryAddress2>
<d2p1:DeliveryBasedVat>false</d2p1:DeliveryBasedVat>
<d2p1:DeliveryCity>String</d2p1:DeliveryCity>
<d2p1:DeliveryCountryCode>String</d2p1:DeliveryCountryCode>
<d2p1:DeliveryCustomerName>String</d2p1:DeliveryCustomerName>
<d2p1:DeliveryMethodId>String</d2p1:DeliveryMethodId>
<d2p1:DeliveryPostalCode>String</d2p1:DeliveryPostalCode>
<d2p1:DeliveryTermId>String</d2p1:DeliveryTermId>
<d2p1:DirectDebitCustomerSettings>
<d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
<d2p1:LatestDirectDebit>0001-01-01T00:00:00</d2p1:LatestDirectDebit>
<d2p1:MandateId>String</d2p1:MandateId>
<d2p1:MandateType>0</d2p1:MandateType>
<d2p1:SequenceType>0</d2p1:SequenceType>
<d2p1:SigningDate>0001-01-01T00:00:00</d2p1:SigningDate>
</d2p1:DirectDebitCustomerSettings>
<d2p1:DiscountAgreementId>String</d2p1:DiscountAgreementId>
<d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
<d2p1:EAccountingTermsOfPayment>
<d2p1:AvailableForPurchase>false</d2p1:AvailableForPurchase>
<d2p1:AvailableForSales>false</d2p1:AvailableForSales>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:NameEnglish>String</d2p1:NameEnglish>
<d2p1:NumberOfDays>0</d2p1:NumberOfDays>
<d2p1:TermsOfPaymentTypeId>0</d2p1:TermsOfPaymentTypeId>
<d2p1:TermsOfPaymentTypeText>String</d2p1:TermsOfPaymentTypeText>
</d2p1:EAccountingTermsOfPayment>
<d2p1:EdiGlnNumber>String</d2p1:EdiGlnNumber>
<d2p1:EdiServiceDelivererId>String</d2p1:EdiServiceDelivererId>
<d2p1:ElectronicAddress>String</d2p1:ElectronicAddress>
<d2p1:ElectronicReference>String</d2p1:ElectronicReference>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmailAddressOrder>String</d2p1:EmailAddressOrder>
<d2p1:EmailAddressQuote>String</d2p1:EmailAddressQuote>
<d2p1:EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:EmailAddresses>
<d2p1:ForceBookkeepVat>false</d2p1:ForceBookkeepVat>
<d2p1:GLN>String</d2p1:GLN>
<d2p1:Iban>String</d2p1:Iban>
<d2p1:Id>String</d2p1:Id>
<d2p1:InvoiceAddress>
<d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
<d2p1:InvoiceAddress1>String</d2p1:InvoiceAddress1>
<d2p1:InvoiceAddress2>String</d2p1:InvoiceAddress2>
<d2p1:InvoiceCity>String</d2p1:InvoiceCity>
<d2p1:InvoiceCountryCode>String</d2p1:InvoiceCountryCode>
<d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
</d2p1:InvoiceAddress>
<d2p1:InvoiceCity>String</d2p1:InvoiceCity>
<d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
<d2p1:IsActive>false</d2p1:IsActive>
<d2p1:IsFutureInvoiceDateAllowed>false</d2p1:IsFutureInvoiceDateAllowed>
<d2p1:IsNorthernIreland>false</d2p1:IsNorthernIreland>
<d2p1:IsPrivatePerson>false</d2p1:IsPrivatePerson>
<d2p1:LastInvoiceDate>String</d2p1:LastInvoiceDate>
<d2p1:MessageThreads xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:MessageThreads>
<d2p1:MobilePhone>String</d2p1:MobilePhone>
<d2p1:Name>String</d2p1:Name>
<d2p1:Note>String</d2p1:Note>
<d2p1:Notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Notes>
<d2p1:PayToAccountId>String</d2p1:PayToAccountId>
<d2p1:ReverseChargeOnConstructionServices>false</d2p1:ReverseChargeOnConstructionServices>
<d2p1:SalesDocumentLanguage>String</d2p1:SalesDocumentLanguage>
<d2p1:SalesPriceListId>String</d2p1:SalesPriceListId>
<d2p1:Telephone>String</d2p1:Telephone>
<d2p1:TermsOfPaymentId>String</d2p1:TermsOfPaymentId>
<d2p1:UnpaidInvoicesAmount>0</d2p1:UnpaidInvoicesAmount>
<d2p1:VatNumber>String</d2p1:VatNumber>
<d2p1:WebshopCustomerNumber>0</d2p1:WebshopCustomerNumber>
<d2p1:WwwAddress>String</d2p1:WwwAddress>
</d2p1:EAccountingDtos.EAccountingCustomerQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfEAccountingDtos.EAccountingCustomerQueryResponseWg5EthtI>