| GET | /eaccounting/invoices |
|---|
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~
"""
class GreenTechnologyType(str, Enum):
NONE = 'None'
SOLAR_CELL_INSTALLATION = 'SolarCellInstallation'
ELECTRIC_ENERGY_STORAGE_INSTALLATION = 'ElectricEnergyStorageInstallation'
ELECTRIC_VEHICLE_CHARGING_POINT_INSTALLATION = 'ElectricVehicleChargingPointInstallation'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionMargin:
amount: Optional[int] = None
percentage: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceLineQueryResponse:
article_number: Optional[str] = None
article_id: Optional[str] = None
is_service_article: bool = False
amount_no_vat: Decimal = decimal.Decimal(0)
percent_vat: Optional[Decimal] = None
line_number: int = 0
is_text_row: bool = False
text: Optional[str] = None
unit_price: Decimal = decimal.Decimal(0)
unit_abbreviation: Optional[str] = None
unit_abbreviation_english: Optional[str] = None
discount_percentage: Decimal = decimal.Decimal(0)
quantity: float = 0.0
is_work_cost: bool = False
is_vat_free: bool = False
cost_center_item_id1: Optional[str] = None
cost_center_item_id2: Optional[str] = None
cost_center_item_id3: Optional[str] = None
unit_id: Optional[str] = None
project_id: Optional[str] = None
work_cost_type: Optional[int] = None
work_hours: Optional[float] = None
material_costs: Optional[Decimal] = None
green_technology_type: Optional[GreenTechnologyType] = None
contribution_margin: Optional[ContributionMargin] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VatSpecificationQueryResponse:
amount_invoice_currency: Decimal = decimal.Decimal(0)
vat_amount_invoice_currency: Decimal = decimal.Decimal(0)
vat_percent: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Person:
ssn: Optional[str] = None
amount: int = 0
@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 NoteQueryResponse:
id: Optional[str] = None
text: Optional[str] = None
created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
modified_utc: datetime.datetime = datetime.datetime(1, 1, 1)
class EAccountingInvoiceSendTypes(str, Enum):
NONE = 'None'
AUTO_INVOICE_ELECTRONIC = 'AutoInvoiceElectronic'
AUTO_INVOICE_PRINT = 'AutoInvoicePrint'
AUTO_INVOICE_B2_C = 'AutoInvoiceB2C'
class PaymentStatus(str, Enum):
PAID = 'Paid'
UNPAID = 'Unpaid'
OVERDUE = 'Overdue'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditedBy:
credit_invoice_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceQueryResponse:
invoice_id: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
total_amount: Decimal = decimal.Decimal(0)
total_vat_amount: Decimal = decimal.Decimal(0)
customer_id: Optional[str] = None
rows: List[InvoiceLineQueryResponse] = field(default_factory=list)
vat_specification: List[VatSpecificationQueryResponse] = field(default_factory=list)
invoice_date: Optional[str] = None
due_date: Optional[str] = None
delivery_date: Optional[datetime.datetime] = None
persons: List[Person] = field(default_factory=list)
invoice_customer_name: Optional[str] = None
invoice_address: Optional[EAccountingInvoiceAddress] = None
customer_is_private_person: bool = False
terms_of_payment_id: Optional[str] = None
terms_of_payment_data: Optional[EAccountingTermsOfPaymentQueryResponse] = None
customer_email: Optional[str] = None
invoice_number: int = 0
customer_number: Optional[str] = None
notes: List[NoteQueryResponse] = field(default_factory=list)
note_ids: List[str] = field(default_factory=list)
created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
modified_utc: datetime.datetime = datetime.datetime(1, 1, 1)
includes_vat: bool = False
send_type: Optional[EAccountingInvoiceSendTypes] = None
is_sold: bool = False
payment_date: Optional[datetime.datetime] = None
payment_status: Optional[PaymentStatus] = None
payment_status_title: Optional[str] = None
credited_by: List[CreditedBy] = field(default_factory=list)
price_sign: Optional[str] = None
booking_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EaccountingInvoiceQuery(EAccountingPagination, ICompany):
booking_id: Optional[int] = None
paid: Optional[bool] = None
include_invoice_lines: bool = False
include_invoice_notes: bool = False
include_payment_term_data: bool = False
include_invoice_address: bool = False
company_id: Optional[str] = None
Python EaccountingInvoiceQuery 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/invoices HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EAccountingDtos.InvoiceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingId>String</BookingId>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
<CreditedBy>
<EAccountingClientDtos.CreditedBy>
<CreditInvoiceId>String</CreditInvoiceId>
</EAccountingClientDtos.CreditedBy>
</CreditedBy>
<CustomerEmail>String</CustomerEmail>
<CustomerId>String</CustomerId>
<CustomerIsPrivatePerson>false</CustomerIsPrivatePerson>
<CustomerNumber>String</CustomerNumber>
<DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
<DueDate>String</DueDate>
<IncludesVat>false</IncludesVat>
<InvoiceAddress>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
</InvoiceAddress>
<InvoiceCustomerName>String</InvoiceCustomerName>
<InvoiceDate>String</InvoiceDate>
<InvoiceId>00000000-0000-0000-0000-000000000000</InvoiceId>
<InvoiceNumber>0</InvoiceNumber>
<IsSold>false</IsSold>
<ModifiedUtc>0001-01-01T00:00:00</ModifiedUtc>
<NoteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NoteIds>
<Notes>
<EAccountingDtos.NoteQueryResponse>
<CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
<Id>String</Id>
<ModifiedUtc>0001-01-01T00:00:00</ModifiedUtc>
<Text>String</Text>
</EAccountingDtos.NoteQueryResponse>
</Notes>
<PaymentDate>0001-01-01T00:00:00</PaymentDate>
<PaymentStatus>Paid</PaymentStatus>
<PaymentStatusTitle>String</PaymentStatusTitle>
<Persons>
<EAccountingClientDtos.Person>
<Amount>0</Amount>
<Ssn>String</Ssn>
</EAccountingClientDtos.Person>
</Persons>
<PriceSign>String</PriceSign>
<Rows>
<EAccountingDtos.InvoiceLineQueryResponse>
<AmountNoVat>0</AmountNoVat>
<ArticleId>String</ArticleId>
<ArticleNumber>String</ArticleNumber>
<ContributionMargin>
<Amount>0</Amount>
<Percentage>0</Percentage>
</ContributionMargin>
<CostCenterItemId1>String</CostCenterItemId1>
<CostCenterItemId2>String</CostCenterItemId2>
<CostCenterItemId3>String</CostCenterItemId3>
<DiscountPercentage>0</DiscountPercentage>
<GreenTechnologyType>None</GreenTechnologyType>
<IsServiceArticle>false</IsServiceArticle>
<IsTextRow>false</IsTextRow>
<IsVatFree>false</IsVatFree>
<IsWorkCost>false</IsWorkCost>
<LineNumber>0</LineNumber>
<MaterialCosts>0</MaterialCosts>
<PercentVat>0</PercentVat>
<ProjectId>String</ProjectId>
<Quantity>0</Quantity>
<Text>String</Text>
<UnitAbbreviation>String</UnitAbbreviation>
<UnitAbbreviationEnglish>String</UnitAbbreviationEnglish>
<UnitId>String</UnitId>
<UnitPrice>0</UnitPrice>
<WorkCostType>0</WorkCostType>
<WorkHours>0</WorkHours>
</EAccountingDtos.InvoiceLineQueryResponse>
</Rows>
<SendType>None</SendType>
<TermsOfPaymentData>
<AvailableForPurchase>false</AvailableForPurchase>
<AvailableForSales>false</AvailableForSales>
<Id>String</Id>
<Name>String</Name>
<NameEnglish>String</NameEnglish>
<NumberOfDays>0</NumberOfDays>
<TermsOfPaymentTypeId>0</TermsOfPaymentTypeId>
<TermsOfPaymentTypeText>String</TermsOfPaymentTypeText>
</TermsOfPaymentData>
<TermsOfPaymentId>String</TermsOfPaymentId>
<TotalAmount>0</TotalAmount>
<TotalVatAmount>0</TotalVatAmount>
<VatSpecification>
<EAccountingDtos.VatSpecificationQueryResponse>
<AmountInvoiceCurrency>0</AmountInvoiceCurrency>
<VatAmountInvoiceCurrency>0</VatAmountInvoiceCurrency>
<VatPercent>0</VatPercent>
</EAccountingDtos.VatSpecificationQueryResponse>
</VatSpecification>
</EAccountingDtos.InvoiceQueryResponse>