digitaluapi

DebtsEdit

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

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

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DebtsEditResponse:
    id: int = 0
    tenants_id: int = 0
    customers_id: int = 0
    invoice_number: Optional[str] = None
    debt_date: datetime.datetime = datetime.datetime(1, 1, 1)
    debt_age: int = 0
    amount_outstanding: float = 0.0
    capital_outstanding: Optional[float] = None
    interest_outstanding: Optional[float] = None
    fees_outstanding: Optional[float] = None
    last_paid_date: Optional[datetime.datetime] = None
    last_paid_amount: Optional[float] = None
    vulnerability_flag: bool = False
    currencies_id: int = 0
    currency_rates_id: int = 0
    status_codes_id: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DebtsEdit:
    # @Validate(Validator="NotNull")
    id: int = 0

    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    customers_id: int = 0

    # @Validate(Validator="NotNull")
    invoice_number: Optional[str] = None

    # @Validate(Validator="NotNull")
    debt_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Validate(Validator="NotNull")
    debt_age: int = 0

    # @Validate(Validator="NotNull")
    amount_outstanding: float = 0.0

    capital_outstanding: Optional[float] = None
    interest_outstanding: Optional[float] = None
    fees_outstanding: Optional[float] = None
    last_paid_date: Optional[datetime.datetime] = None
    last_paid_amount: Optional[float] = None
    # @Validate(Validator="NotNull")
    vulnerability_flag: bool = False

    # @Validate(Validator="NotNull")
    currencies_id: int = 0

    # @Validate(Validator="NotNull")
    currency_rates_id: int = 0

    # @Validate(Validator="NotNull")
    status_codes_id: int = 0

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