BokaMera.API.Host

PreviewSummarizedInvoice

The following routes are available for this service:
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 Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class PreviewSummarizedInvoice : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

    /**
    * Start date for the booking range to include.
    */
    // @ApiMember(Description="Start date for the booking range to include.", IsRequired=true)
    public var dateFrom:Date

    /**
    * End date for the booking range to include.
    */
    // @ApiMember(Description="End date for the booking range to include.", IsRequired=true)
    public var dateTo:Date

    /**
    * Optional customer id filter.
    */
    // @ApiMember(Description="Optional customer id filter.")
    public var customerId:String?

    /**
    * Optional service/event id filter.
    */
    // @ApiMember(Description="Optional service/event id filter.")
    public var serviceId:Int?

    /**
    * 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.")
    public var bookingStatusIds:[Int]

    /**
    * 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.")
    public var sendType:EAccountingInvoiceSendTypes?

    required public init(){}
}

public enum EAccountingInvoiceSendTypes : String, Codable
{
    case None
    case AutoInvoiceElectronic
    case AutoInvoicePrint
    case AutoInvoiceB2C
}

public class PreviewSummarizedInvoiceResponse : Codable
{
    public var totalCustomers:Int
    public var totalBookings:Int
    public var customers:[PreviewCustomerGroup] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PreviewCustomerGroup : Codable
{
    public var customerId:String
    public var customerName:String
    public var email:String
    public var bookingCount:Int
    public var bookingIds:[Int] = []
    public var missingInvoiceAddress:Bool
    public var missingEmail:Bool

    required public init(){}
}

Swift PreviewSummarizedInvoice DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}