DX STF Client API

UpdateCreditNoteClientProcessed

Credit Note Requests

Credit Note

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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class TokenDto implements ICommandResponse, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $token=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['token'])) $this->token = $o['token'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->token)) $o['token'] = $this->token;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Credit Note */
// @Api(Description="Credit Note")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
class UpdateCreditNoteClientProcessed implements JsonSerializable
{
    public function __construct(
        /** @description Credit Note ID or Token */
        // @ApiMember(Description="Credit Note ID or Token", ParameterType="path")
        /** @var string */
        public string $creditNoteId='',

        /** @description Customer credit note reference in destination system */
        // @ApiMember(Description="Customer credit note reference in destination system")
        /** @var string */
        public string $customerReference='',

        /** @description Date and Time credit note was processed in destination system */
        // @ApiMember(Description="Date and Time credit note was processed in destination system")
        /** @var DateTime */
        public DateTime $customerProcessedDate=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['creditNoteId'])) $this->creditNoteId = $o['creditNoteId'];
        if (isset($o['customerReference'])) $this->customerReference = $o['customerReference'];
        if (isset($o['customerProcessedDate'])) $this->customerProcessedDate = JsonConverters::from('DateTime', $o['customerProcessedDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->creditNoteId)) $o['creditNoteId'] = $this->creditNoteId;
        if (isset($this->customerReference)) $o['customerReference'] = $this->customerReference;
        if (isset($this->customerProcessedDate)) $o['customerProcessedDate'] = JsonConverters::to('DateTime', $this->customerProcessedDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateCreditNoteClientProcessed DTOs

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

HTTP + 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

{}