digitaluapi

<back to all web services

PaymentsEdit

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

// @DataContract
public class PaymentsEdit : 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 actionsId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var debtsId:Int

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

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var paidAmount:Double

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

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

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

    required public init(){}
}

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

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

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

    // @DataMember(Order=4)
    public var debtsId:Int

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

    // @DataMember(Order=6)
    public var paidAmount:Double

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

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

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

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

    required public init(){}
}


Swift PaymentsEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /payments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"TenantsId":0,"ActionsId":0,"DebtsId":0,"PaymentDate":"0001-01-01T00:00:00.0000000+00:00","PaidAmount":0,"DiscountAmount":0,"CurrenciesId":0,"CurrencyRatesId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"TenantsId":0,"ActionsId":0,"DebtsId":0,"PaymentDate":"0001-01-01T00:00:00.0000000+00:00","PaidAmount":0,"DiscountAmount":0,"CurrenciesId":0,"CurrencyRatesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}