| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ValidateRequest(Validator="IsAuthenticated")
open class PreviewSummarizedInvoice : ICompany
{
/**
* 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.")
override var CompanyId:UUID? = null
/**
* Start date for the booking range to include.
*/
@ApiMember(Description="Start date for the booking range to include.", IsRequired=true)
open var DateFrom:Date? = null
/**
* End date for the booking range to include.
*/
@ApiMember(Description="End date for the booking range to include.", IsRequired=true)
open var DateTo:Date? = null
/**
* Optional customer id filter.
*/
@ApiMember(Description="Optional customer id filter.")
open var CustomerId:UUID? = null
/**
* Optional service/event id filter.
*/
@ApiMember(Description="Optional service/event id filter.")
open var ServiceId:Int? = null
/**
* 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.")
open var BookingStatusIds:ArrayList<Int>? = null
/**
* Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.
*/
@ApiMember(Description="Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.")
open var SendType:EAccountingInvoiceSendTypes? = null
}
enum class EAccountingInvoiceSendTypes
{
None,
AutoInvoiceElectronic,
AutoInvoicePrint,
AutoInvoiceB2C,
}
open class PreviewSummarizedInvoiceResponse
{
open var TotalCustomers:Int? = null
open var TotalBookings:Int? = null
open var Customers:ArrayList<PreviewCustomerGroup> = ArrayList<PreviewCustomerGroup>()
open var ResponseStatus:ResponseStatus? = null
}
open class PreviewCustomerGroup
{
open var CustomerId:UUID? = null
open var CustomerName:String? = null
open var Email:String? = null
open var BookingCount:Int? = null
open var BookingIds:ArrayList<Int> = ArrayList<Int>()
open var MissingInvoiceAddress:Boolean? = null
open var MissingEmail:Boolean? = null
}
Kotlin PreviewSummarizedInvoice 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.
GET /eaccounting/summarizedinvoice/preview HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}