DX STF Client API

SearchSenderInvoice

Invoice Requests

Invoice

The following routes are available for this service:
POST	/api/invoice/search/sender	Search invoice based on search parameters

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Invoice
*/
@Api(Description="Invoice")
@ApiResponse(Description="Paged Purchase data", IsDefaultResponse=true, ResponseType=0, Culture=neutral, PublicKeyToken=null]]::class, StatusCode=200)
open class SearchSenderInvoice
{
    /**
    * Search query
    */
    @ApiMember(Description="Search query", ParameterType="model")
    open var query:SearchInvoiceByDateFilter? = null
}

open class SearchInvoiceByDateFilter : ISearchInvoiceByDateFilter
{
    override var fromDate:Date? = null
    override var toDate:Date? = null
    override var continuationToken:String? = null
    open var requestedPage:Int? = null
    open var numberOfRecordsPerPage:Int? = null
    open var orderBy:String? = null
    open var order:ORDER? = null
}

enum class ORDER
{
    Asc,
    Desc,
}

open class PagedQueryResponseWithToken<T> : PagedQueryResult<ResultItem<InvoiceMessage>>()
{
    open var continuationToken:String? = 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 SearchSenderInvoice DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/invoice/search/sender HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"query":{"continuationToken":"String","requestedPage":0,"numberOfRecordsPerPage":0,"orderBy":"String","order":"ASC"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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