| PUT | /api/creditNote/{CreditNoteId}/processed | Update credit note as customer processed, will also acknowledge credit note if not yet set. |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.CreditNote;
using DX.Framework.Core.Commands.Dto;
namespace DX.Framework.Core.Commands.Dto
{
public partial class TokenDto
: ICommandResponse
{
public virtual Guid Token { get; set; }
}
}
namespace DX.STF.Application.ClientApi.Messages.CreditNote
{
///<summary>
///Credit Note
///</summary>
[Api(Description="Credit Note")]
[ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(DX.Framework.Core.Commands.Dto.TokenDto), StatusCode=202)]
public partial class UpdateCreditNoteClientProcessed
{
///<summary>
///Credit Note ID or Token
///</summary>
[ApiMember(Description="Credit Note ID or Token", ParameterType="path")]
public virtual Guid CreditNoteId { get; set; }
///<summary>
///Customer credit note reference in destination system
///</summary>
[ApiMember(Description="Customer credit note reference in destination system")]
public virtual string CustomerReference { get; set; }
///<summary>
///Date and Time credit note was processed in destination system
///</summary>
[ApiMember(Description="Date and Time credit note was processed in destination system")]
public virtual DateTime CustomerProcessedDate { get; set; }
}
}
C# UpdateCreditNoteClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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
{}