digitaluapi

DebtsEdit

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
PUT	/debts/{Id}

<?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 DebtsEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $CustomersId=0,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $InvoiceNumber=null,

        // @DataMember(Order=5)
        /** @var DateTime */
        public DateTime $DebtDate=new DateTime(),

        // @DataMember(Order=6)
        /** @var int */
        public int $DebtAge=0,

        // @DataMember(Order=7)
        /** @var float */
        public float $AmountOutstanding=0.0,

        // @DataMember(Order=8)
        /** @var float|null */
        public ?float $CapitalOutstanding=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $InterestOutstanding=null,

        // @DataMember(Order=10)
        /** @var float|null */
        public ?float $FeesOutstanding=null,

        // @DataMember(Order=11)
        /** @var DateTime|null */
        public ?DateTime $LastPaidDate=null,

        // @DataMember(Order=12)
        /** @var float|null */
        public ?float $LastPaidAmount=null,

        // @DataMember(Order=13)
        /** @var bool|null */
        public ?bool $VulnerabilityFlag=null,

        // @DataMember(Order=14)
        /** @var int */
        public int $CurrenciesId=0,

        // @DataMember(Order=15)
        /** @var int */
        public int $CurrencyRatesId=0,

        // @DataMember(Order=16)
        /** @var int */
        public int $StatusCodesId=0,

        // @DataMember(Order=18)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['InvoiceNumber'])) $this->InvoiceNumber = $o['InvoiceNumber'];
        if (isset($o['DebtDate'])) $this->DebtDate = JsonConverters::from('DateTime', $o['DebtDate']);
        if (isset($o['DebtAge'])) $this->DebtAge = $o['DebtAge'];
        if (isset($o['AmountOutstanding'])) $this->AmountOutstanding = $o['AmountOutstanding'];
        if (isset($o['CapitalOutstanding'])) $this->CapitalOutstanding = $o['CapitalOutstanding'];
        if (isset($o['InterestOutstanding'])) $this->InterestOutstanding = $o['InterestOutstanding'];
        if (isset($o['FeesOutstanding'])) $this->FeesOutstanding = $o['FeesOutstanding'];
        if (isset($o['LastPaidDate'])) $this->LastPaidDate = JsonConverters::from('DateTime', $o['LastPaidDate']);
        if (isset($o['LastPaidAmount'])) $this->LastPaidAmount = $o['LastPaidAmount'];
        if (isset($o['VulnerabilityFlag'])) $this->VulnerabilityFlag = $o['VulnerabilityFlag'];
        if (isset($o['CurrenciesId'])) $this->CurrenciesId = $o['CurrenciesId'];
        if (isset($o['CurrencyRatesId'])) $this->CurrencyRatesId = $o['CurrencyRatesId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->InvoiceNumber)) $o['InvoiceNumber'] = $this->InvoiceNumber;
        if (isset($this->DebtDate)) $o['DebtDate'] = JsonConverters::to('DateTime', $this->DebtDate);
        if (isset($this->DebtAge)) $o['DebtAge'] = $this->DebtAge;
        if (isset($this->AmountOutstanding)) $o['AmountOutstanding'] = $this->AmountOutstanding;
        if (isset($this->CapitalOutstanding)) $o['CapitalOutstanding'] = $this->CapitalOutstanding;
        if (isset($this->InterestOutstanding)) $o['InterestOutstanding'] = $this->InterestOutstanding;
        if (isset($this->FeesOutstanding)) $o['FeesOutstanding'] = $this->FeesOutstanding;
        if (isset($this->LastPaidDate)) $o['LastPaidDate'] = JsonConverters::to('DateTime', $this->LastPaidDate);
        if (isset($this->LastPaidAmount)) $o['LastPaidAmount'] = $this->LastPaidAmount;
        if (isset($this->VulnerabilityFlag)) $o['VulnerabilityFlag'] = $this->VulnerabilityFlag;
        if (isset($this->CurrenciesId)) $o['CurrenciesId'] = $this->CurrenciesId;
        if (isset($this->CurrencyRatesId)) $o['CurrencyRatesId'] = $this->CurrencyRatesId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class DebtsEdit implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CustomersId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $InvoiceNumber='',

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $DebtDate=new DateTime(),

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $DebtAge=0,

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $AmountOutstanding=0.0,

        // @DataMember(Order=8)
        /** @var float|null */
        public ?float $CapitalOutstanding=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $InterestOutstanding=null,

        // @DataMember(Order=10)
        /** @var float|null */
        public ?float $FeesOutstanding=null,

        // @DataMember(Order=11)
        /** @var DateTime|null */
        public ?DateTime $LastPaidDate=null,

        // @DataMember(Order=12)
        /** @var float|null */
        public ?float $LastPaidAmount=null,

        // @DataMember(Order=13)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $VulnerabilityFlag=null,

        // @DataMember(Order=14)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CurrenciesId=0,

        // @DataMember(Order=15)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CurrencyRatesId=0,

        // @DataMember(Order=16)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['InvoiceNumber'])) $this->InvoiceNumber = $o['InvoiceNumber'];
        if (isset($o['DebtDate'])) $this->DebtDate = JsonConverters::from('DateTime', $o['DebtDate']);
        if (isset($o['DebtAge'])) $this->DebtAge = $o['DebtAge'];
        if (isset($o['AmountOutstanding'])) $this->AmountOutstanding = $o['AmountOutstanding'];
        if (isset($o['CapitalOutstanding'])) $this->CapitalOutstanding = $o['CapitalOutstanding'];
        if (isset($o['InterestOutstanding'])) $this->InterestOutstanding = $o['InterestOutstanding'];
        if (isset($o['FeesOutstanding'])) $this->FeesOutstanding = $o['FeesOutstanding'];
        if (isset($o['LastPaidDate'])) $this->LastPaidDate = JsonConverters::from('DateTime', $o['LastPaidDate']);
        if (isset($o['LastPaidAmount'])) $this->LastPaidAmount = $o['LastPaidAmount'];
        if (isset($o['VulnerabilityFlag'])) $this->VulnerabilityFlag = $o['VulnerabilityFlag'];
        if (isset($o['CurrenciesId'])) $this->CurrenciesId = $o['CurrenciesId'];
        if (isset($o['CurrencyRatesId'])) $this->CurrencyRatesId = $o['CurrencyRatesId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->InvoiceNumber)) $o['InvoiceNumber'] = $this->InvoiceNumber;
        if (isset($this->DebtDate)) $o['DebtDate'] = JsonConverters::to('DateTime', $this->DebtDate);
        if (isset($this->DebtAge)) $o['DebtAge'] = $this->DebtAge;
        if (isset($this->AmountOutstanding)) $o['AmountOutstanding'] = $this->AmountOutstanding;
        if (isset($this->CapitalOutstanding)) $o['CapitalOutstanding'] = $this->CapitalOutstanding;
        if (isset($this->InterestOutstanding)) $o['InterestOutstanding'] = $this->InterestOutstanding;
        if (isset($this->FeesOutstanding)) $o['FeesOutstanding'] = $this->FeesOutstanding;
        if (isset($this->LastPaidDate)) $o['LastPaidDate'] = JsonConverters::to('DateTime', $this->LastPaidDate);
        if (isset($this->LastPaidAmount)) $o['LastPaidAmount'] = $this->LastPaidAmount;
        if (isset($this->VulnerabilityFlag)) $o['VulnerabilityFlag'] = $this->VulnerabilityFlag;
        if (isset($this->CurrenciesId)) $o['CurrenciesId'] = $this->CurrenciesId;
        if (isset($this->CurrencyRatesId)) $o['CurrencyRatesId'] = $this->CurrencyRatesId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DebtsEdit 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 /debts/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DebtsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <CustomersId>0</CustomersId>
  <InvoiceNumber>String</InvoiceNumber>
  <DebtDate>0001-01-01T00:00:00</DebtDate>
  <DebtAge>0</DebtAge>
  <AmountOutstanding>0</AmountOutstanding>
  <CapitalOutstanding>0</CapitalOutstanding>
  <InterestOutstanding>0</InterestOutstanding>
  <FeesOutstanding>0</FeesOutstanding>
  <LastPaidDate>0001-01-01T00:00:00</LastPaidDate>
  <LastPaidAmount>0</LastPaidAmount>
  <VulnerabilityFlag>false</VulnerabilityFlag>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
  <StatusCodesId>0</StatusCodesId>
</DebtsEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <AmountOutstanding>0</AmountOutstanding>
  <CapitalOutstanding>0</CapitalOutstanding>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
  <CustomersId>0</CustomersId>
  <DebtAge>0</DebtAge>
  <DebtDate>0001-01-01T00:00:00</DebtDate>
  <FeesOutstanding>0</FeesOutstanding>
  <Id>0</Id>
  <InterestOutstanding>0</InterestOutstanding>
  <InvoiceNumber>String</InvoiceNumber>
  <LastPaidAmount>0</LastPaidAmount>
  <LastPaidDate>0001-01-01T00:00:00</LastPaidDate>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatusCodesId>0</StatusCodesId>
  <TenantsId>0</TenantsId>
  <VulnerabilityFlag>false</VulnerabilityFlag>
</DebtsEditResponse>