DX STF Client API

GetInvoiceByDateRange

Invoice Requests

Invoice

The following routes are available for this service:
GET	/api/invoice/from/{FromDate}/to/{ToDate}	Get invoice between start and end date

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Invoice
*/
@Api(Description="Invoice")
@ApiResponse(Description="Paged invoice response between start and end date", IsDefaultResponse=true, StatusCode=200)
open class GetInvoiceByDateRange
{
    /**
    * Requested page number, starting at 1
    */
    @ApiMember(Description="Requested page number, starting at 1")
    open var requestedPage:Int? = null

    /**
    * Number of records to return on a page
    */
    @ApiMember(Description="Number of records to return on a page")
    open var numberOfRecordsPerPage:Int? = null

    /**
    * From Date Time
    */
    @ApiMember(Description="From Date Time", ParameterType="path")
    open var fromDate:Date? = null

    /**
    * To Date Time
    */
    @ApiMember(Description="To Date Time", ParameterType="path")
    open var toDate:Date? = null
}

open class PagedQueryResult<T>
{
    open var startIndex:Long? = null
    open var endIndex:Long? = null
    open var numberOfRecordsReturned:Int? = null
    open var totalNumberOfPages:Int? = null
    open var totalNumberOfRecords:Long? = null
    open var results:ArrayList<ResultItem<ClaimMessage>> = ArrayList<ResultItem<ClaimMessage>>()
}

Kotlin GetInvoiceByDateRange 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 /api/invoice/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json

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

{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}