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
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]


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 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 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: List[InvoiceDraftLineQueryResponse] = 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
    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)
    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(QueryData[InvoiceDraftQueryResponse], ICompany):
    booking_id: Optional[int] = None
    include_invoice_lines: bool = False
    include_invoice_notes: bool = False
    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 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: api.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEAccountingDtos.InvoiceDraftQueryResponseWg5EthtI 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.InvoiceDraftQueryResponse>
      <d2p1:BookingId>String</d2p1:BookingId>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerIsPrivatePerson>false</d2p1:CustomerIsPrivatePerson>
      <d2p1:CustomerNumber>String</d2p1:CustomerNumber>
      <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
      <d2p1:DueDate>String</d2p1:DueDate>
      <d2p1:IncludesVat>false</d2p1:IncludesVat>
      <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:InvoiceCustomerName>String</d2p1:InvoiceCustomerName>
      <d2p1:InvoiceDate>String</d2p1:InvoiceDate>
      <d2p1:InvoiceId>00000000-0000-0000-0000-000000000000</d2p1:InvoiceId>
      <d2p1:NoteIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:NoteIds>
      <d2p1:Notes>
        <d2p1:EAccountingDtos.NoteQueryResponse>
          <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:ModifiedUtc>0001-01-01T00:00:00</d2p1:ModifiedUtc>
          <d2p1:Text>String</d2p1:Text>
        </d2p1:EAccountingDtos.NoteQueryResponse>
      </d2p1:Notes>
      <d2p1:Persons>
        <d2p1:EAccountingClientDtos.Person>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Ssn>String</d2p1:Ssn>
        </d2p1:EAccountingClientDtos.Person>
      </d2p1:Persons>
      <d2p1:PriceSign>String</d2p1:PriceSign>
      <d2p1:Rows>
        <d2p1:EAccountingDtos.InvoiceDraftLineQueryResponse>
          <d2p1:AmountNoVat>0</d2p1:AmountNoVat>
          <d2p1:ArticleId>String</d2p1:ArticleId>
          <d2p1:ArticleNumber>String</d2p1:ArticleNumber>
          <d2p1:ContributionMargin>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Percentage>0</d2p1:Percentage>
          </d2p1:ContributionMargin>
          <d2p1:CostCenterItemId1>String</d2p1:CostCenterItemId1>
          <d2p1:CostCenterItemId2>String</d2p1:CostCenterItemId2>
          <d2p1:CostCenterItemId3>String</d2p1:CostCenterItemId3>
          <d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
          <d2p1:GreenTechnologyType>None</d2p1:GreenTechnologyType>
          <d2p1:IsServiceArticle>false</d2p1:IsServiceArticle>
          <d2p1:IsTextRow>false</d2p1:IsTextRow>
          <d2p1:IsVatFree>false</d2p1:IsVatFree>
          <d2p1:IsWorkCost>false</d2p1:IsWorkCost>
          <d2p1:LineNumber>0</d2p1:LineNumber>
          <d2p1:MaterialCosts>0</d2p1:MaterialCosts>
          <d2p1:PercentVat>0</d2p1:PercentVat>
          <d2p1:ProjectId>String</d2p1:ProjectId>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:Text>String</d2p1:Text>
          <d2p1:UnitAbbreviation>String</d2p1:UnitAbbreviation>
          <d2p1:UnitAbbreviationEnglish>String</d2p1:UnitAbbreviationEnglish>
          <d2p1:UnitId>String</d2p1:UnitId>
          <d2p1:UnitPrice>0</d2p1:UnitPrice>
          <d2p1:WorkCostType>0</d2p1:WorkCostType>
          <d2p1:WorkHours>0</d2p1:WorkHours>
        </d2p1:EAccountingDtos.InvoiceDraftLineQueryResponse>
      </d2p1:Rows>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
      <d2p1:TotalVatAmount>0</d2p1:TotalVatAmount>
    </d2p1:EAccountingDtos.InvoiceDraftQueryResponse>
  </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.InvoiceDraftQueryResponseWg5EthtI>