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.

"use strict";
export class SummarizedInvoiceJobResponse {
    /** @param {{SummarizedInvoiceId?:string,CustomerId?:string,CustomerName?:string,BookingCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SummarizedInvoiceId;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    CustomerName;
    /** @type {number} */
    BookingCount;
}
export class CreateSummarizedInvoiceResponse {
    /** @param {{TotalCustomersQueued?:number,Jobs?:SummarizedInvoiceJobResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalCustomersQueued;
    /** @type {SummarizedInvoiceJobResponse[]} */
    Jobs = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
/** @typedef {'None'|'AutoInvoiceElectronic'|'AutoInvoicePrint'|'AutoInvoiceB2C'} */
export var EAccountingInvoiceSendTypes;
(function (EAccountingInvoiceSendTypes) {
    EAccountingInvoiceSendTypes["None"] = "None"
    EAccountingInvoiceSendTypes["AutoInvoiceElectronic"] = "AutoInvoiceElectronic"
    EAccountingInvoiceSendTypes["AutoInvoicePrint"] = "AutoInvoicePrint"
    EAccountingInvoiceSendTypes["AutoInvoiceB2C"] = "AutoInvoiceB2C"
})(EAccountingInvoiceSendTypes || (EAccountingInvoiceSendTypes = {}));
export class CreateSummarizedInvoice {
    /** @param {{CompanyId?:string,DateFrom?:string,DateTo?:string,CustomerId?:string,ServiceId?:number,BookingStatusIds?:number[],TermsOfPaymentId?:string,CreateType?:string,SendType?:EAccountingInvoiceSendTypes,CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description Start date for the booking range to include. */
    DateFrom;
    /**
     * @type {string}
     * @description End date for the booking range to include. */
    DateTo;
    /**
     * @type {?string}
     * @description Optional customer id. If null, creates one summarized invoice per customer with eligible bookings. */
    CustomerId;
    /**
     * @type {?number}
     * @description Optional service/event id filter. Only include bookings for this service. */
    ServiceId;
    /**
     * @type {?number[]}
     * @description Optional list of booking status ids to include. If empty, all statuses are included. */
    BookingStatusIds;
    /**
     * @type {string}
     * @description The terms of payment id from EAccounting. */
    TermsOfPaymentId;
    /**
     * @type {?string}
     * @description Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType. */
    CreateType;
    /**
     * @type {?EAccountingInvoiceSendTypes}
     * @description Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. */
    SendType;
    /**
     * @type {?string}
     * @description Override corporate identity number for invoice address. */
    CorporateIdentityNumber;
    /**
     * @type {?string}
     * @description Override invoice address line 1. */
    InvoiceAddress1;
    /**
     * @type {?string}
     * @description Override invoice address line 2. */
    InvoiceAddress2;
    /**
     * @type {?string}
     * @description Override invoice city. */
    InvoiceCity;
    /**
     * @type {?string}
     * @description Override invoice postal code. */
    InvoicePostalCode;
    /**
     * @type {?string}
     * @description Override invoice country code. */
    InvoiceCountryCode;
}

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