Billiecart API

<back to all web services

CreatePaymentRequest

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

public class dtos
{

    public static class CreatePaymentRequest extends PostOperationTenanted<CreatePaymentResponse>
    {
        public String salaryPackageId = null;
        public BigDecimal amount = null;
        public BigDecimal gstAmount = null;
        public String particulars = null;
        public String budgetCategory = null;
        
        public String getSalaryPackageId() { return salaryPackageId; }
        public CreatePaymentRequest setSalaryPackageId(String value) { this.salaryPackageId = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public CreatePaymentRequest setAmount(BigDecimal value) { this.amount = value; return this; }
        public BigDecimal getGstAmount() { return gstAmount; }
        public CreatePaymentRequest setGstAmount(BigDecimal value) { this.gstAmount = value; return this; }
        public String getParticulars() { return particulars; }
        public CreatePaymentRequest setParticulars(String value) { this.particulars = value; return this; }
        public String getBudgetCategory() { return budgetCategory; }
        public CreatePaymentRequest setBudgetCategory(String value) { this.budgetCategory = value; return this; }
    }

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

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class CreatePaymentResponse
    {
        public ResponseStatus responseStatus = null;
        public Payment payment = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CreatePaymentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Payment getPayment() { return payment; }
        public CreatePaymentResponse 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 CreatePaymentRequest DTOs

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

HTTP + JSV

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

POST /payments HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	salaryPackageId: String,
	amount: 0,
	gstAmount: 0,
	particulars: String,
	budgetCategory: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	payment: 
	{
		salaryPackageId: String,
		amount: 0,
		gstAmount: 0,
		particulars: String,
		budgetCategory: String,
		status: String,
		toAccount: 
		{
			bsbNumber: String,
			accountNumber: String
		},
		id: String
	}
}