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.

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 SummarizedInvoiceDetailResponse() = 
        member val Id:Guid = new Guid() with get,set
        member val CompanyId:Guid = new Guid() with get,set
        member val CustomerId:Guid = new Guid() with get,set
        member val CustomerName:String = null with get,set
        member val EAccountingInvoiceId:String = null with get,set
        member val Draft:Boolean = new Boolean() with get,set
        member val DateFrom:DateTime = new DateTime() with get,set
        member val DateTo:DateTime = new DateTime() with get,set
        member val ServiceId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Status:Int32 = new Int32() with get,set
        member val StatusName:String = null with get,set
        member val ErrorMessage:String = null with get,set
        member val BookingIds:ResizeArray<Int32> = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val UpdatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type QuerySummarizedInvoicesResponse() = 
        member val Results:ResizeArray<SummarizedInvoiceDetailResponse> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    type SummarizedInvoiceStatus =
        | Pending = 0
        | Processing = 1
        | Completed = 2
        | Failed = 3

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type QuerySummarizedInvoices() = 
        ///<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>
        ///Filter by customer id.
        ///</summary>
        [<ApiMember(Description="Filter by customer id.")>]
        member val CustomerId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Filter by date from.
        ///</summary>
        [<ApiMember(Description="Filter by date from.")>]
        member val DateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Filter by date to.
        ///</summary>
        [<ApiMember(Description="Filter by date to.")>]
        member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<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).")>]
        member val Status:Nullable<SummarizedInvoiceStatus> = new Nullable<SummarizedInvoiceStatus>() with get,set

F# 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>