digitaluapi

<back to all web services

DebtsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/debts

export class DebtsAddResponse
{
    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public CustomersId: number;

    // @DataMember(Order=4)
    public InvoiceNumber: string;

    // @DataMember(Order=5)
    public DebtDate: string;

    // @DataMember(Order=6)
    public DebtAge: number;

    // @DataMember(Order=7)
    public AmountOutstanding: number;

    // @DataMember(Order=8)
    public CapitalOutstanding?: number;

    // @DataMember(Order=9)
    public InterestOutstanding?: number;

    // @DataMember(Order=10)
    public FeesOutstanding?: number;

    // @DataMember(Order=11)
    public LastPaidDate?: string;

    // @DataMember(Order=12)
    public LastPaidAmount?: number;

    // @DataMember(Order=13)
    public VulnerabilityFlag: boolean;

    // @DataMember(Order=14)
    public CurrenciesId: number;

    // @DataMember(Order=15)
    public CurrencyRatesId: number;

    // @DataMember(Order=16)
    public StatusCodesId: number;

    // @DataMember(Order=18)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DebtsAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DebtsAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public CustomersId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public InvoiceNumber: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public DebtDate: string;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public DebtAge: number;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public AmountOutstanding: number;

    // @DataMember(Order=8)
    public CapitalOutstanding?: number;

    // @DataMember(Order=9)
    public InterestOutstanding?: number;

    // @DataMember(Order=10)
    public FeesOutstanding?: number;

    // @DataMember(Order=11)
    public LastPaidDate?: string;

    // @DataMember(Order=12)
    public LastPaidAmount?: number;

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public VulnerabilityFlag: boolean;

    // @DataMember(Order=14)
    // @Validate(Validator="NotNull")
    public CurrenciesId: number;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public CurrencyRatesId: number;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

    public constructor(init?: Partial<DebtsAdd>) { (Object as any).assign(this, init); }
}

TypeScript DebtsAdd 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 /debts HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DebtsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <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>
</DebtsAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtsAddResponse 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>
  <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>
</DebtsAddResponse>