DX STF Client API

<back to all web services

UpdateCustomerCredit

Customer Master Requests

Customer Master

Requires Authentication
The following routes are available for this service:
POST/api/customerMaster/creditAdd new customer master
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


# @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(UnauthorizedAccessException), StatusCode=403)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCustomerCredit:
    """
    Customer Master
    """

    owner_gln: Optional[str] = None
    customer_gln: Optional[str] = None
    currency: Optional[str] = None
    credit_limit: Decimal = decimal.Decimal(0)
    credit_balance: Decimal = decimal.Decimal(0)
    credit_available: Decimal = decimal.Decimal(0)
    date_time: datetime.datetime = datetime.datetime(1, 1, 1)

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

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

<UpdateCustomerCredit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.CustomerMaster">
  <CreditAvailable>0</CreditAvailable>
  <CreditBalance>0</CreditBalance>
  <CreditLimit>0</CreditLimit>
  <Currency>String</Currency>
  <CustomerGln>String</CustomerGln>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <OwnerGln>String</OwnerGln>
</UpdateCustomerCredit>