| POST | /eaccounting/summarizedinvoice | Create summarized invoices for customer bookings in a date range | Creates a single invoice per customer covering all their bookings in the specified date range. Processing is async via queue. |
|---|
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
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class CreateSummarizedInvoice
: 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. If null, creates one summarized invoice per customer with eligible bookings.
///</summary>
[ApiMember(Description="Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.")]
public virtual Guid? CustomerId { get; set; }
///<summary>
///Optional service/event id filter. Only include bookings for this service.
///</summary>
[ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")]
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>
///The terms of payment id from EAccounting.
///</summary>
[ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)]
public virtual string TermsOfPaymentId { get; set; }
///<summary>
///Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.
///</summary>
[ApiMember(Description="Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.")]
public virtual string? CreateType { get; set; }
///<summary>
///Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.
///</summary>
[ApiMember(Description="Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.")]
public virtual EAccountingInvoiceSendTypes? SendType { get; set; }
///<summary>
///Override corporate identity number for invoice address.
///</summary>
[ApiMember(Description="Override corporate identity number for invoice address.")]
public virtual string? CorporateIdentityNumber { get; set; }
///<summary>
///Override invoice address line 1.
///</summary>
[ApiMember(Description="Override invoice address line 1.")]
public virtual string? InvoiceAddress1 { get; set; }
///<summary>
///Override invoice address line 2.
///</summary>
[ApiMember(Description="Override invoice address line 2.")]
public virtual string? InvoiceAddress2 { get; set; }
///<summary>
///Override invoice city.
///</summary>
[ApiMember(Description="Override invoice city.")]
public virtual string? InvoiceCity { get; set; }
///<summary>
///Override invoice postal code.
///</summary>
[ApiMember(Description="Override invoice postal code.")]
public virtual string? InvoicePostalCode { get; set; }
///<summary>
///Override invoice country code.
///</summary>
[ApiMember(Description="Override invoice country code.")]
public virtual string? InvoiceCountryCode { get; set; }
}
public partial class CreateSummarizedInvoiceResponse
{
public virtual int TotalCustomersQueued { get; set; }
public virtual List<SummarizedInvoiceJobResponse> Jobs { get; set; } = [];
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class SummarizedInvoiceJobResponse
{
public virtual Guid SummarizedInvoiceId { get; set; }
public virtual Guid CustomerId { get; set; }
public virtual string CustomerName { get; set; }
public virtual int BookingCount { get; set; }
}
}
C# CreateSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /eaccounting/summarizedinvoice HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
CustomerId: 00000000-0000-0000-0000-000000000000,
ServiceId: 0,
BookingStatusIds:
[
0
],
TermsOfPaymentId: String,
CreateType: String,
SendType: None,
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TotalCustomersQueued: 0,
Jobs:
[
{
CustomerName: String,
BookingCount: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}