DX STF Client API

<back to all web services

GetDebitNoteByDateRange

Debit Note Requests

Debit Note

Requires Authentication
The following routes are available for this service:
GET/api/debitNote/from/{FromDate}/to/{ToDate}Get debit note between start and end date
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

    ///<summary>
    ///Debit Note
    ///</summary>
    [<Api(Description="Debit Note")>]
    [<ApiResponse(Description="Paged debit note response between start and end date", IsDefaultResponse=true, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetDebitNoteByDateRange() = 
        ///<summary>
        ///Requested page number, starting at 1
        ///</summary>
        [<ApiMember(Description="Requested page number, starting at 1")>]
        member val RequestedPage:Int32 = new Int32() with get,set

        ///<summary>
        ///Number of records to return on a page
        ///</summary>
        [<ApiMember(Description="Number of records to return on a page")>]
        member val NumberOfRecordsPerPage:Int32 = new Int32() with get,set

        ///<summary>
        ///From Date Time
        ///</summary>
        [<ApiMember(Description="From Date Time", ParameterType="path")>]
        member val FromDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///To Date Time
        ///</summary>
        [<ApiMember(Description="To Date Time", ParameterType="path")>]
        member val ToDate:DateTime = new DateTime() 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

F# GetDebitNoteByDateRange 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.

GET /api/debitNote/from/{FromDate}/to/{ToDate} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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