BokaMera.API.Host

PreviewSummarizedInvoice

The following routes are available for this service:
GET	/eaccounting/summarizedinvoice/preview	Preview eligible bookings for summarized invoicing	Returns the customers and booking counts that would be included in a summarized invoice run, without actually creating anything.

**PreviewSummarizedInvoice** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
DateFrom	query	DateTime	Yes	Start date for the booking range to include.
DateTo	query	DateTime	Yes	End date for the booking range to include.
CustomerId	query	Guid?	No	Optional customer id filter.
ServiceId	query	int?	No	Optional service/event id filter.
BookingStatusIds	query	List<int>	No	Optional list of booking status ids to include. If empty, all statuses are included.
SendType	query	EAccountingInvoiceSendTypes?	No	Send type for invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. Used to validate customer addresses for postal delivery.

**EAccountingInvoiceSendTypes** Enum:
None
AutoInvoiceElectronic
AutoInvoicePrint
AutoInvoiceB2C

**PreviewSummarizedInvoiceResponse** Parameters:
Name	Parameter	Data Type	Required
TotalCustomers	form	int	No
TotalBookings	form	int	No
Customers	form	List<PreviewCustomerGroup>	Yes
ResponseStatus	form	ResponseStatus	Yes

**PreviewCustomerGroup** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	Guid	No
CustomerName	form	string	Yes
Email	form	string	No
BookingCount	form	int	No
BookingIds	form	List<int>	Yes
MissingInvoiceAddress	form	bool	No
MissingEmail	form	bool	No

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>