| Requires the role: | manager |
| PUT | /packages/{id}/forecast |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class ForecastRequest extends PutOperationTenanted<ForecastResponse>
{
public String id = null;
public String getId() { return id; }
public ForecastRequest setId(String value) { this.id = value; return this; }
}
public static class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
public String organisationId = null;
public String getOrganisationId() { return organisationId; }
public PutOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
}
public static class PutOperationUnTenanted<TResponse> implements IPut
{
}
public static class ForecastResponse
{
public ResponseStatus responseStatus = null;
public SalaryPackage salaryPackage = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public ForecastResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public SalaryPackage getSalaryPackage() { return salaryPackage; }
public ForecastResponse setSalaryPackage(SalaryPackage value) { this.salaryPackage = value; return this; }
}
public static class SalaryPackage implements IIdentifiableResource
{
public String customerId = null;
public String customerFirstName = null;
public String customerLastName = null;
public String status = null;
public String notes = null;
public BudgetBreakdown budgetBreakdown = null;
public Employment employment = null;
public Vehicle vehicle = null;
public LeaseDetails leaseDetails = null;
public BudgetBalances budgetBalances = null;
public BigDecimal currentBalance = null;
public ArrayList<ForecastedSalarySacrifice> forecastedSalarySacrifices = null;
public ArrayList<ForecastedOutgoingPayment> forecastedOutgoingPayments = null;
public ArrayList<Adjustment> adjustments = null;
public ArrayList<Transaction> transactions = null;
public String id = null;
public String getCustomerId() { return customerId; }
public SalaryPackage setCustomerId(String value) { this.customerId = value; return this; }
public String getCustomerFirstName() { return customerFirstName; }
public SalaryPackage setCustomerFirstName(String value) { this.customerFirstName = value; return this; }
public String getCustomerLastName() { return customerLastName; }
public SalaryPackage setCustomerLastName(String value) { this.customerLastName = value; return this; }
public String getStatus() { return status; }
public SalaryPackage setStatus(String value) { this.status = value; return this; }
public String getNotes() { return notes; }
public SalaryPackage setNotes(String value) { this.notes = value; return this; }
public BudgetBreakdown getBudgetBreakdown() { return budgetBreakdown; }
public SalaryPackage setBudgetBreakdown(BudgetBreakdown value) { this.budgetBreakdown = value; return this; }
public Employment getEmployment() { return employment; }
public SalaryPackage setEmployment(Employment value) { this.employment = value; return this; }
public Vehicle getVehicle() { return vehicle; }
public SalaryPackage setVehicle(Vehicle value) { this.vehicle = value; return this; }
public LeaseDetails getLeaseDetails() { return leaseDetails; }
public SalaryPackage setLeaseDetails(LeaseDetails value) { this.leaseDetails = value; return this; }
public BudgetBalances getBudgetBalances() { return budgetBalances; }
public SalaryPackage setBudgetBalances(BudgetBalances value) { this.budgetBalances = value; return this; }
public BigDecimal getCurrentBalance() { return currentBalance; }
public SalaryPackage setCurrentBalance(BigDecimal value) { this.currentBalance = value; return this; }
public ArrayList<ForecastedSalarySacrifice> getForecastedSalarySacrifices() { return forecastedSalarySacrifices; }
public SalaryPackage setForecastedSalarySacrifices(ArrayList<ForecastedSalarySacrifice> value) { this.forecastedSalarySacrifices = value; return this; }
public ArrayList<ForecastedOutgoingPayment> getForecastedOutgoingPayments() { return forecastedOutgoingPayments; }
public SalaryPackage setForecastedOutgoingPayments(ArrayList<ForecastedOutgoingPayment> value) { this.forecastedOutgoingPayments = value; return this; }
public ArrayList<Adjustment> getAdjustments() { return adjustments; }
public SalaryPackage setAdjustments(ArrayList<Adjustment> value) { this.adjustments = value; return this; }
public ArrayList<Transaction> getTransactions() { return transactions; }
public SalaryPackage setTransactions(ArrayList<Transaction> value) { this.transactions = value; return this; }
public String getId() { return id; }
public SalaryPackage setId(String value) { this.id = value; return this; }
}
public static class BudgetBreakdown
{
public BigDecimal leaseAmount = null;
public BigDecimal administrationFee = null;
public BigDecimal fuel = null;
public BigDecimal servicing = null;
public BigDecimal tyres = null;
public BigDecimal insurance = null;
public BigDecimal carWash = null;
public BigDecimal registration = null;
public BigDecimal roadSideAssistance = null;
public BigDecimal anythingExtra = null;
public BigDecimal getLeaseAmount() { return leaseAmount; }
public BudgetBreakdown setLeaseAmount(BigDecimal value) { this.leaseAmount = value; return this; }
public BigDecimal getAdministrationFee() { return administrationFee; }
public BudgetBreakdown setAdministrationFee(BigDecimal value) { this.administrationFee = value; return this; }
public BigDecimal getFuel() { return fuel; }
public BudgetBreakdown setFuel(BigDecimal value) { this.fuel = value; return this; }
public BigDecimal getServicing() { return servicing; }
public BudgetBreakdown setServicing(BigDecimal value) { this.servicing = value; return this; }
public BigDecimal getTyres() { return tyres; }
public BudgetBreakdown setTyres(BigDecimal value) { this.tyres = value; return this; }
public BigDecimal getInsurance() { return insurance; }
public BudgetBreakdown setInsurance(BigDecimal value) { this.insurance = value; return this; }
public BigDecimal getCarWash() { return carWash; }
public BudgetBreakdown setCarWash(BigDecimal value) { this.carWash = value; return this; }
public BigDecimal getRegistration() { return registration; }
public BudgetBreakdown setRegistration(BigDecimal value) { this.registration = value; return this; }
public BigDecimal getRoadSideAssistance() { return roadSideAssistance; }
public BudgetBreakdown setRoadSideAssistance(BigDecimal value) { this.roadSideAssistance = value; return this; }
public BigDecimal getAnythingExtra() { return anythingExtra; }
public BudgetBreakdown setAnythingExtra(BigDecimal value) { this.anythingExtra = value; return this; }
}
public static class Employment
{
public String payrollCycle = null;
public Date firstPayDate = null;
public String employerId = null;
public String employerName = null;
public String getPayrollCycle() { return payrollCycle; }
public Employment setPayrollCycle(String value) { this.payrollCycle = value; return this; }
public Date getFirstPayDate() { return firstPayDate; }
public Employment setFirstPayDate(Date value) { this.firstPayDate = value; return this; }
public String getEmployerId() { return employerId; }
public Employment setEmployerId(String value) { this.employerId = value; return this; }
public String getEmployerName() { return employerName; }
public Employment setEmployerName(String value) { this.employerName = value; return this; }
}
public static class Vehicle
{
public String make = null;
public String model = null;
public String colour = null;
public String bodyShape = null;
public String licensePlate = null;
public String transmission = null;
public Integer manufactureYear = null;
public String getMake() { return make; }
public Vehicle setMake(String value) { this.make = value; return this; }
public String getModel() { return model; }
public Vehicle setModel(String value) { this.model = value; return this; }
public String getColour() { return colour; }
public Vehicle setColour(String value) { this.colour = value; return this; }
public String getBodyShape() { return bodyShape; }
public Vehicle setBodyShape(String value) { this.bodyShape = value; return this; }
public String getLicensePlate() { return licensePlate; }
public Vehicle setLicensePlate(String value) { this.licensePlate = value; return this; }
public String getTransmission() { return transmission; }
public Vehicle setTransmission(String value) { this.transmission = value; return this; }
public Integer getManufactureYear() { return manufactureYear; }
public Vehicle setManufactureYear(Integer value) { this.manufactureYear = value; return this; }
}
public static class LeaseDetails
{
public Integer term = null;
public Date startDate = null;
public BigDecimal amountFinanced = null;
public BigDecimal paymentAmount = null;
public String financeProvider = null;
public BigDecimal residualValue = null;
public Integer yearlyKmsTravelled = null;
public BigDecimal fringeBenefitTaxValue = null;
public String fringeBenefitTaxMethod = null;
public Integer fringeBenefitTaxBusinessUse = null;
public Date fringeBenefitTaxStartDate = null;
public BigDecimal preTaxDeduction = null;
public BigDecimal postTaxDeduction = null;
public BigDecimal gstOnPostTaxDeduction = null;
public BigDecimal luxuryVehicleCharge = null;
public BigDecimal onRoadCost = null;
public Date registrationDueDate = null;
public Date insuranceDueDate = null;
public BankAccount leaseProviderBankAccount = null;
public Integer getTerm() { return term; }
public LeaseDetails setTerm(Integer value) { this.term = value; return this; }
public Date getStartDate() { return startDate; }
public LeaseDetails setStartDate(Date value) { this.startDate = value; return this; }
public BigDecimal getAmountFinanced() { return amountFinanced; }
public LeaseDetails setAmountFinanced(BigDecimal value) { this.amountFinanced = value; return this; }
public BigDecimal getPaymentAmount() { return paymentAmount; }
public LeaseDetails setPaymentAmount(BigDecimal value) { this.paymentAmount = value; return this; }
public String getFinanceProvider() { return financeProvider; }
public LeaseDetails setFinanceProvider(String value) { this.financeProvider = value; return this; }
public BigDecimal getResidualValue() { return residualValue; }
public LeaseDetails setResidualValue(BigDecimal value) { this.residualValue = value; return this; }
public Integer getYearlyKmsTravelled() { return yearlyKmsTravelled; }
public LeaseDetails setYearlyKmsTravelled(Integer value) { this.yearlyKmsTravelled = value; return this; }
public BigDecimal getFringeBenefitTaxValue() { return fringeBenefitTaxValue; }
public LeaseDetails setFringeBenefitTaxValue(BigDecimal value) { this.fringeBenefitTaxValue = value; return this; }
public String getFringeBenefitTaxMethod() { return fringeBenefitTaxMethod; }
public LeaseDetails setFringeBenefitTaxMethod(String value) { this.fringeBenefitTaxMethod = value; return this; }
public Integer getFringeBenefitTaxBusinessUse() { return fringeBenefitTaxBusinessUse; }
public LeaseDetails setFringeBenefitTaxBusinessUse(Integer value) { this.fringeBenefitTaxBusinessUse = value; return this; }
public Date getFringeBenefitTaxStartDate() { return fringeBenefitTaxStartDate; }
public LeaseDetails setFringeBenefitTaxStartDate(Date value) { this.fringeBenefitTaxStartDate = value; return this; }
public BigDecimal getPreTaxDeduction() { return preTaxDeduction; }
public LeaseDetails setPreTaxDeduction(BigDecimal value) { this.preTaxDeduction = value; return this; }
public BigDecimal getPostTaxDeduction() { return postTaxDeduction; }
public LeaseDetails setPostTaxDeduction(BigDecimal value) { this.postTaxDeduction = value; return this; }
public BigDecimal getGstOnPostTaxDeduction() { return gstOnPostTaxDeduction; }
public LeaseDetails setGstOnPostTaxDeduction(BigDecimal value) { this.gstOnPostTaxDeduction = value; return this; }
public BigDecimal getLuxuryVehicleCharge() { return luxuryVehicleCharge; }
public LeaseDetails setLuxuryVehicleCharge(BigDecimal value) { this.luxuryVehicleCharge = value; return this; }
public BigDecimal getOnRoadCost() { return onRoadCost; }
public LeaseDetails setOnRoadCost(BigDecimal value) { this.onRoadCost = value; return this; }
public Date getRegistrationDueDate() { return registrationDueDate; }
public LeaseDetails setRegistrationDueDate(Date value) { this.registrationDueDate = value; return this; }
public Date getInsuranceDueDate() { return insuranceDueDate; }
public LeaseDetails setInsuranceDueDate(Date value) { this.insuranceDueDate = value; return this; }
public BankAccount getLeaseProviderBankAccount() { return leaseProviderBankAccount; }
public LeaseDetails setLeaseProviderBankAccount(BankAccount value) { this.leaseProviderBankAccount = value; return this; }
}
public static class BankAccount
{
public String bsbNumber = null;
public String accountNumber = null;
public String getBsbNumber() { return bsbNumber; }
public BankAccount setBsbNumber(String value) { this.bsbNumber = value; return this; }
public String getAccountNumber() { return accountNumber; }
public BankAccount setAccountNumber(String value) { this.accountNumber = value; return this; }
}
public static class BudgetBalances
{
public BigDecimal leaseAmount = null;
public BigDecimal administrationFee = null;
public BigDecimal fuel = null;
public BigDecimal servicing = null;
public BigDecimal tyres = null;
public BigDecimal insurance = null;
public BigDecimal carWash = null;
public BigDecimal registration = null;
public BigDecimal roadSideAssistance = null;
public BigDecimal anythingExtra = null;
public BigDecimal getLeaseAmount() { return leaseAmount; }
public BudgetBalances setLeaseAmount(BigDecimal value) { this.leaseAmount = value; return this; }
public BigDecimal getAdministrationFee() { return administrationFee; }
public BudgetBalances setAdministrationFee(BigDecimal value) { this.administrationFee = value; return this; }
public BigDecimal getFuel() { return fuel; }
public BudgetBalances setFuel(BigDecimal value) { this.fuel = value; return this; }
public BigDecimal getServicing() { return servicing; }
public BudgetBalances setServicing(BigDecimal value) { this.servicing = value; return this; }
public BigDecimal getTyres() { return tyres; }
public BudgetBalances setTyres(BigDecimal value) { this.tyres = value; return this; }
public BigDecimal getInsurance() { return insurance; }
public BudgetBalances setInsurance(BigDecimal value) { this.insurance = value; return this; }
public BigDecimal getCarWash() { return carWash; }
public BudgetBalances setCarWash(BigDecimal value) { this.carWash = value; return this; }
public BigDecimal getRegistration() { return registration; }
public BudgetBalances setRegistration(BigDecimal value) { this.registration = value; return this; }
public BigDecimal getRoadSideAssistance() { return roadSideAssistance; }
public BudgetBalances setRoadSideAssistance(BigDecimal value) { this.roadSideAssistance = value; return this; }
public BigDecimal getAnythingExtra() { return anythingExtra; }
public BudgetBalances setAnythingExtra(BigDecimal value) { this.anythingExtra = value; return this; }
}
public static class ForecastedSalarySacrifice
{
public Date paymentDate = null;
public BigDecimal amount = null;
public SalarySacrifice matched = null;
public Date getPaymentDate() { return paymentDate; }
public ForecastedSalarySacrifice setPaymentDate(Date value) { this.paymentDate = value; return this; }
public BigDecimal getAmount() { return amount; }
public ForecastedSalarySacrifice setAmount(BigDecimal value) { this.amount = value; return this; }
public SalarySacrifice getMatched() { return matched; }
public ForecastedSalarySacrifice setMatched(SalarySacrifice value) { this.matched = value; return this; }
}
public static class SalarySacrifice
{
public Date paymentDate = null;
public SalarySacrificeBreakdown salarySacrificeBreakdown = null;
public BigDecimal preTaxDeduction = null;
public BigDecimal postTaxDeduction = null;
public String contributionId = null;
public Date getPaymentDate() { return paymentDate; }
public SalarySacrifice setPaymentDate(Date value) { this.paymentDate = value; return this; }
public SalarySacrificeBreakdown getSalarySacrificeBreakdown() { return salarySacrificeBreakdown; }
public SalarySacrifice setSalarySacrificeBreakdown(SalarySacrificeBreakdown value) { this.salarySacrificeBreakdown = value; return this; }
public BigDecimal getPreTaxDeduction() { return preTaxDeduction; }
public SalarySacrifice setPreTaxDeduction(BigDecimal value) { this.preTaxDeduction = value; return this; }
public BigDecimal getPostTaxDeduction() { return postTaxDeduction; }
public SalarySacrifice setPostTaxDeduction(BigDecimal value) { this.postTaxDeduction = value; return this; }
public String getContributionId() { return contributionId; }
public SalarySacrifice setContributionId(String value) { this.contributionId = value; return this; }
}
public static class SalarySacrificeBreakdown
{
public BigDecimal leaseAmount = null;
public BigDecimal administrationFee = null;
public BigDecimal fuel = null;
public BigDecimal servicing = null;
public BigDecimal tyres = null;
public BigDecimal insurance = null;
public BigDecimal carWash = null;
public BigDecimal registration = null;
public BigDecimal roadSideAssistance = null;
public BigDecimal anythingExtra = null;
public BigDecimal getLeaseAmount() { return leaseAmount; }
public SalarySacrificeBreakdown setLeaseAmount(BigDecimal value) { this.leaseAmount = value; return this; }
public BigDecimal getAdministrationFee() { return administrationFee; }
public SalarySacrificeBreakdown setAdministrationFee(BigDecimal value) { this.administrationFee = value; return this; }
public BigDecimal getFuel() { return fuel; }
public SalarySacrificeBreakdown setFuel(BigDecimal value) { this.fuel = value; return this; }
public BigDecimal getServicing() { return servicing; }
public SalarySacrificeBreakdown setServicing(BigDecimal value) { this.servicing = value; return this; }
public BigDecimal getTyres() { return tyres; }
public SalarySacrificeBreakdown setTyres(BigDecimal value) { this.tyres = value; return this; }
public BigDecimal getInsurance() { return insurance; }
public SalarySacrificeBreakdown setInsurance(BigDecimal value) { this.insurance = value; return this; }
public BigDecimal getCarWash() { return carWash; }
public SalarySacrificeBreakdown setCarWash(BigDecimal value) { this.carWash = value; return this; }
public BigDecimal getRegistration() { return registration; }
public SalarySacrificeBreakdown setRegistration(BigDecimal value) { this.registration = value; return this; }
public BigDecimal getRoadSideAssistance() { return roadSideAssistance; }
public SalarySacrificeBreakdown setRoadSideAssistance(BigDecimal value) { this.roadSideAssistance = value; return this; }
public BigDecimal getAnythingExtra() { return anythingExtra; }
public SalarySacrificeBreakdown setAnythingExtra(BigDecimal value) { this.anythingExtra = value; return this; }
}
public static class ForecastedOutgoingPayment
{
public Date scheduled = null;
public BigDecimal amount = null;
public String budgetCategory = null;
public Expense matched = null;
public Date getScheduled() { return scheduled; }
public ForecastedOutgoingPayment setScheduled(Date value) { this.scheduled = value; return this; }
public BigDecimal getAmount() { return amount; }
public ForecastedOutgoingPayment setAmount(BigDecimal value) { this.amount = value; return this; }
public String getBudgetCategory() { return budgetCategory; }
public ForecastedOutgoingPayment setBudgetCategory(String value) { this.budgetCategory = value; return this; }
public Expense getMatched() { return matched; }
public ForecastedOutgoingPayment setMatched(Expense value) { this.matched = value; return this; }
}
public static class Expense
{
public String budgetCategory = null;
public BigDecimal amount = null;
public BigDecimal gst = null;
public String getBudgetCategory() { return budgetCategory; }
public Expense setBudgetCategory(String value) { this.budgetCategory = value; return this; }
public BigDecimal getAmount() { return amount; }
public Expense setAmount(BigDecimal value) { this.amount = value; return this; }
public BigDecimal getGst() { return gst; }
public Expense setGst(BigDecimal value) { this.gst = value; return this; }
}
public static class Adjustment implements IIdentifiableResource
{
public String budgetCategory = null;
public BigDecimal amount = null;
public BigDecimal gst = null;
public String description = null;
public Date received = null;
public String id = null;
public String getBudgetCategory() { return budgetCategory; }
public Adjustment setBudgetCategory(String value) { this.budgetCategory = value; return this; }
public BigDecimal getAmount() { return amount; }
public Adjustment setAmount(BigDecimal value) { this.amount = value; return this; }
public BigDecimal getGst() { return gst; }
public Adjustment setGst(BigDecimal value) { this.gst = value; return this; }
public String getDescription() { return description; }
public Adjustment setDescription(String value) { this.description = value; return this; }
public Date getReceived() { return received; }
public Adjustment setReceived(Date value) { this.received = value; return this; }
public String getId() { return id; }
public Adjustment setId(String value) { this.id = value; return this; }
}
public static class Transaction
{
public Date received = null;
public String budgetCategory = null;
public BigDecimal amount = null;
public BigDecimal gst = null;
public String description = null;
public String type = null;
public Date getReceived() { return received; }
public Transaction setReceived(Date value) { this.received = value; return this; }
public String getBudgetCategory() { return budgetCategory; }
public Transaction setBudgetCategory(String value) { this.budgetCategory = value; return this; }
public BigDecimal getAmount() { return amount; }
public Transaction setAmount(BigDecimal value) { this.amount = value; return this; }
public BigDecimal getGst() { return gst; }
public Transaction setGst(BigDecimal value) { this.gst = value; return this; }
public String getDescription() { return description; }
public Transaction setDescription(String value) { this.description = value; return this; }
public String getType() { return type; }
public Transaction setType(String value) { this.type = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /packages/{id}/forecast HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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":null,"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"}}