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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class PaymentsEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long Id = null;

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Integer TenantsId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public Long ActionsId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Long DebtsId = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Date PaymentDate = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public Double PaidAmount = null;

        @DataMember(Order=7)
        @Validate(Validator="NotNull")
        public Double DiscountAmount = null;

        @DataMember(Order=8)
        @Validate(Validator="NotNull")
        public Integer CurrenciesId = null;

        @DataMember(Order=9)
        @Validate(Validator="NotNull")
        public Long CurrencyRatesId = null;
        
        public Long getId() { return Id; }
        public PaymentsEdit setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public PaymentsEdit setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getActionsId() { return ActionsId; }
        public PaymentsEdit setActionsId(Long value) { this.ActionsId = value; return this; }
        public Long getDebtsId() { return DebtsId; }
        public PaymentsEdit setDebtsId(Long value) { this.DebtsId = value; return this; }
        public Date getPaymentDate() { return PaymentDate; }
        public PaymentsEdit setPaymentDate(Date value) { this.PaymentDate = value; return this; }
        public Double getPaidAmount() { return PaidAmount; }
        public PaymentsEdit setPaidAmount(Double value) { this.PaidAmount = value; return this; }
        public Double getDiscountAmount() { return DiscountAmount; }
        public PaymentsEdit setDiscountAmount(Double value) { this.DiscountAmount = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public PaymentsEdit setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Long getCurrencyRatesId() { return CurrencyRatesId; }
        public PaymentsEdit setCurrencyRatesId(Long value) { this.CurrencyRatesId = value; return this; }
    }

    public static class PaymentsEditResponse
    {
        @DataMember(Order=1)
        public Long Id = null;

        @DataMember(Order=2)
        public Integer TenantsId = null;

        @DataMember(Order=3)
        public Long ActionsId = null;

        @DataMember(Order=4)
        public Long DebtsId = null;

        @DataMember(Order=5)
        public Date PaymentDate = null;

        @DataMember(Order=6)
        public Double PaidAmount = null;

        @DataMember(Order=7)
        public Double DiscountAmount = null;

        @DataMember(Order=8)
        public Integer CurrenciesId = null;

        @DataMember(Order=9)
        public Long CurrencyRatesId = null;

        @DataMember(Order=11)
        public ResponseStatus ResponseStatus = null;
        
        public Long getId() { return Id; }
        public PaymentsEditResponse setId(Long value) { this.Id = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public PaymentsEditResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getActionsId() { return ActionsId; }
        public PaymentsEditResponse setActionsId(Long value) { this.ActionsId = value; return this; }
        public Long getDebtsId() { return DebtsId; }
        public PaymentsEditResponse setDebtsId(Long value) { this.DebtsId = value; return this; }
        public Date getPaymentDate() { return PaymentDate; }
        public PaymentsEditResponse setPaymentDate(Date value) { this.PaymentDate = value; return this; }
        public Double getPaidAmount() { return PaidAmount; }
        public PaymentsEditResponse setPaidAmount(Double value) { this.PaidAmount = value; return this; }
        public Double getDiscountAmount() { return DiscountAmount; }
        public PaymentsEditResponse setDiscountAmount(Double value) { this.DiscountAmount = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public PaymentsEditResponse setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Long getCurrencyRatesId() { return CurrencyRatesId; }
        public PaymentsEditResponse setCurrencyRatesId(Long value) { this.CurrencyRatesId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PaymentsEditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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

<PaymentsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ActionsId>0</ActionsId>
  <DebtsId>0</DebtsId>
  <PaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PaymentDate>
  <PaidAmount>0</PaidAmount>
  <DiscountAmount>0</DiscountAmount>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
</PaymentsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ActionsId>0</ActionsId>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
  <DebtsId>0</DebtsId>
  <DiscountAmount>0</DiscountAmount>
  <Id>0</Id>
  <PaidAmount>0</PaidAmount>
  <PaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PaymentDate>
  <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>
  <TenantsId>0</TenantsId>
</PaymentsEditResponse>