Billiecart API

<back to all web services

CreateSalaryPackageRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/packages
CreateSalaryPackageRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodystringNo
PostOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
CreateSalaryPackageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SalaryPackageformSalaryPackageNo
SalaryPackage Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformstringNo
CustomerFirstNameformstringNo
CustomerLastNameformstringNo
StatusformstringNo
NotesformstringNo
BudgetBreakdownformBudgetBreakdownNo
EmploymentformEmploymentNo
VehicleformVehicleNo
LeaseDetailsformLeaseDetailsNo
BudgetBalancesformBudgetBalancesNo
CurrentBalanceformdecimalNo
ForecastedSalarySacrificesformList<ForecastedSalarySacrifice>No
ForecastedOutgoingPaymentsformList<ForecastedOutgoingPayment>No
AdjustmentsformList<Adjustment>No
TransactionsformList<Transaction>No
IdformstringNo
BudgetBreakdown Parameters:
NameParameterData TypeRequiredDescription
LeaseAmountformdecimal?No
AdministrationFeeformdecimal?No
Fuelformdecimal?No
Servicingformdecimal?No
Tyresformdecimal?No
Insuranceformdecimal?No
CarWashformdecimal?No
Registrationformdecimal?No
RoadSideAssistanceformdecimal?No
AnythingExtraformdecimal?No
Employment Parameters:
NameParameterData TypeRequiredDescription
PayrollCycleformstringNo
FirstPayDateformDateTimeNo
EmployerIdformstringNo
EmployerNameformstringNo
Vehicle Parameters:
NameParameterData TypeRequiredDescription
MakeformstringNo
ModelformstringNo
ColourformstringNo
BodyShapeformstringNo
LicensePlateformstringNo
TransmissionformstringNo
ManufactureYearformintNo
LeaseDetails Parameters:
NameParameterData TypeRequiredDescription
Termformint?No
StartDateformDateTime?No
AmountFinancedformdecimal?No
PaymentAmountformdecimal?No
FinanceProviderformstringNo
ResidualValueformdecimal?No
YearlyKmsTravelledformint?No
FringeBenefitTaxValueformdecimal?No
FringeBenefitTaxMethodformstringNo
FringeBenefitTaxBusinessUseformintNo
FringeBenefitTaxStartDateformDateTimeNo
PreTaxDeductionformdecimal?No
PostTaxDeductionformdecimal?No
GstOnPostTaxDeductionformdecimal?No
LuxuryVehicleChargeformdecimal?No
OnRoadCostformdecimalNo
RegistrationDueDateformDateTimeNo
InsuranceDueDateformDateTimeNo
LeaseProviderBankAccountformBankAccountNo
BankAccount Parameters:
NameParameterData TypeRequiredDescription
BsbNumberformstringNo
AccountNumberformstringNo
BudgetBalances Parameters:
NameParameterData TypeRequiredDescription
LeaseAmountformdecimalNo
AdministrationFeeformdecimalNo
FuelformdecimalNo
ServicingformdecimalNo
TyresformdecimalNo
InsuranceformdecimalNo
CarWashformdecimalNo
RegistrationformdecimalNo
RoadSideAssistanceformdecimalNo
AnythingExtraformdecimalNo
ForecastedSalarySacrifice Parameters:
NameParameterData TypeRequiredDescription
PaymentDateformDateTimeNo
AmountformdecimalNo
MatchedformSalarySacrificeNo
SalarySacrifice Parameters:
NameParameterData TypeRequiredDescription
PaymentDateformDateTimeNo
SalarySacrificeBreakdownformSalarySacrificeBreakdownNo
PreTaxDeductionformdecimalNo
PostTaxDeductionformdecimalNo
ContributionIdformstringNo
SalarySacrificeBreakdown Parameters:
NameParameterData TypeRequiredDescription
LeaseAmountformdecimal?No
AdministrationFeeformdecimal?No
Fuelformdecimal?No
Servicingformdecimal?No
Tyresformdecimal?No
Insuranceformdecimal?No
CarWashformdecimal?No
Registrationformdecimal?No
RoadSideAssistanceformdecimal?No
AnythingExtraformdecimal?No
ForecastedOutgoingPayment Parameters:
NameParameterData TypeRequiredDescription
ScheduledformDateTimeNo
AmountformdecimalNo
BudgetCategoryformstringNo
MatchedformExpenseNo
Expense Parameters:
NameParameterData TypeRequiredDescription
BudgetCategoryformstringNo
AmountformdecimalNo
GstformdecimalNo
Adjustment Parameters:
NameParameterData TypeRequiredDescription
BudgetCategoryformstringNo
AmountformdecimalNo
GstformdecimalNo
DescriptionformstringNo
ReceivedformDateTimeNo
IdformstringNo
Transaction Parameters:
NameParameterData TypeRequiredDescription
ReceivedformDateTimeNo
BudgetCategoryformstringNo
AmountformdecimalNo
GstformdecimalNo
DescriptionformstringNo
TypeformstringNo
CreateSalaryPackageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SalaryPackageformSalaryPackageNo

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

{
	customerId: 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
		}
	},
	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
	}
}