BokaMera.API.Host

<back to all web services

EAccountingInvoiceDraftQuery

The following routes are available for this service:
GET/eaccounting/invoicedrafts
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 InvoiceDraftLineQueryResponse:
    article_number: Optional[str] = None
    article_id: Optional[str] = None
    is_service_article: Optional[bool] = None
    amount_no_vat: Decimal = decimal.Decimal(0)
    percent_vat: Decimal = decimal.Decimal(0)
    line_number: Optional[int] = None
    is_text_row: bool = False
    text: Optional[str] = None
    unit_price: Optional[Decimal] = None
    unit_abbreviation: Optional[str] = None
    unit_abbreviation_english: Optional[str] = None
    discount_percentage: Optional[Decimal] = None
    quantity: Optional[float] = None
    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 Person:
    ssn: Optional[str] = None
    amount: int = 0


@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 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)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceDraftQueryResponse:
    invoice_id: Optional[str] = None
    created_date: Optional[datetime.datetime] = None
    total_amount: Optional[Decimal] = None
    total_vat_amount: Optional[Decimal] = None
    customer_id: Optional[str] = None
    rows: Optional[List[InvoiceDraftLineQueryResponse]] = None
    invoice_date: Optional[str] = None
    due_date: Optional[str] = None
    delivery_date: Optional[datetime.datetime] = None
    persons: Optional[List[Person]] = None
    invoice_customer_name: Optional[str] = None
    invoice_address: Optional[InvoiceAddress] = None
    customer_is_private_person: bool = False
    customer_number: Optional[str] = None
    notes: Optional[List[NoteQueryResponse]] = None
    note_ids: Optional[List[str]] = None
    created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    includes_vat: bool = False
    price_sign: Optional[str] = None
    booking_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EAccountingInvoiceDraftQuery(EAccountingPagination, ICompany):
    booking_id: Optional[int] = None
    include_invoice_lines: bool = False
    include_invoice_notes: bool = False
    company_id: Optional[str] = None

Python EAccountingInvoiceDraftQuery DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /eaccounting/invoicedrafts HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EAccountingDtos.InvoiceDraftQueryResponse 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>
  <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>
  <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>
  <Persons>
    <EAccountingClientDtos.Person>
      <Amount>0</Amount>
      <Ssn>String</Ssn>
    </EAccountingClientDtos.Person>
  </Persons>
  <PriceSign>String</PriceSign>
  <Rows>
    <EAccountingDtos.InvoiceDraftLineQueryResponse>
      <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.InvoiceDraftLineQueryResponse>
  </Rows>
  <TotalAmount>0</TotalAmount>
  <TotalVatAmount>0</TotalVatAmount>
</EAccountingDtos.InvoiceDraftQueryResponse>