DX STF Client API

<back to all web services

AcknowledgeCreditNote

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
PUT/api/creditNote/{CreditNoteId}/acknowledgeAcknowledge credit note as received
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Credit Note
*/
@Api(Description="Credit Note")
@ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)
// @ApiResponse(Description="GLN does not have required access", StatusCode=403)
// @ApiResponse(Description="Document not found", StatusCode=404)
open class AcknowledgeCreditNote
{
    @ApiMember(ExcludeInSchema=true, ParameterType="path")
    open var creditNoteId:UUID? = null
}

Kotlin AcknowledgeCreditNote 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/creditNote/{CreditNoteId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}