DX STF Client API

AcknowledgeCreditNote

Credit Note Requests

Credit Note

The following routes are available for this service:
PUT	/api/creditNote/{CreditNoteId}/acknowledge	Acknowledge credit note as received

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;

namespace DX.STF.Application.ClientApi.Messages.CreditNote
{
    ///<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)]
    public partial class AcknowledgeCreditNote
    {
        [ApiMember(ExcludeInSchema=true, ParameterType="path")]
        public virtual Guid CreditNoteId { get; set; }
    }

}

C# AcknowledgeCreditNote DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AcknowledgeCreditNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.CreditNote">
  <CreditNoteId>00000000-0000-0000-0000-000000000000</CreditNoteId>
</AcknowledgeCreditNote>