BokaMera.API.Host

QuerySummarizedInvoices

The following routes are available for this service:
GET	/eaccounting/summarizedinvoices	List summarized invoices with optional filters	Query summarized invoices by company, customer, date range, and status.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class QuerySummarizedInvoices
            Implements 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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''Filter by customer id.
            '''</Summary>
            <ApiMember(Description:="Filter by customer id.")>
            Public Overridable Property CustomerId As Guid?

            '''<Summary>
            '''Filter by date from.
            '''</Summary>
            <ApiMember(Description:="Filter by date from.")>
            Public Overridable Property DateFrom As Date?

            '''<Summary>
            '''Filter by date to.
            '''</Summary>
            <ApiMember(Description:="Filter by date to.")>
            Public Overridable Property DateTo As Date?

            '''<Summary>
            '''Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
            '''</Summary>
            <ApiMember(Description:="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")>
            Public Overridable Property Status As SummarizedInvoiceStatus?
        End Class

        Public Partial Class QuerySummarizedInvoicesResponse
            Public Overridable Property Results As List(Of SummarizedInvoiceDetailResponse) = New List(Of SummarizedInvoiceDetailResponse)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class SummarizedInvoiceDetailResponse
            Public Overridable Property Id As Guid
            Public Overridable Property CompanyId As Guid
            Public Overridable Property CustomerId As Guid
            Public Overridable Property CustomerName As String
            Public Overridable Property EAccountingInvoiceId As String
            Public Overridable Property Draft As Boolean
            Public Overridable Property DateFrom As Date
            Public Overridable Property DateTo As Date
            Public Overridable Property ServiceId As Integer?
            Public Overridable Property Status As Integer
            Public Overridable Property StatusName As String
            Public Overridable Property ErrorMessage As String
            Public Overridable Property BookingIds As List(Of Integer) = New List(Of Integer)
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As Date
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum SummarizedInvoiceStatus
            Pending
            Processing
            Completed
            Failed
        End Enum
    End Namespace
End Namespace

VB.NET QuerySummarizedInvoices 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/summarizedinvoices HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

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

<QuerySummarizedInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <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>
  <Results>
    <SummarizedInvoiceDetailResponse>
      <BookingIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </BookingIds>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <CustomerName>String</CustomerName>
      <DateFrom>0001-01-01T00:00:00</DateFrom>
      <DateTo>0001-01-01T00:00:00</DateTo>
      <Draft>false</Draft>
      <EAccountingInvoiceId>String</EAccountingInvoiceId>
      <ErrorMessage>String</ErrorMessage>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ServiceId>0</ServiceId>
      <Status>0</Status>
      <StatusName>String</StatusName>
      <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
    </SummarizedInvoiceDetailResponse>
  </Results>
</QuerySummarizedInvoicesResponse>