| 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 'package:servicestack/servicestack.dart';
class SummarizedInvoiceJobResponse implements IConvertible
{
String SummarizedInvoiceId = "";
String CustomerId = "";
String CustomerName = "";
int BookingCount = 0;
SummarizedInvoiceJobResponse({this.SummarizedInvoiceId,this.CustomerId,this.CustomerName,this.BookingCount});
SummarizedInvoiceJobResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SummarizedInvoiceId = json['SummarizedInvoiceId'];
CustomerId = json['CustomerId'];
CustomerName = json['CustomerName'];
BookingCount = json['BookingCount'];
return this;
}
Map<String, dynamic> toJson() => {
'SummarizedInvoiceId': SummarizedInvoiceId,
'CustomerId': CustomerId,
'CustomerName': CustomerName,
'BookingCount': BookingCount
};
getTypeName() => "SummarizedInvoiceJobResponse";
TypeContext? context = _ctx;
}
class CreateSummarizedInvoiceResponse implements IConvertible
{
int TotalCustomersQueued = 0;
List<SummarizedInvoiceJobResponse> Jobs = [];
ResponseStatus ResponseStatus;
CreateSummarizedInvoiceResponse({this.TotalCustomersQueued,this.Jobs,this.ResponseStatus});
CreateSummarizedInvoiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
TotalCustomersQueued = json['TotalCustomersQueued'];
Jobs = JsonConverters.fromJson(json['Jobs'],'List<SummarizedInvoiceJobResponse>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'TotalCustomersQueued': TotalCustomersQueued,
'Jobs': JsonConverters.toJson(Jobs,'List<SummarizedInvoiceJobResponse>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "CreateSummarizedInvoiceResponse";
TypeContext? context = _ctx;
}
enum EAccountingInvoiceSendTypes
{
None,
AutoInvoiceElectronic,
AutoInvoicePrint,
AutoInvoiceB2C,
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CreateSummarizedInvoice implements ICompany, IConvertible
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
String? CompanyId;
/**
* Start date for the booking range to include.
*/
// @ApiMember(Description="Start date for the booking range to include.", IsRequired=true)
DateTime DateFrom = DateTime(0);
/**
* End date for the booking range to include.
*/
// @ApiMember(Description="End date for the booking range to include.", IsRequired=true)
DateTime DateTo = DateTime(0);
/**
* Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.
*/
// @ApiMember(Description="Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.")
String? CustomerId;
/**
* Optional service/event id filter. Only include bookings for this service.
*/
// @ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
int? ServiceId;
/**
* Optional list of booking status ids to include. If empty, all statuses are included.
*/
// @ApiMember(Description="Optional list of booking status ids to include. If empty, all statuses are included.")
List<int>? BookingStatusIds;
/**
* The terms of payment id from EAccounting.
*/
// @ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)
String TermsOfPaymentId = "";
/**
* Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.
*/
// @ApiMember(Description="Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.")
String? CreateType;
/**
* Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.
*/
// @ApiMember(Description="Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.")
EAccountingInvoiceSendTypes? SendType;
/**
* Override corporate identity number for invoice address.
*/
// @ApiMember(Description="Override corporate identity number for invoice address.")
String? CorporateIdentityNumber;
/**
* Override invoice address line 1.
*/
// @ApiMember(Description="Override invoice address line 1.")
String? InvoiceAddress1;
/**
* Override invoice address line 2.
*/
// @ApiMember(Description="Override invoice address line 2.")
String? InvoiceAddress2;
/**
* Override invoice city.
*/
// @ApiMember(Description="Override invoice city.")
String? InvoiceCity;
/**
* Override invoice postal code.
*/
// @ApiMember(Description="Override invoice postal code.")
String? InvoicePostalCode;
/**
* Override invoice country code.
*/
// @ApiMember(Description="Override invoice country code.")
String? InvoiceCountryCode;
CreateSummarizedInvoice({this.CompanyId,this.DateFrom,this.DateTo,this.CustomerId,this.ServiceId,this.BookingStatusIds,this.TermsOfPaymentId,this.CreateType,this.SendType,this.CorporateIdentityNumber,this.InvoiceAddress1,this.InvoiceAddress2,this.InvoiceCity,this.InvoicePostalCode,this.InvoiceCountryCode});
CreateSummarizedInvoice.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
DateFrom = JsonConverters.fromJson(json['DateFrom'],'DateTime',context!);
DateTo = JsonConverters.fromJson(json['DateTo'],'DateTime',context!);
CustomerId = json['CustomerId'];
ServiceId = json['ServiceId'];
BookingStatusIds = JsonConverters.fromJson(json['BookingStatusIds'],'List<int>',context!);
TermsOfPaymentId = json['TermsOfPaymentId'];
CreateType = json['CreateType'];
SendType = JsonConverters.fromJson(json['SendType'],'EAccountingInvoiceSendTypes',context!);
CorporateIdentityNumber = json['CorporateIdentityNumber'];
InvoiceAddress1 = json['InvoiceAddress1'];
InvoiceAddress2 = json['InvoiceAddress2'];
InvoiceCity = json['InvoiceCity'];
InvoicePostalCode = json['InvoicePostalCode'];
InvoiceCountryCode = json['InvoiceCountryCode'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'DateFrom': JsonConverters.toJson(DateFrom,'DateTime',context!),
'DateTo': JsonConverters.toJson(DateTo,'DateTime',context!),
'CustomerId': CustomerId,
'ServiceId': ServiceId,
'BookingStatusIds': JsonConverters.toJson(BookingStatusIds,'List<int>',context!),
'TermsOfPaymentId': TermsOfPaymentId,
'CreateType': CreateType,
'SendType': JsonConverters.toJson(SendType,'EAccountingInvoiceSendTypes',context!),
'CorporateIdentityNumber': CorporateIdentityNumber,
'InvoiceAddress1': InvoiceAddress1,
'InvoiceAddress2': InvoiceAddress2,
'InvoiceCity': InvoiceCity,
'InvoicePostalCode': InvoicePostalCode,
'InvoiceCountryCode': InvoiceCountryCode
};
getTypeName() => "CreateSummarizedInvoice";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'SummarizedInvoiceJobResponse': TypeInfo(TypeOf.Class, create:() => SummarizedInvoiceJobResponse()),
'CreateSummarizedInvoiceResponse': TypeInfo(TypeOf.Class, create:() => CreateSummarizedInvoiceResponse()),
'List<SummarizedInvoiceJobResponse>': TypeInfo(TypeOf.Class, create:() => <SummarizedInvoiceJobResponse>[]),
'EAccountingInvoiceSendTypes': TypeInfo(TypeOf.Enum, enumValues:EAccountingInvoiceSendTypes.values),
'CreateSummarizedInvoice': TypeInfo(TypeOf.Class, create:() => CreateSummarizedInvoice()),
});
Dart CreateSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CreateSummarizedInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</BookingStatusIds>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<CreateType>String</CreateType>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
<SendType>None</SendType>
<ServiceId>0</ServiceId>
<TermsOfPaymentId>String</TermsOfPaymentId>
</CreateSummarizedInvoice>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CreateSummarizedInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Jobs>
<SummarizedInvoiceJobResponse>
<BookingCount>0</BookingCount>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>String</CustomerName>
<SummarizedInvoiceId>00000000-0000-0000-0000-000000000000</SummarizedInvoiceId>
</SummarizedInvoiceJobResponse>
</Jobs>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1: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>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1: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>
</d2p1:Meta>
</ResponseStatus>
<TotalCustomersQueued>0</TotalCustomersQueued>
</CreateSummarizedInvoiceResponse>