digitaluapi

<back to all web services

PaymentsAdd

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

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

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

    // @DataMember(Order=4)
    public DebtsId: number;

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public DebtsId: number;

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

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

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

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

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

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

TypeScript PaymentsAdd 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.

POST /payments HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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: application/json
Content-Length: length

{"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"}}}