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.*


@ValidateRequest(Validator="IsAuthenticated")
open class QuerySummarizedInvoices : 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.")
    override var CompanyId:UUID? = null

    /**
    * Filter by customer id.
    */
    @ApiMember(Description="Filter by customer id.")
    open var CustomerId:UUID? = null

    /**
    * Filter by date from.
    */
    @ApiMember(Description="Filter by date from.")
    open var DateFrom:Date? = null

    /**
    * Filter by date to.
    */
    @ApiMember(Description="Filter by date to.")
    open var DateTo:Date? = 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).")
    open var Status:SummarizedInvoiceStatus? = null
}

enum class SummarizedInvoiceStatus
{
    Pending,
    Processing,
    Completed,
    Failed,
}

open class QuerySummarizedInvoicesResponse
{
    open var Results:ArrayList<SummarizedInvoiceDetailResponse> = ArrayList<SummarizedInvoiceDetailResponse>()
    open var ResponseStatus:ResponseStatus? = null
}

open class SummarizedInvoiceDetailResponse
{
    open var Id:UUID? = null
    open var CompanyId:UUID? = null
    open var CustomerId:UUID? = null
    open var CustomerName:String? = null
    open var EAccountingInvoiceId:String? = null
    open var Draft:Boolean? = null
    open var DateFrom:Date? = null
    open var DateTo:Date? = null
    open var ServiceId:Int? = null
    open var Status:Int? = null
    open var StatusName:String? = null
    open var ErrorMessage:String? = null
    open var BookingIds:ArrayList<Int> = ArrayList<Int>()
    open var CreatedDate:Date? = null
    open var UpdatedDate:Date? = null
}

Kotlin QuerySummarizedInvoices DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"CustomerName":"String","EAccountingInvoiceId":"String","Draft":false,"ServiceId":0,"Status":0,"StatusName":"String","ErrorMessage":"String","BookingIds":[0]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}