digitaluapi

<back to all web services

DebtsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/debts/{Id}
import Foundation
import ServiceStack

// @DataContract
public class DebtsEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var customersId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var invoiceNumber:String

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var debtDate:Date

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var debtAge:Int

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public var amountOutstanding:Double

    // @DataMember(Order=8)
    public var capitalOutstanding:Double?

    // @DataMember(Order=9)
    public var interestOutstanding:Double?

    // @DataMember(Order=10)
    public var feesOutstanding:Double?

    // @DataMember(Order=11)
    public var lastPaidDate:Date?

    // @DataMember(Order=12)
    public var lastPaidAmount:Double?

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public var vulnerabilityFlag:Bool

    // @DataMember(Order=14)
    // @Validate(Validator="NotNull")
    public var currenciesId:Int

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public var currencyRatesId:Int

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public var statusCodesId:Int

    required public init(){}
}

public class DebtsEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var customersId:Int

    // @DataMember(Order=4)
    public var invoiceNumber:String

    // @DataMember(Order=5)
    public var debtDate:Date

    // @DataMember(Order=6)
    public var debtAge:Int

    // @DataMember(Order=7)
    public var amountOutstanding:Double

    // @DataMember(Order=8)
    public var capitalOutstanding:Double?

    // @DataMember(Order=9)
    public var interestOutstanding:Double?

    // @DataMember(Order=10)
    public var feesOutstanding:Double?

    // @DataMember(Order=11)
    public var lastPaidDate:Date?

    // @DataMember(Order=12)
    public var lastPaidAmount:Double?

    // @DataMember(Order=13)
    public var vulnerabilityFlag:Bool

    // @DataMember(Order=14)
    public var currenciesId:Int

    // @DataMember(Order=15)
    public var currencyRatesId:Int

    // @DataMember(Order=16)
    public var statusCodesId:Int

    // @DataMember(Order=18)
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift DebtsEdit 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.

PUT /debts/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"TenantsId":0,"CustomersId":0,"InvoiceNumber":"String","DebtDate":"0001-01-01T00:00:00.0000000","DebtAge":0,"AmountOutstanding":0,"CapitalOutstanding":0,"InterestOutstanding":0,"FeesOutstanding":0,"LastPaidDate":"0001-01-01T00:00:00.0000000","LastPaidAmount":0,"VulnerabilityFlag":false,"CurrenciesId":0,"CurrencyRatesId":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"TenantsId":0,"CustomersId":0,"InvoiceNumber":"String","DebtDate":"0001-01-01T00:00:00.0000000","DebtAge":0,"AmountOutstanding":0,"CapitalOutstanding":0,"InterestOutstanding":0,"FeesOutstanding":0,"LastPaidDate":"0001-01-01T00:00:00.0000000","LastPaidAmount":0,"VulnerabilityFlag":false,"CurrenciesId":0,"CurrencyRatesId":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}