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.

// @ts-nocheck

export class PreviewCustomerGroup
{
    public CustomerId: string;
    public CustomerName: string;
    public Email?: string;
    public BookingCount: number;
    public BookingIds: number[] = [];
    public MissingInvoiceAddress: boolean;
    public MissingEmail: boolean;

    public constructor(init?: Partial<PreviewCustomerGroup>) { (Object as any).assign(this, init); }
}

export class PreviewSummarizedInvoiceResponse
{
    public TotalCustomers: number;
    public TotalBookings: number;
    public Customers: PreviewCustomerGroup[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PreviewSummarizedInvoiceResponse>) { (Object as any).assign(this, init); }
}

export enum EAccountingInvoiceSendTypes
{
    None = 'None',
    AutoInvoiceElectronic = 'AutoInvoiceElectronic',
    AutoInvoicePrint = 'AutoInvoicePrint',
    AutoInvoiceB2C = 'AutoInvoiceB2C',
}

// @ValidateRequest(Validator="IsAuthenticated")
export class PreviewSummarizedInvoice implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description Start date for the booking range to include. */
    // @ApiMember(Description="Start date for the booking range to include.", IsRequired=true)
    public DateFrom: string;

    /** @description End date for the booking range to include. */
    // @ApiMember(Description="End date for the booking range to include.", IsRequired=true)
    public DateTo: string;

    /** @description Optional customer id filter. */
    // @ApiMember(Description="Optional customer id filter.")
    public CustomerId?: string;

    /** @description Optional service/event id filter. */
    // @ApiMember(Description="Optional service/event id filter.")
    public ServiceId?: number;

    /** @description 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 BookingStatusIds?: number[];

    /** @description 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 SendType?: EAccountingInvoiceSendTypes;

    public constructor(init?: Partial<PreviewSummarizedInvoice>) { (Object as any).assign(this, init); }
}

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