| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateSummarizedInvoice : 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. 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.")
open var CustomerId:UUID? = null
/**
* Optional service/event id filter. Only include bookings for this service.
*/
@ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
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
/**
* The terms of payment id from EAccounting.
*/
@ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)
open var TermsOfPaymentId:String? = null
/**
* 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.")
open var CreateType:String? = null
/**
* 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.")
open var SendType:EAccountingInvoiceSendTypes? = null
/**
* Override corporate identity number for invoice address.
*/
@ApiMember(Description="Override corporate identity number for invoice address.")
open var CorporateIdentityNumber:String? = null
/**
* Override invoice address line 1.
*/
@ApiMember(Description="Override invoice address line 1.")
open var InvoiceAddress1:String? = null
/**
* Override invoice address line 2.
*/
@ApiMember(Description="Override invoice address line 2.")
open var InvoiceAddress2:String? = null
/**
* Override invoice city.
*/
@ApiMember(Description="Override invoice city.")
open var InvoiceCity:String? = null
/**
* Override invoice postal code.
*/
@ApiMember(Description="Override invoice postal code.")
open var InvoicePostalCode:String? = null
/**
* Override invoice country code.
*/
@ApiMember(Description="Override invoice country code.")
open var InvoiceCountryCode:String? = null
}
enum class EAccountingInvoiceSendTypes
{
None,
AutoInvoiceElectronic,
AutoInvoicePrint,
AutoInvoiceB2C,
}
open class CreateSummarizedInvoiceResponse
{
open var TotalCustomersQueued:Int? = null
open var Jobs:ArrayList<SummarizedInvoiceJobResponse> = ArrayList<SummarizedInvoiceJobResponse>()
open var ResponseStatus:ResponseStatus? = null
}
open class SummarizedInvoiceJobResponse
{
open var SummarizedInvoiceId:UUID? = null
open var CustomerId:UUID? = null
open var CustomerName:String? = null
open var BookingCount:Int? = null
}
Kotlin CreateSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
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"}}}