DX STF Client API

UpdateDebitNoteClientProcessed

Debit Note Requests

Debit Note

The following routes are available for this service:
PUT	/api/debitNote/{DebitNoteId}/processed	Update debit 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.DebitNote;
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.DebitNote
{
    ///<summary>
    ///Debit Note
    ///</summary>
    [Api(Description="Debit Note")]
    [ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(DX.Framework.Core.Commands.Dto.TokenDto), StatusCode=202)]
    public partial class UpdateDebitNoteClientProcessed
    {
        ///<summary>
        ///Debit Note ID or Token
        ///</summary>
        [ApiMember(Description="Debit Note ID or Token", ParameterType="path")]
        public virtual Guid DebitNoteId { get; set; }

        ///<summary>
        ///Customer debit note reference in destination system
        ///</summary>
        [ApiMember(Description="Customer debit note reference in destination system")]
        public virtual string CustomerReference { get; set; }

        ///<summary>
        ///Date and Time debit note was processed in destination system
        ///</summary>
        [ApiMember(Description="Date and Time debit note was processed in destination system")]
        public virtual DateTime CustomerProcessedDate { get; set; }
    }

}

C# UpdateDebitNoteClientProcessed DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/debitNote/{DebitNoteId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"customerReference":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}