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 .xml suffix or ?format=xml

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PreviewSummarizedInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Customers>
    <PreviewCustomerGroup>
      <BookingCount>0</BookingCount>
      <BookingIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </BookingIds>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <CustomerName>String</CustomerName>
      <Email>String</Email>
      <MissingEmail>false</MissingEmail>
      <MissingInvoiceAddress>false</MissingInvoiceAddress>
    </PreviewCustomerGroup>
  </Customers>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TotalBookings>0</TotalBookings>
  <TotalCustomers>0</TotalCustomers>
</PreviewSummarizedInvoiceResponse>