Requires the role: | manager |
POST | /packages |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
SalaryPackage | form | SalaryPackage | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | form | string | No | |
CustomerFirstName | form | string | No | |
CustomerLastName | form | string | No | |
Status | form | string | No | |
Notes | form | string | No | |
BudgetBreakdown | form | BudgetBreakdown | No | |
Employment | form | Employment | No | |
Vehicle | form | Vehicle | No | |
LeaseDetails | form | LeaseDetails | No | |
BudgetBalances | form | BudgetBalances | No | |
CurrentBalance | form | decimal | No | |
ForecastedSalarySacrifices | form | List<ForecastedSalarySacrifice> | No | |
ForecastedOutgoingPayments | form | List<ForecastedOutgoingPayment> | No | |
Adjustments | form | List<Adjustment> | No | |
Transactions | form | List<Transaction> | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LeaseAmount | form | decimal? | No | |
AdministrationFee | form | decimal? | No | |
Fuel | form | decimal? | No | |
Servicing | form | decimal? | No | |
Tyres | form | decimal? | No | |
Insurance | form | decimal? | No | |
CarWash | form | decimal? | No | |
Registration | form | decimal? | No | |
RoadSideAssistance | form | decimal? | No | |
AnythingExtra | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PayrollCycle | form | string | No | |
FirstPayDate | form | DateTime | No | |
EmployerId | form | string | No | |
EmployerName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Make | form | string | No | |
Model | form | string | No | |
Colour | form | string | No | |
BodyShape | form | string | No | |
LicensePlate | form | string | No | |
Transmission | form | string | No | |
ManufactureYear | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | int? | No | |
StartDate | form | DateTime? | No | |
AmountFinanced | form | decimal? | No | |
PaymentAmount | form | decimal? | No | |
FinanceProvider | form | string | No | |
ResidualValue | form | decimal? | No | |
YearlyKmsTravelled | form | int? | No | |
FringeBenefitTaxValue | form | decimal? | No | |
FringeBenefitTaxMethod | form | string | No | |
FringeBenefitTaxBusinessUse | form | int | No | |
FringeBenefitTaxStartDate | form | DateTime | No | |
PreTaxDeduction | form | decimal? | No | |
PostTaxDeduction | form | decimal? | No | |
GstOnPostTaxDeduction | form | decimal? | No | |
LuxuryVehicleCharge | form | decimal? | No | |
OnRoadCost | form | decimal | No | |
RegistrationDueDate | form | DateTime | No | |
InsuranceDueDate | form | DateTime | No | |
LeaseProviderBankAccount | form | BankAccount | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BsbNumber | form | string | No | |
AccountNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LeaseAmount | form | decimal | No | |
AdministrationFee | form | decimal | No | |
Fuel | form | decimal | No | |
Servicing | form | decimal | No | |
Tyres | form | decimal | No | |
Insurance | form | decimal | No | |
CarWash | form | decimal | No | |
Registration | form | decimal | No | |
RoadSideAssistance | form | decimal | No | |
AnythingExtra | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentDate | form | DateTime | No | |
Amount | form | decimal | No | |
Matched | form | SalarySacrifice | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PaymentDate | form | DateTime | No | |
SalarySacrificeBreakdown | form | SalarySacrificeBreakdown | No | |
PreTaxDeduction | form | decimal | No | |
PostTaxDeduction | form | decimal | No | |
ContributionId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LeaseAmount | form | decimal? | No | |
AdministrationFee | form | decimal? | No | |
Fuel | form | decimal? | No | |
Servicing | form | decimal? | No | |
Tyres | form | decimal? | No | |
Insurance | form | decimal? | No | |
CarWash | form | decimal? | No | |
Registration | form | decimal? | No | |
RoadSideAssistance | form | decimal? | No | |
AnythingExtra | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Scheduled | form | DateTime | No | |
Amount | form | decimal | No | |
BudgetCategory | form | string | No | |
Matched | form | Expense | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BudgetCategory | form | string | No | |
Amount | form | decimal | No | |
Gst | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BudgetCategory | form | string | No | |
Amount | form | decimal | No | |
Gst | form | decimal | No | |
Description | form | string | No | |
Received | form | DateTime | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Received | form | DateTime | No | |
BudgetCategory | form | string | No | |
Amount | form | decimal | No | |
Gst | form | decimal | No | |
Description | form | string | No | |
Type | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
SalaryPackage | form | SalaryPackage | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } }