| PUT | /api/creditNote/{CreditNoteId}/processed | Update credit note as customer processed, will also acknowledge credit note if not yet set. |
|---|
export class TokenDto implements ICommandResponse
{
public token: string;
public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}
/** @description Credit Note */
// @Api(Description="Credit Note")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateCreditNoteClientProcessed
{
/** @description Credit Note ID or Token */
// @ApiMember(Description="Credit Note ID or Token", ParameterType="path")
public creditNoteId: string;
/** @description Customer credit note reference in destination system */
// @ApiMember(Description="Customer credit note reference in destination system")
public customerReference: string;
/** @description Date and Time credit note was processed in destination system */
// @ApiMember(Description="Date and Time credit note was processed in destination system")
public customerProcessedDate: string;
public constructor(init?: Partial<UpdateCreditNoteClientProcessed>) { (Object as any).assign(this, init); }
}
TypeScript UpdateCreditNoteClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
{
}