BokaMera.API.Host

CreateSummarizedInvoice

The following routes are available for this service:
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.

// @ts-nocheck

export class SummarizedInvoiceJobResponse
{
    public SummarizedInvoiceId: string;
    public CustomerId: string;
    public CustomerName: string;
    public BookingCount: number;

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

export class CreateSummarizedInvoiceResponse
{
    public TotalCustomersQueued: number;
    public Jobs: SummarizedInvoiceJobResponse[] = [];
    public ResponseStatus: ResponseStatus;

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

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateSummarizedInvoice 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. If null, creates one summarized invoice per customer with eligible bookings. */
    // @ApiMember(Description="Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.")
    public CustomerId?: string;

    /** @description Optional service/event id filter. Only include bookings for this service. */
    // @ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
    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 The terms of payment id from EAccounting. */
    // @ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)
    public TermsOfPaymentId: string;

    /** @description Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType. */
    // @ApiMember(Description="Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.")
    public CreateType?: string;

    /** @description Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. */
    // @ApiMember(Description="Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.")
    public SendType?: EAccountingInvoiceSendTypes;

    /** @description Override corporate identity number for invoice address. */
    // @ApiMember(Description="Override corporate identity number for invoice address.")
    public CorporateIdentityNumber?: string;

    /** @description Override invoice address line 1. */
    // @ApiMember(Description="Override invoice address line 1.")
    public InvoiceAddress1?: string;

    /** @description Override invoice address line 2. */
    // @ApiMember(Description="Override invoice address line 2.")
    public InvoiceAddress2?: string;

    /** @description Override invoice city. */
    // @ApiMember(Description="Override invoice city.")
    public InvoiceCity?: string;

    /** @description Override invoice postal code. */
    // @ApiMember(Description="Override invoice postal code.")
    public InvoicePostalCode?: string;

    /** @description Override invoice country code. */
    // @ApiMember(Description="Override invoice country code.")
    public InvoiceCountryCode?: string;

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

TypeScript CreateSummarizedInvoice 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.

POST /eaccounting/summarizedinvoice HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateSummarizedInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </BookingStatusIds>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CorporateIdentityNumber>String</CorporateIdentityNumber>
  <CreateType>String</CreateType>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <InvoiceAddress1>String</InvoiceAddress1>
  <InvoiceAddress2>String</InvoiceAddress2>
  <InvoiceCity>String</InvoiceCity>
  <InvoiceCountryCode>String</InvoiceCountryCode>
  <InvoicePostalCode>String</InvoicePostalCode>
  <SendType>None</SendType>
  <ServiceId>0</ServiceId>
  <TermsOfPaymentId>String</TermsOfPaymentId>
</CreateSummarizedInvoice>

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

<CreateSummarizedInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Jobs>
    <SummarizedInvoiceJobResponse>
      <BookingCount>0</BookingCount>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <CustomerName>String</CustomerName>
      <SummarizedInvoiceId>00000000-0000-0000-0000-000000000000</SummarizedInvoiceId>
    </SummarizedInvoiceJobResponse>
  </Jobs>
  <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>
  <TotalCustomersQueued>0</TotalCustomersQueued>
</CreateSummarizedInvoiceResponse>