| POST | /eaccounting/summarizedinvoice | Create summarized invoices for customer bookings in a date range | Creates a single invoice per customer covering all their bookings in the specified date range. Processing is async via queue. |
|---|
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 SummarizedInvoiceJobResponse:
summarized_invoice_id: Optional[str] = None
customer_id: Optional[str] = None
customer_name: Optional[str] = None
booking_count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateSummarizedInvoiceResponse:
total_customers_queued: int = 0
jobs: List[SummarizedInvoiceJobResponse] = 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'
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateSummarizedInvoice(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. If null, creates one summarized invoice per customer with eligible bookings.")
customer_id: Optional[str] = None
"""
Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.
"""
# @ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
service_id: Optional[int] = None
"""
Optional service/event id filter. Only include bookings for this service.
"""
# @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="The terms of payment id from EAccounting.", IsRequired=true)
terms_of_payment_id: Optional[str] = None
"""
The terms of payment id from EAccounting.
"""
# @ApiMember(Description="Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.")
create_type: Optional[str] = None
"""
Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.
"""
# @ApiMember(Description="Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.")
send_type: Optional[EAccountingInvoiceSendTypes] = None
"""
Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.
"""
# @ApiMember(Description="Override corporate identity number for invoice address.")
corporate_identity_number: Optional[str] = None
"""
Override corporate identity number for invoice address.
"""
# @ApiMember(Description="Override invoice address line 1.")
invoice_address1: Optional[str] = None
"""
Override invoice address line 1.
"""
# @ApiMember(Description="Override invoice address line 2.")
invoice_address2: Optional[str] = None
"""
Override invoice address line 2.
"""
# @ApiMember(Description="Override invoice city.")
invoice_city: Optional[str] = None
"""
Override invoice city.
"""
# @ApiMember(Description="Override invoice postal code.")
invoice_postal_code: Optional[str] = None
"""
Override invoice postal code.
"""
# @ApiMember(Description="Override invoice country code.")
invoice_country_code: Optional[str] = None
"""
Override invoice country code.
"""
Python CreateSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /eaccounting/summarizedinvoice HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
CustomerId: 00000000-0000-0000-0000-000000000000,
ServiceId: 0,
BookingStatusIds:
[
0
],
TermsOfPaymentId: String,
CreateType: String,
SendType: None,
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TotalCustomersQueued: 0,
Jobs:
[
{
CustomerName: String,
BookingCount: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}