BokaMera.API.Host

<back to all web services

QuerySummarizedInvoices

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoicesList summarized invoices with optional filtersQuery summarized invoices by company, customer, date range, and status.
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)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuerySummarizedInvoicesResponse:
    results: List[SummarizedInvoiceDetailResponse] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


class SummarizedInvoiceStatus(str, Enum):
    PENDING = 'Pending'
    PROCESSING = 'Processing'
    COMPLETED = 'Completed'
    FAILED = 'Failed'


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuerySummarizedInvoices(ICompany):
    # @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.
    """


    # @ApiMember(Description="Filter by customer id.")
    customer_id: Optional[str] = None
    """
    Filter by customer id.
    """


    # @ApiMember(Description="Filter by date from.")
    date_from: Optional[datetime.datetime] = None
    """
    Filter by date from.
    """


    # @ApiMember(Description="Filter by date to.")
    date_to: Optional[datetime.datetime] = None
    """
    Filter by date to.
    """


    # @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
    status: Optional[SummarizedInvoiceStatus] = None
    """
    Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
    """

Python QuerySummarizedInvoices DTOs

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

HTTP + JSV

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

GET /eaccounting/summarizedinvoices HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			CustomerName: String,
			EAccountingInvoiceId: String,
			Draft: False,
			ServiceId: 0,
			Status: 0,
			StatusName: String,
			ErrorMessage: String,
			BookingIds: 
			[
				0
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}