DX STF Client API

UpdateCustomerCredit

Customer Master Requests

Customer Master

The following routes are available for this service:
POST	/api/customerMaster/credit	Add new customer master

<?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};


/** @description Customer Master */
// @Api(Description="Customer Master")
// @ApiResponse(Description="Add customer master request received", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="Customer not found", StatusCode=404)
// @ApiResponse(Description="Customer master request not accepted, Confirm Sender GLN", ResponseType="typeof(System.UnauthorizedAccessException)", StatusCode=403)
class UpdateCustomerCredit implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ownerGln='',
        /** @var string */
        public string $customerGln='',
        /** @var string */
        public string $currency='',
        /** @var float */
        public float $creditLimit=0.0,
        /** @var float */
        public float $creditBalance=0.0,
        /** @var float */
        public float $creditAvailable=0.0,
        /** @var DateTime */
        public DateTime $dateTime=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ownerGln'])) $this->ownerGln = $o['ownerGln'];
        if (isset($o['customerGln'])) $this->customerGln = $o['customerGln'];
        if (isset($o['currency'])) $this->currency = $o['currency'];
        if (isset($o['creditLimit'])) $this->creditLimit = $o['creditLimit'];
        if (isset($o['creditBalance'])) $this->creditBalance = $o['creditBalance'];
        if (isset($o['creditAvailable'])) $this->creditAvailable = $o['creditAvailable'];
        if (isset($o['dateTime'])) $this->dateTime = JsonConverters::from('DateTime', $o['dateTime']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ownerGln)) $o['ownerGln'] = $this->ownerGln;
        if (isset($this->customerGln)) $o['customerGln'] = $this->customerGln;
        if (isset($this->currency)) $o['currency'] = $this->currency;
        if (isset($this->creditLimit)) $o['creditLimit'] = $this->creditLimit;
        if (isset($this->creditBalance)) $o['creditBalance'] = $this->creditBalance;
        if (isset($this->creditAvailable)) $o['creditAvailable'] = $this->creditAvailable;
        if (isset($this->dateTime)) $o['dateTime'] = JsonConverters::to('DateTime', $this->dateTime);
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateCustomerCredit 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.

POST /api/customerMaster/credit HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ownerGln":"String","customerGln":"String","currency":"String","creditLimit":0,"creditBalance":0,"creditAvailable":0}