DX STF Client API

UpdateInvoiceClientProcessed

Invoice Requests

Invoice

The following routes are available for this service:
PUT	/api/invoice/{InvoiceId}/processed	Update invoice as customer processed, will also acknowledge invoice if not yet set.


export class TokenDto implements ICommandResponse
{
    public token: string;

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

/** @description Invoice */
// @Api(Description="Invoice")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateInvoiceClientProcessed
{
    /** @description Invoice ID or Token */
    // @ApiMember(Description="Invoice ID or Token", ExcludeInSchema=true, ParameterType="path")
    public invoiceId: string;

    /** @description Customer invoice reference in destination system */
    // @ApiMember(Description="Customer invoice reference in destination system")
    public customerReference: string;

    /** @description Date and Time invoice was processed in destination system */
    // @ApiMember(Description="Date and Time invoice was processed in destination system")
    public customerProcessedDate: string;

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

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

{"customerReference":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}