BokaMera.API.Host

<back to all web services

QuerySummarizedInvoices

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoicesList summarized invoices with optional filtersQuery summarized invoices by company, customer, date range, and status.
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class QuerySummarizedInvoices implements ICompany
    {
        /**
        * 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 UUID CompanyId = null;

        /**
        * Filter by customer id.
        */
        @ApiMember(Description="Filter by customer id.")
        public UUID CustomerId = null;

        /**
        * Filter by date from.
        */
        @ApiMember(Description="Filter by date from.")
        public Date DateFrom = null;

        /**
        * Filter by date to.
        */
        @ApiMember(Description="Filter by date to.")
        public Date DateTo = null;

        /**
        * 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 SummarizedInvoiceStatus Status = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QuerySummarizedInvoices setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public QuerySummarizedInvoices setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public Date getDateFrom() { return DateFrom; }
        public QuerySummarizedInvoices setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public QuerySummarizedInvoices setDateTo(Date value) { this.DateTo = value; return this; }
        public SummarizedInvoiceStatus getStatus() { return Status; }
        public QuerySummarizedInvoices setStatus(SummarizedInvoiceStatus value) { this.Status = value; return this; }
    }

    public static enum SummarizedInvoiceStatus
    {
        Pending,
        Processing,
        Completed,
        Failed;
    }

    public static class QuerySummarizedInvoicesResponse
    {
        public ArrayList<SummarizedInvoiceDetailResponse> Results = new ArrayList<SummarizedInvoiceDetailResponse>();
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<SummarizedInvoiceDetailResponse> getResults() { return Results; }
        public QuerySummarizedInvoicesResponse setResults(ArrayList<SummarizedInvoiceDetailResponse> value) { this.Results = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QuerySummarizedInvoicesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class SummarizedInvoiceDetailResponse
    {
        public UUID Id = null;
        public UUID CompanyId = null;
        public UUID CustomerId = null;
        public String CustomerName = null;
        public String EAccountingInvoiceId = null;
        public Boolean Draft = null;
        public Date DateFrom = null;
        public Date DateTo = null;
        public Integer ServiceId = null;
        public Integer Status = null;
        public String StatusName = null;
        public String ErrorMessage = null;
        public ArrayList<Integer> BookingIds = new ArrayList<Integer>();
        public Date CreatedDate = null;
        public Date UpdatedDate = null;
        
        public UUID getId() { return Id; }
        public SummarizedInvoiceDetailResponse setId(UUID value) { this.Id = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public SummarizedInvoiceDetailResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public SummarizedInvoiceDetailResponse setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public SummarizedInvoiceDetailResponse setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getEAccountingInvoiceId() { return EAccountingInvoiceId; }
        public SummarizedInvoiceDetailResponse setEAccountingInvoiceId(String value) { this.EAccountingInvoiceId = value; return this; }
        public Boolean isDraft() { return Draft; }
        public SummarizedInvoiceDetailResponse setDraft(Boolean value) { this.Draft = value; return this; }
        public Date getDateFrom() { return DateFrom; }
        public SummarizedInvoiceDetailResponse setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public SummarizedInvoiceDetailResponse setDateTo(Date value) { this.DateTo = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public SummarizedInvoiceDetailResponse setServiceId(Integer value) { this.ServiceId = value; return this; }
        public Integer getStatus() { return Status; }
        public SummarizedInvoiceDetailResponse setStatus(Integer value) { this.Status = value; return this; }
        public String getStatusName() { return StatusName; }
        public SummarizedInvoiceDetailResponse setStatusName(String value) { this.StatusName = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public SummarizedInvoiceDetailResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public ArrayList<Integer> getBookingIds() { return BookingIds; }
        public SummarizedInvoiceDetailResponse setBookingIds(ArrayList<Integer> value) { this.BookingIds = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public SummarizedInvoiceDetailResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getUpdatedDate() { return UpdatedDate; }
        public SummarizedInvoiceDetailResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
    }

}

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