Billiecart API

<back to all web services

CreateContributionRequest

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

public class dtos
{

    public static class CreateContributionRequest extends PostOperationTenanted<CreateContributionResponse>
    {
        public BigDecimal amount = null;
        public Date paymentDate = null;
        public String employerId = null;
        
        public BigDecimal getAmount() { return amount; }
        public CreateContributionRequest setAmount(BigDecimal value) { this.amount = value; return this; }
        public Date getPaymentDate() { return paymentDate; }
        public CreateContributionRequest setPaymentDate(Date value) { this.paymentDate = value; return this; }
        public String getEmployerId() { return employerId; }
        public CreateContributionRequest setEmployerId(String value) { this.employerId = 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 CreateContributionResponse
    {
        public ResponseStatus responseStatus = null;
        public Contribution contribution = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CreateContributionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Contribution getContribution() { return contribution; }
        public CreateContributionResponse setContribution(Contribution value) { this.contribution = value; return this; }
    }

    public static class Contribution implements IIdentifiableResource
    {
        public String employerId = null;
        public String employerName = null;
        public BigDecimal amount = null;
        public Date paymentDate = null;
        public Boolean distributed = null;
        public String id = null;
        
        public String getEmployerId() { return employerId; }
        public Contribution setEmployerId(String value) { this.employerId = value; return this; }
        public String getEmployerName() { return employerName; }
        public Contribution setEmployerName(String value) { this.employerName = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public Contribution setAmount(BigDecimal value) { this.amount = value; return this; }
        public Date getPaymentDate() { return paymentDate; }
        public Contribution setPaymentDate(Date value) { this.paymentDate = value; return this; }
        public Boolean isDistributed() { return distributed; }
        public Contribution setDistributed(Boolean value) { this.distributed = value; return this; }
        public String getId() { return id; }
        public Contribution setId(String value) { this.id = value; return this; }
    }

}

Java CreateContributionRequest 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 /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	amount: 0,
	employerId: 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
		}
	},
	contribution: 
	{
		employerId: String,
		employerName: String,
		amount: 0,
		distributed: False,
		id: String
	}
}