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

/** @description 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)
export class AcknowledgeCreditNote
{
    // @ApiMember(ExcludeInSchema=true, ParameterType="path")
    public creditNoteId: string;

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

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

{
	
}