| PUT | /api/creditNote/{CreditNoteId}/processed | Update credit note as customer processed, will also acknowledge credit note if not yet set. |
|---|
import Foundation
import ServiceStack
/**
* Credit Note
*/
// @Api(Description="Credit Note")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(TokenDto), StatusCode=202)
public class UpdateCreditNoteClientProcessed : Codable
{
/**
* Credit Note ID or Token
*/
// @ApiMember(Description="Credit Note ID or Token", ParameterType="path")
public var creditNoteId:String
/**
* Customer credit note reference in destination system
*/
// @ApiMember(Description="Customer credit note reference in destination system")
public var customerReference:String
/**
* Date and Time credit note was processed in destination system
*/
// @ApiMember(Description="Date and Time credit note was processed in destination system")
public var customerProcessedDate:Date
required public init(){}
}
public class TokenDto : ICommandResponse, Codable
{
public var token:String
required public init(){}
}
Swift UpdateCreditNoteClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{}