DX STF Client API

UpdateInvoiceClientProcessed

Invoice Requests

Invoice

The following routes are available for this service:
PUT	/api/invoice/{InvoiceId}/processed	Update invoice as customer processed, will also acknowledge invoice if not yet set.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Invoice
Imports DX.Framework.Core.Commands.Dto

Namespace Global

    Namespace DX.Framework.Core.Commands.Dto

        Public Partial Class TokenDto
            Implements ICommandResponse
            Public Overridable Property Token As Guid
        End Class
    End Namespace

    Namespace DX.STF.Application.ClientApi.Messages.Invoice

        '''<Summary>
        '''Invoice
        '''</Summary>
        <Api(Description:="Invoice")>
        <ApiResponse(Description:="Command received", IsDefaultResponse:=true, ResponseType:=GetType(TokenDto), StatusCode:=202)>
        Public Partial Class UpdateInvoiceClientProcessed
            '''<Summary>
            '''Invoice ID or Token
            '''</Summary>
            <ApiMember(Description:="Invoice ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property InvoiceId As Guid

            '''<Summary>
            '''Customer invoice reference in destination system
            '''</Summary>
            <ApiMember(Description:="Customer invoice reference in destination system")>
            Public Overridable Property CustomerReference As String

            '''<Summary>
            '''Date and Time invoice was processed in destination system
            '''</Summary>
            <ApiMember(Description:="Date and Time invoice was processed in destination system")>
            Public Overridable Property CustomerProcessedDate As Date
        End Class
    End Namespace
End Namespace

VB.NET UpdateInvoiceClientProcessed 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/invoice/{InvoiceId}/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

{}