DX STF Client API

UpdateCreditNoteClientProcessed

Credit Note Requests

Credit Note

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

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

public class dtos
{

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

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

        /**
        * Date and Time credit note was processed in destination system
        */
        @ApiMember(Description="Date and Time credit note was processed in destination system")
        public Date customerProcessedDate = null;
        
        public UUID getCreditNoteId() { return creditNoteId; }
        public UpdateCreditNoteClientProcessed setCreditNoteId(UUID value) { this.creditNoteId = value; return this; }
        public String getCustomerReference() { return customerReference; }
        public UpdateCreditNoteClientProcessed setCustomerReference(String value) { this.customerReference = value; return this; }
        public Date getCustomerProcessedDate() { return customerProcessedDate; }
        public UpdateCreditNoteClientProcessed 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 UpdateCreditNoteClientProcessed 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/creditNote/{CreditNoteId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customerReference":"String"}

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

{}