Billiecart API

<back to all web services

GetPaymentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/payments/{Id}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetPaymentRequest extends GetOperationTenanted<GetPaymentResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GetPaymentRequest setId(String value) { this.id = value; return this; }
    }

    public static class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public GetOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetPaymentResponse
    {
        public ResponseStatus responseStatus = null;
        public Payment payment = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetPaymentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Payment getPayment() { return payment; }
        public GetPaymentResponse setPayment(Payment value) { this.payment = value; return this; }
    }

    public static class Payment implements IIdentifiableResource
    {
        public String salaryPackageId = null;
        public BigDecimal amount = null;
        public BigDecimal gstAmount = null;
        public String particulars = null;
        public String budgetCategory = null;
        public String status = null;
        public BankAccount toAccount = null;
        public String id = null;
        
        public String getSalaryPackageId() { return salaryPackageId; }
        public Payment setSalaryPackageId(String value) { this.salaryPackageId = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public Payment setAmount(BigDecimal value) { this.amount = value; return this; }
        public BigDecimal getGstAmount() { return gstAmount; }
        public Payment setGstAmount(BigDecimal value) { this.gstAmount = value; return this; }
        public String getParticulars() { return particulars; }
        public Payment setParticulars(String value) { this.particulars = value; return this; }
        public String getBudgetCategory() { return budgetCategory; }
        public Payment setBudgetCategory(String value) { this.budgetCategory = value; return this; }
        public String getStatus() { return status; }
        public Payment setStatus(String value) { this.status = value; return this; }
        public BankAccount getToAccount() { return toAccount; }
        public Payment setToAccount(BankAccount value) { this.toAccount = value; return this; }
        public String getId() { return id; }
        public Payment setId(String value) { this.id = value; return this; }
    }

    public static class BankAccount
    {
        public String bsbNumber = null;
        public String accountNumber = null;
        
        public String getBsbNumber() { return bsbNumber; }
        public BankAccount setBsbNumber(String value) { this.bsbNumber = value; return this; }
        public String getAccountNumber() { return accountNumber; }
        public BankAccount setAccountNumber(String value) { this.accountNumber = value; return this; }
    }

}

Java GetPaymentRequest 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.

GET /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Payments">
  <Payment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:BudgetCategory>String</d2p1:BudgetCategory>
    <d2p1:GstAmount>0</d2p1:GstAmount>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Particulars>String</d2p1:Particulars>
    <d2p1:SalaryPackageId>String</d2p1:SalaryPackageId>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:ToAccount>
      <d2p1:AccountNumber>String</d2p1:AccountNumber>
      <d2p1:BsbNumber>String</d2p1:BsbNumber>
    </d2p1:ToAccount>
  </Payment>
  <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>
</GetPaymentResponse>