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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class PreviewCustomerGroup
    {
        public virtual Guid CustomerId { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string? Email { get; set; }
        public virtual int BookingCount { get; set; }
        public virtual List<int> BookingIds { get; set; } = [];
        public virtual bool MissingInvoiceAddress { get; set; }
        public virtual bool MissingEmail { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class PreviewSummarizedInvoice
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Start date for the booking range to include.
        ///</summary>
        [ApiMember(Description="Start date for the booking range to include.", IsRequired=true)]
        public virtual DateTime DateFrom { get; set; }

        ///<summary>
        ///End date for the booking range to include.
        ///</summary>
        [ApiMember(Description="End date for the booking range to include.", IsRequired=true)]
        public virtual DateTime DateTo { get; set; }

        ///<summary>
        ///Optional customer id filter.
        ///</summary>
        [ApiMember(Description="Optional customer id filter.")]
        public virtual Guid? CustomerId { get; set; }

        ///<summary>
        ///Optional service/event id filter.
        ///</summary>
        [ApiMember(Description="Optional service/event id filter.")]
        public virtual int? ServiceId { get; set; }

        ///<summary>
        ///Optional list of booking status ids to include. If empty, all statuses are included.
        ///</summary>
        [ApiMember(Description="Optional list of booking status ids to include. If empty, all statuses are included.")]
        public virtual List<int>? BookingStatusIds { get; set; }

        ///<summary>
        ///Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.
        ///</summary>
        [ApiMember(Description="Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.")]
        public virtual EAccountingInvoiceSendTypes? SendType { get; set; }
    }

    public partial class PreviewSummarizedInvoiceResponse
    {
        public virtual int TotalCustomers { get; set; }
        public virtual int TotalBookings { get; set; }
        public virtual List<PreviewCustomerGroup> Customers { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# PreviewSummarizedInvoice DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

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