Billiecart API

CreateContributionRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
POST	/contributions


export class PostOperationUnTenanted<TResponse> implements IPost
{

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

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class Contribution implements IIdentifiableResource
{
    public employerId?: string;
    public employerName?: string;
    public amount: number;
    public paymentDate: string;
    public distributed: boolean;
    public id?: string;

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

export class CreateContributionResponse
{
    public responseStatus?: ResponseStatus;
    public contribution?: Contribution;

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

export class CreateContributionRequest extends PostOperationTenanted<CreateContributionResponse>
{
    public amount?: number;
    public paymentDate: string;
    public employerId?: string;

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

TypeScript 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
	}
}