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
namespace DX.STF.Application.ClientApi.Messages.CreditNote

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Credit Note
    ///</summary>
    [<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)>]
    [<AllowNullLiteral>]
    type AcknowledgeCreditNote() = 
        [<ApiMember(ExcludeInSchema=true, ParameterType="path")>]
        member val CreditNoteId:Guid = new Guid() with get,set

F# AcknowledgeCreditNote DTOs

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

{
	
}