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

namespace DX.Framework.Core.Querying

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type ORDER =
        | ASC = 0
        | DESC = 1

    [<AllowNullLiteral>]
    type SearchInvoiceByDateFilter() = 
        member val FromDate:DateTime = new DateTime() with get,set
        member val ToDate:DateTime = new DateTime() with get,set
        member val ContinuationToken:String = null with get,set
        member val RequestedPage:Int32 = new Int32() with get,set
        member val NumberOfRecordsPerPage:Int32 = new Int32() with get,set
        member val OrderBy:String = null with get,set
        member val Order:ORDER = new ORDER() with get,set

    ///<summary>
    ///Invoice
    ///</summary>
    [<Api(Description="Invoice")>]
    [<ApiResponse(Description="Paged Purchase data", IsDefaultResponse=true, ResponseType=typeof<0, Culture=neutral, PublicKeyToken=null]]>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type SearchSenderInvoice() = 
        ///<summary>
        ///Search query
        ///</summary>
        [<ApiMember(Description="Search query", ParameterType="model")>]
        member val Query:SearchInvoiceByDateFilter = null with get,set

    [<AllowNullLiteral>]
    type PagedQueryResult<T>() = 
        member val StartIndex:Int64 = new Int64() with get,set
        member val EndIndex:Int64 = new Int64() with get,set
        member val NumberOfRecordsReturned:Int32 = new Int32() with get,set
        member val TotalNumberOfPages:Int32 = new Int32() with get,set
        member val TotalNumberOfRecords:Int64 = new Int64() with get,set
        member val Results:ResizeArray<ResultItem<ClaimMessage>> = null with get,set

    [<AllowNullLiteral>]
    type PagedQueryResponseWithToken<T>() = 
        inherit PagedQueryResult<ResultItem<InvoiceMessage>>()
        member val ContinuationToken:String = null with get,set

F# SearchSenderInvoice DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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

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