| GET | /eaccounting/summarizedinvoice/preview | Preview eligible bookings for summarized invoicing | Returns the customers and booking counts that would be included in a summarized invoice run, without actually creating anything. |
|---|
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 PreviewCustomerGroup:
customer_id: Optional[str] = None
customer_name: Optional[str] = None
email: Optional[str] = None
booking_count: int = 0
booking_ids: List[int] = field(default_factory=list)
missing_invoice_address: bool = False
missing_email: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PreviewSummarizedInvoiceResponse:
total_customers: int = 0
total_bookings: int = 0
customers: List[PreviewCustomerGroup] = field(default_factory=list)
response_status: Optional[ResponseStatus] = None
class EAccountingInvoiceSendTypes(str, Enum):
NONE = 'None'
AUTO_INVOICE_ELECTRONIC = 'AutoInvoiceElectronic'
AUTO_INVOICE_PRINT = 'AutoInvoicePrint'
AUTO_INVOICE_B2_C = 'AutoInvoiceB2C'
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PreviewSummarizedInvoice(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="Start date for the booking range to include.", IsRequired=true)
date_from: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Start date for the booking range to include.
"""
# @ApiMember(Description="End date for the booking range to include.", IsRequired=true)
date_to: datetime.datetime = datetime.datetime(1, 1, 1)
"""
End date for the booking range to include.
"""
# @ApiMember(Description="Optional customer id filter.")
customer_id: Optional[str] = None
"""
Optional customer id filter.
"""
# @ApiMember(Description="Optional service/event id filter.")
service_id: Optional[int] = None
"""
Optional service/event id filter.
"""
# @ApiMember(Description="Optional list of booking status ids to include. If empty, all statuses are included.")
booking_status_ids: Optional[List[int]] = None
"""
Optional list of booking status ids to include. If empty, all statuses are included.
"""
# @ApiMember(Description="Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.")
send_type: Optional[EAccountingInvoiceSendTypes] = None
"""
Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.
"""
Python PreviewSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /eaccounting/summarizedinvoice/preview HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"TotalCustomers":0,"TotalBookings":0,"Customers":[{"CustomerName":"String","Email":"String","BookingCount":0,"BookingIds":[0],"MissingInvoiceAddress":false,"MissingEmail":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}