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.

import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class QuerySummarizedInvoices : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * Filter by customer id.
    */
    // @ApiMember(Description="Filter by customer id.")
    public var customerId:String?

    /**
    * Filter by date from.
    */
    // @ApiMember(Description="Filter by date from.")
    public var dateFrom:Date?

    /**
    * Filter by date to.
    */
    // @ApiMember(Description="Filter by date to.")
    public var dateTo:Date?

    /**
    * Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
    */
    // @ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")
    public var status:SummarizedInvoiceStatus?

    required public init(){}
}

public enum SummarizedInvoiceStatus : String, Codable
{
    case Pending
    case Processing
    case Completed
    case Failed
}

public class QuerySummarizedInvoicesResponse : Codable
{
    public var results:[SummarizedInvoiceDetailResponse] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SummarizedInvoiceDetailResponse : Codable
{
    public var id:String
    public var companyId:String
    public var customerId:String
    public var customerName:String
    public var eAccountingInvoiceId:String
    public var draft:Bool
    public var dateFrom:Date
    public var dateTo:Date
    public var serviceId:Int?
    public var status:Int
    public var statusName:String
    public var errorMessage:String
    public var bookingIds:[Int] = []
    public var createdDate:Date
    public var updatedDate:Date

    required public init(){}
}

Swift 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>