DX STF Client API

<back to all web services

UpdateDebitNoteClientProcessed

Debit Note Requests

Debit Note

Requires Authentication
The following routes are available for this service:
PUT/api/debitNote/{DebitNoteId}/processedUpdate debit note as customer processed, will also acknowledge credit note if not yet set.
namespace DX.Framework.Core.Commands.Dto

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

    [<AllowNullLiteral>]
    type TokenDto() = 
        member val Token:Guid = new Guid() with get,set

    ///<summary>
    ///Debit Note
    ///</summary>
    [<Api(Description="Debit Note")>]
    [<ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof<TokenDto>, StatusCode=202)>]
    [<AllowNullLiteral>]
    type UpdateDebitNoteClientProcessed() = 
        ///<summary>
        ///Debit Note ID or Token
        ///</summary>
        [<ApiMember(Description="Debit Note ID or Token", ParameterType="path")>]
        member val DebitNoteId:Guid = new Guid() with get,set

        ///<summary>
        ///Customer debit note reference in destination system
        ///</summary>
        [<ApiMember(Description="Customer debit note reference in destination system")>]
        member val CustomerReference:String = null with get,set

        ///<summary>
        ///Date and Time debit note was processed in destination system
        ///</summary>
        [<ApiMember(Description="Date and Time debit note was processed in destination system")>]
        member val CustomerProcessedDate:DateTime = new DateTime() with get,set

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

PUT /api/debitNote/{DebitNoteId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}