Billiecart API

SetBudgetBreakdownRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/packages/{Id}/budget-breakdown


export class PutOperationUnTenanted<TResponse> implements IPut
{

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

export class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class BudgetBreakdown
{
    public leaseAmount?: number;
    public administrationFee?: number;
    public fuel?: number;
    public servicing?: number;
    public tyres?: number;
    public insurance?: number;
    public carWash?: number;
    public registration?: number;
    public roadSideAssistance?: number;
    public anythingExtra?: number;

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

export class Employment
{
    public payrollCycle?: string;
    public firstPayDate: string;
    public employerId?: string;
    public employerName?: string;

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

export class Vehicle
{
    public make?: string;
    public model?: string;
    public colour?: string;
    public bodyShape?: string;
    public licensePlate?: string;
    public transmission?: string;
    public manufactureYear: number;

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

export class BankAccount
{
    public bsbNumber?: string;
    public accountNumber?: string;

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

export class LeaseDetails
{
    public term?: number;
    public startDate?: string;
    public amountFinanced?: number;
    public paymentAmount?: number;
    public financeProvider?: string;
    public residualValue?: number;
    public yearlyKmsTravelled?: number;
    public fringeBenefitTaxValue?: number;
    public fringeBenefitTaxMethod?: string;
    public fringeBenefitTaxBusinessUse: number;
    public fringeBenefitTaxStartDate: string;
    public preTaxDeduction?: number;
    public postTaxDeduction?: number;
    public gstOnPostTaxDeduction?: number;
    public luxuryVehicleCharge?: number;
    public onRoadCost: number;
    public registrationDueDate: string;
    public insuranceDueDate: string;
    public leaseProviderBankAccount?: BankAccount;

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

export class BudgetBalances
{
    public leaseAmount: number;
    public administrationFee: number;
    public fuel: number;
    public servicing: number;
    public tyres: number;
    public insurance: number;
    public carWash: number;
    public registration: number;
    public roadSideAssistance: number;
    public anythingExtra: number;

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

export class SalarySacrificeBreakdown
{
    public leaseAmount?: number;
    public administrationFee?: number;
    public fuel?: number;
    public servicing?: number;
    public tyres?: number;
    public insurance?: number;
    public carWash?: number;
    public registration?: number;
    public roadSideAssistance?: number;
    public anythingExtra?: number;

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

export class SalarySacrifice
{
    public paymentDate: string;
    public salarySacrificeBreakdown?: SalarySacrificeBreakdown;
    public preTaxDeduction: number;
    public postTaxDeduction: number;
    public contributionId?: string;

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

export class ForecastedSalarySacrifice
{
    public paymentDate: string;
    public amount: number;
    public matched?: SalarySacrifice;

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

export class Expense
{
    public budgetCategory?: string;
    public amount: number;
    public gst: number;

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

export class ForecastedOutgoingPayment
{
    public scheduled: string;
    public amount: number;
    public budgetCategory?: string;
    public matched?: Expense;

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

export class Adjustment implements IIdentifiableResource
{
    public budgetCategory?: string;
    public amount: number;
    public gst: number;
    public description?: string;
    public received: string;
    public id?: string;

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

export class Transaction
{
    public received: string;
    public budgetCategory?: string;
    public amount: number;
    public gst: number;
    public description?: string;
    public type?: string;

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

export class SalaryPackage implements IIdentifiableResource
{
    public customerId?: string;
    public customerFirstName?: string;
    public customerLastName?: string;
    public status?: string;
    public notes?: string;
    public budgetBreakdown?: BudgetBreakdown;
    public employment?: Employment;
    public vehicle?: Vehicle;
    public leaseDetails?: LeaseDetails;
    public budgetBalances?: BudgetBalances;
    public currentBalance: number;
    public forecastedSalarySacrifices?: ForecastedSalarySacrifice[];
    public forecastedOutgoingPayments?: ForecastedOutgoingPayment[];
    public adjustments?: Adjustment[];
    public transactions?: Transaction[];
    public id?: string;

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

export class SetBudgetBreakdownResponse
{
    public responseStatus?: ResponseStatus;
    public salaryPackage?: SalaryPackage;

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

export class SetBudgetBreakdownRequest extends PutOperationTenanted<SetBudgetBreakdownResponse>
{
    public id?: string;
    public leaseAmount?: number;
    public administrationFee?: number;
    public fuel?: number;
    public servicing?: number;
    public tyres?: number;
    public insurance?: number;
    public carWash?: number;
    public registration?: number;
    public roadSideAssistance?: number;
    public anythingExtra?: number;

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

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

PUT /packages/{Id}/budget-breakdown HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	leaseAmount: 0,
	administrationFee: 0,
	fuel: 0,
	servicing: 0,
	tyres: 0,
	insurance: 0,
	carWash: 0,
	registration: 0,
	roadSideAssistance: 0,
	anythingExtra: 0,
	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
		}
	},
	salaryPackage: 
	{
		customerId: String,
		customerFirstName: String,
		customerLastName: String,
		status: String,
		notes: String,
		budgetBreakdown: 
		{
			leaseAmount: 0,
			administrationFee: 0,
			fuel: 0,
			servicing: 0,
			tyres: 0,
			insurance: 0,
			carWash: 0,
			registration: 0,
			roadSideAssistance: 0,
			anythingExtra: 0
		},
		employment: 
		{
			payrollCycle: String,
			employerId: String,
			employerName: String
		},
		vehicle: 
		{
			make: String,
			model: String,
			colour: String,
			bodyShape: String,
			licensePlate: String,
			transmission: String,
			manufactureYear: 0
		},
		leaseDetails: 
		{
			term: 0,
			startDate: ,
			amountFinanced: 0,
			paymentAmount: 0,
			financeProvider: String,
			residualValue: 0,
			yearlyKmsTravelled: 0,
			fringeBenefitTaxValue: 0,
			fringeBenefitTaxMethod: String,
			fringeBenefitTaxBusinessUse: 0,
			preTaxDeduction: 0,
			postTaxDeduction: 0,
			gstOnPostTaxDeduction: 0,
			luxuryVehicleCharge: 0,
			onRoadCost: 0,
			leaseProviderBankAccount: 
			{
				bsbNumber: String,
				accountNumber: String
			}
		},
		budgetBalances: 
		{
			leaseAmount: 0,
			administrationFee: 0,
			fuel: 0,
			servicing: 0,
			tyres: 0,
			insurance: 0,
			carWash: 0,
			registration: 0,
			roadSideAssistance: 0,
			anythingExtra: 0
		},
		currentBalance: 0,
		forecastedSalarySacrifices: 
		[
			{
				amount: 0,
				matched: 
				{
					salarySacrificeBreakdown: 
					{
						leaseAmount: 0,
						administrationFee: 0,
						fuel: 0,
						servicing: 0,
						tyres: 0,
						insurance: 0,
						carWash: 0,
						registration: 0,
						roadSideAssistance: 0,
						anythingExtra: 0
					},
					preTaxDeduction: 0,
					postTaxDeduction: 0,
					contributionId: String
				}
			}
		],
		forecastedOutgoingPayments: 
		[
			{
				amount: 0,
				budgetCategory: String,
				matched: 
				{
					budgetCategory: String,
					amount: 0,
					gst: 0
				}
			}
		],
		adjustments: 
		[
			{
				budgetCategory: String,
				amount: 0,
				gst: 0,
				description: String,
				id: String
			}
		],
		transactions: 
		[
			{
				budgetCategory: String,
				amount: 0,
				gst: 0,
				description: String,
				type: String
			}
		],
		id: String
	}
}