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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PreviewCustomerGroup() = 
        member val CustomerId:Guid = new Guid() with get,set
        member val CustomerName:String = null with get,set
        member val Email:String = null with get,set
        member val BookingCount:Int32 = new Int32() with get,set
        member val BookingIds:ResizeArray<Int32> = null with get,set
        member val MissingInvoiceAddress:Boolean = new Boolean() with get,set
        member val MissingEmail:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PreviewSummarizedInvoiceResponse() = 
        member val TotalCustomers:Int32 = new Int32() with get,set
        member val TotalBookings:Int32 = new Int32() with get,set
        member val Customers:ResizeArray<PreviewCustomerGroup> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    type EAccountingInvoiceSendTypes =
        | None = 0
        | AutoInvoiceElectronic = 1
        | AutoInvoicePrint = 2
        | AutoInvoiceB2C = 3

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type PreviewSummarizedInvoice() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Start date for the booking range to include.
        ///</summary>
        [<ApiMember(Description="Start date for the booking range to include.", IsRequired=true)>]
        member val DateFrom:DateTime = new DateTime() with get,set

        ///<summary>
        ///End date for the booking range to include.
        ///</summary>
        [<ApiMember(Description="End date for the booking range to include.", IsRequired=true)>]
        member val DateTo:DateTime = new DateTime() with get,set

        ///<summary>
        ///Optional customer id filter.
        ///</summary>
        [<ApiMember(Description="Optional customer id filter.")>]
        member val CustomerId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Optional service/event id filter.
        ///</summary>
        [<ApiMember(Description="Optional service/event id filter.")>]
        member val ServiceId:Nullable<Int32> = new Nullable<Int32>() with 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.")>]
        member val BookingStatusIds:ResizeArray<Int32> = null with 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.")>]
        member val SendType:Nullable<EAccountingInvoiceSendTypes> = new Nullable<EAccountingInvoiceSendTypes>() with get,set

F# PreviewSummarizedInvoice DTOs

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

HTTP + OTHER

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

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