BokaMera.API.Host

<back to all web services

GetSummarizedInvoice

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoice/{Id}Get a single summarized invoice by idReturns the summarized invoice details including associated booking ids.
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 SummarizedInvoiceDetailResponse:
    id: Optional[str] = None
    company_id: Optional[str] = None
    customer_id: Optional[str] = None
    customer_name: Optional[str] = None
    e_accounting_invoice_id: Optional[str] = None
    draft: bool = False
    date_from: datetime.datetime = datetime.datetime(1, 1, 1)
    date_to: datetime.datetime = datetime.datetime(1, 1, 1)
    service_id: Optional[int] = None
    status: int = 0
    status_name: Optional[str] = None
    error_message: Optional[str] = None
    booking_ids: List[int] = field(default_factory=list)
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSummarizedInvoice(ICompany):
    # @ApiMember(Description="The summarized invoice id.", IsRequired=true)
    id: Optional[str] = None
    """
    The summarized invoice id.
    """


    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """

Python GetSummarizedInvoice 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/summarizedinvoice/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SummarizedInvoiceDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </BookingIds>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <CustomerName>String</CustomerName>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <Draft>false</Draft>
  <EAccountingInvoiceId>String</EAccountingInvoiceId>
  <ErrorMessage>String</ErrorMessage>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <ServiceId>0</ServiceId>
  <Status>0</Status>
  <StatusName>String</StatusName>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</SummarizedInvoiceDetailResponse>