BokaMera.API.Host

CreateSummarizedInvoice

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateSummarizedInvoice : 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. 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.")
    public var customerId:String?

    /**
    * Optional service/event id filter. Only include bookings for this service.
    */
    // @ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
    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]

    /**
    * The terms of payment id from EAccounting.
    */
    // @ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)
    public var termsOfPaymentId:String

    /**
    * 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.")
    public var createType:String

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

    /**
    * Override corporate identity number for invoice address.
    */
    // @ApiMember(Description="Override corporate identity number for invoice address.")
    public var corporateIdentityNumber:String

    /**
    * Override invoice address line 1.
    */
    // @ApiMember(Description="Override invoice address line 1.")
    public var invoiceAddress1:String

    /**
    * Override invoice address line 2.
    */
    // @ApiMember(Description="Override invoice address line 2.")
    public var invoiceAddress2:String

    /**
    * Override invoice city.
    */
    // @ApiMember(Description="Override invoice city.")
    public var invoiceCity:String

    /**
    * Override invoice postal code.
    */
    // @ApiMember(Description="Override invoice postal code.")
    public var invoicePostalCode:String

    /**
    * Override invoice country code.
    */
    // @ApiMember(Description="Override invoice country code.")
    public var invoiceCountryCode:String

    required public init(){}
}

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

public class CreateSummarizedInvoiceResponse : Codable
{
    public var totalCustomersQueued:Int
    public var jobs:[SummarizedInvoiceJobResponse] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SummarizedInvoiceJobResponse : Codable
{
    public var summarizedInvoiceId:String
    public var customerId:String
    public var customerName:String
    public var bookingCount:Int

    required public init(){}
}

Swift CreateSummarizedInvoice 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.

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