DX STF Client API

UpdateDebitNoteClientProcessed

Debit Note Requests

Debit Note

The following routes are available for this service:
PUT	/api/debitNote/{DebitNoteId}/processed	Update debit note as customer processed, will also acknowledge credit note if not yet set.

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


/**
* Debit Note
*/
@Api(Description="Debit Note")
@ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto::class, StatusCode=202)
open class UpdateDebitNoteClientProcessed
{
    /**
    * Debit Note ID or Token
    */
    @ApiMember(Description="Debit Note ID or Token", ParameterType="path")
    open var debitNoteId:UUID? = null

    /**
    * Customer debit note reference in destination system
    */
    @ApiMember(Description="Customer debit note reference in destination system")
    open var customerReference:String? = null

    /**
    * Date and Time debit note was processed in destination system
    */
    @ApiMember(Description="Date and Time debit note was processed in destination system")
    open var customerProcessedDate:Date? = null
}

open class TokenDto : ICommandResponse
{
    open var token:UUID? = null
}

Kotlin UpdateDebitNoteClientProcessed 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.

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

{"customerReference":"String"}

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

{}