DX STF Client API

<back to all web services

AcknowledgeCreditNote

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
PUT/api/creditNote/{CreditNoteId}/acknowledgeAcknowledge credit note as received
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="Updated", IsDefaultResponse=true, StatusCode=204)
    // @ApiResponse(Description="GLN does not have required access", StatusCode=403)
    // @ApiResponse(Description="Document not found", StatusCode=404)
    public static class AcknowledgeCreditNote
    {
        @ApiMember(ExcludeInSchema=true, ParameterType="path")
        public UUID creditNoteId = null;
        
        public UUID getCreditNoteId() { return creditNoteId; }
        public AcknowledgeCreditNote setCreditNoteId(UUID value) { this.creditNoteId = value; return this; }
    }

}

Java AcknowledgeCreditNote 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/creditNote/{CreditNoteId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}