DX STF Client API

<back to all web services

AcknowledgeInvoice

Invoice Requests

Invoice

Requires Authentication
The following routes are available for this service:
PUT/api/invoice/{InvoiceId}/acknowledgeAcknowledge invoice as received

/** @description Invoice */
// @Api(Description="Invoice")
// @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 AcknowledgeInvoice
{
    // @ApiMember(ExcludeInSchema=true, ParameterType="path")
    public invoiceId: string;

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

TypeScript AcknowledgeInvoice DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

PUT /api/invoice/{InvoiceId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}