DX STF Client API

<back to all web services

UpdateCreditNoteClientProcessed

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
PUT/api/creditNote/{CreditNoteId}/processedUpdate credit 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.*


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

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

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

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

Kotlin UpdateCreditNoteClientProcessed DTOs

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

HTTP + JSV

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

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

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

{
	
}