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.

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Invoice
    */
    @Api(Description="Invoice")
    @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto.class, StatusCode=202)
    public static class UpdateInvoiceClientProcessed
    {
        /**
        * Invoice ID or Token
        */
        @ApiMember(Description="Invoice ID or Token", ExcludeInSchema=true, ParameterType="path")
        public UUID invoiceId = null;

        /**
        * Customer invoice reference in destination system
        */
        @ApiMember(Description="Customer invoice reference in destination system")
        public String customerReference = null;

        /**
        * Date and Time invoice was processed in destination system
        */
        @ApiMember(Description="Date and Time invoice was processed in destination system")
        public Date customerProcessedDate = null;
        
        public UUID getInvoiceId() { return invoiceId; }
        public UpdateInvoiceClientProcessed setInvoiceId(UUID value) { this.invoiceId = value; return this; }
        public String getCustomerReference() { return customerReference; }
        public UpdateInvoiceClientProcessed setCustomerReference(String value) { this.customerReference = value; return this; }
        public Date getCustomerProcessedDate() { return customerProcessedDate; }
        public UpdateInvoiceClientProcessed setCustomerProcessedDate(Date value) { this.customerProcessedDate = value; return this; }
    }

    public static class TokenDto implements ICommandResponse
    {
        public UUID token = null;
        
        public UUID getToken() { return token; }
        public TokenDto setToken(UUID value) { this.token = value; return this; }
    }

}

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

{"customerReference":"String"}

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

{}