BokaMera.API.Host

<back to all web services

PreviewSummarizedInvoice

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoice/previewPreview eligible bookings for summarized invoicingReturns the customers and booking counts that would be included in a summarized invoice run, without actually creating anything.
"use strict";
export class PreviewCustomerGroup {
    /** @param {{CustomerId?:string,CustomerName?:string,Email?:string,BookingCount?:number,BookingIds?:number[],MissingInvoiceAddress?:boolean,MissingEmail?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    CustomerName;
    /** @type {?string} */
    Email;
    /** @type {number} */
    BookingCount;
    /** @type {number[]} */
    BookingIds = [];
    /** @type {boolean} */
    MissingInvoiceAddress;
    /** @type {boolean} */
    MissingEmail;
}
export class PreviewSummarizedInvoiceResponse {
    /** @param {{TotalCustomers?:number,TotalBookings?:number,Customers?:PreviewCustomerGroup[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalCustomers;
    /** @type {number} */
    TotalBookings;
    /** @type {PreviewCustomerGroup[]} */
    Customers = [];
    /** @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 PreviewSummarizedInvoice {
    /** @param {{CompanyId?:string,DateFrom?:string,DateTo?:string,CustomerId?:string,ServiceId?:number,BookingStatusIds?:number[],SendType?:EAccountingInvoiceSendTypes}} [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 filter. */
    CustomerId;
    /**
     * @type {?number}
     * @description Optional service/event id filter. */
    ServiceId;
    /**
     * @type {?number[]}
     * @description Optional list of booking status ids to include. If empty, all statuses are included. */
    BookingStatusIds;
    /**
     * @type {?EAccountingInvoiceSendTypes}
     * @description Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery. */
    SendType;
}

JavaScript PreviewSummarizedInvoice DTOs

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}