DX STF Client API

<back to all web services

AcknowledgeDebitNote

Debit Note Requests

Debit Note

Requires Authentication
The following routes are available for this service:
PUT/api/debitNote/{DebitNoteId}/acknowledgeAcknowledge debit note as received

/** @description Debit Note */
// @Api(Description="Debit 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)
export class AcknowledgeDebitNote
{
    // @ApiMember(ExcludeInSchema=true, ParameterType="path")
    public debitNoteId: string;

    public constructor(init?: Partial<AcknowledgeDebitNote>) { (Object as any).assign(this, init); }
}

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

{}