DX STF Client API

UpdateCreditNoteClientProcessed

/creditNote

Update credit note as processed

The following routes are available for this service:
PUT	/creditNote/{CreditNoteId}/processed	Update credit note as customer processed, will also acknowledge credit note if not yet set.

// @ts-nocheck

export class TokenDto implements ICommandResponse
{
    public token: string;

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

/** @description Update credit note as processed */
// @Api(Description="Update credit note as processed")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateCreditNoteClientProcessed
{
    // @ApiMember(ExcludeInSchema=true, 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 .other suffix or ?format=other

HTTP + OTHER

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

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

{"customerReference":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}