DX STF Client API

<back to all web services

UpdateInvoiceClientProcessed

Invoice Requests

Invoice

Requires Authentication
The following routes are available for this service:
PUT/api/invoice/{InvoiceId}/processedUpdate invoice as customer processed, will also acknowledge invoice if not yet set.
UpdateInvoiceClientProcessed Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdpathGuidNoInvoice ID or Token
CustomerReferencebodystringYesCustomer invoice reference in destination system
CustomerProcessedDatebodyDateTimeNoDate and Time invoice was processed in destination system
TokenDto Parameters:
NameParameterData TypeRequiredDescription
TokenformGuidNo

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/invoice/{InvoiceId}/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

{
	
}