Billiecart API

SetVehicleRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/packages/{Id}/vehicle

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SetVehicleRequest : PutOperationTenanted<SetVehicleResponse>()
{
    var id:String? = null
    var make:String? = null
    var model:String? = null
    var colour:String? = null
    var bodyShape:String? = null
    var licensePlate:String? = null
    var transmission:String? = null
    var manufactureYear:Int? = null
}

open class PutOperationTenanted<TResponse> : PutOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class PutOperationUnTenanted<TResponse> : IPut
{
}

open class SetVehicleResponse
{
    var responseStatus:ResponseStatus? = null
    var salaryPackage:SalaryPackage? = null
}

open class SalaryPackage : IIdentifiableResource
{
    var customerId:String? = null
    var customerFirstName:String? = null
    var customerLastName:String? = null
    var status:String? = null
    var notes:String? = null
    var budgetBreakdown:BudgetBreakdown? = null
    var employment:Employment? = null
    var vehicle:Vehicle? = null
    var leaseDetails:LeaseDetails? = null
    var budgetBalances:BudgetBalances? = null
    var currentBalance:BigDecimal? = null
    var forecastedSalarySacrifices:ArrayList<ForecastedSalarySacrifice> = ArrayList<ForecastedSalarySacrifice>()
    var forecastedOutgoingPayments:ArrayList<ForecastedOutgoingPayment> = ArrayList<ForecastedOutgoingPayment>()
    var adjustments:ArrayList<Adjustment> = ArrayList<Adjustment>()
    var transactions:ArrayList<Transaction> = ArrayList<Transaction>()
    var id:String? = null
}

open class BudgetBreakdown
{
    var leaseAmount:BigDecimal? = null
    var administrationFee:BigDecimal? = null
    var fuel:BigDecimal? = null
    var servicing:BigDecimal? = null
    var tyres:BigDecimal? = null
    var insurance:BigDecimal? = null
    var carWash:BigDecimal? = null
    var registration:BigDecimal? = null
    var roadSideAssistance:BigDecimal? = null
    var anythingExtra:BigDecimal? = null
}

open class Employment
{
    var payrollCycle:String? = null
    var firstPayDate:Date? = null
    var employerId:String? = null
    var employerName:String? = null
}

open class Vehicle
{
    var make:String? = null
    var model:String? = null
    var colour:String? = null
    var bodyShape:String? = null
    var licensePlate:String? = null
    var transmission:String? = null
    var manufactureYear:Int? = null
}

open class LeaseDetails
{
    var term:Int? = null
    var startDate:Date? = null
    var amountFinanced:BigDecimal? = null
    var paymentAmount:BigDecimal? = null
    var financeProvider:String? = null
    var residualValue:BigDecimal? = null
    var yearlyKmsTravelled:Int? = null
    var fringeBenefitTaxValue:BigDecimal? = null
    var fringeBenefitTaxMethod:String? = null
    var fringeBenefitTaxBusinessUse:Int? = null
    var fringeBenefitTaxStartDate:Date? = null
    var preTaxDeduction:BigDecimal? = null
    var postTaxDeduction:BigDecimal? = null
    var gstOnPostTaxDeduction:BigDecimal? = null
    var luxuryVehicleCharge:BigDecimal? = null
    var onRoadCost:BigDecimal? = null
    var registrationDueDate:Date? = null
    var insuranceDueDate:Date? = null
    var leaseProviderBankAccount:BankAccount? = null
}

open class BankAccount
{
    var bsbNumber:String? = null
    var accountNumber:String? = null
}

open class BudgetBalances
{
    var leaseAmount:BigDecimal? = null
    var administrationFee:BigDecimal? = null
    var fuel:BigDecimal? = null
    var servicing:BigDecimal? = null
    var tyres:BigDecimal? = null
    var insurance:BigDecimal? = null
    var carWash:BigDecimal? = null
    var registration:BigDecimal? = null
    var roadSideAssistance:BigDecimal? = null
    var anythingExtra:BigDecimal? = null
}

open class ForecastedSalarySacrifice
{
    var paymentDate:Date? = null
    var amount:BigDecimal? = null
    var matched:SalarySacrifice? = null
}

open class SalarySacrifice
{
    var paymentDate:Date? = null
    var salarySacrificeBreakdown:SalarySacrificeBreakdown? = null
    var preTaxDeduction:BigDecimal? = null
    var postTaxDeduction:BigDecimal? = null
    var contributionId:String? = null
}

open class SalarySacrificeBreakdown
{
    var leaseAmount:BigDecimal? = null
    var administrationFee:BigDecimal? = null
    var fuel:BigDecimal? = null
    var servicing:BigDecimal? = null
    var tyres:BigDecimal? = null
    var insurance:BigDecimal? = null
    var carWash:BigDecimal? = null
    var registration:BigDecimal? = null
    var roadSideAssistance:BigDecimal? = null
    var anythingExtra:BigDecimal? = null
}

open class ForecastedOutgoingPayment
{
    var scheduled:Date? = null
    var amount:BigDecimal? = null
    var budgetCategory:String? = null
    var matched:Expense? = null
}

open class Expense
{
    var budgetCategory:String? = null
    var amount:BigDecimal? = null
    var gst:BigDecimal? = null
}

open class Adjustment : IIdentifiableResource
{
    var budgetCategory:String? = null
    var amount:BigDecimal? = null
    var gst:BigDecimal? = null
    var description:String? = null
    var received:Date? = null
    var id:String? = null
}

open class Transaction
{
    var received:Date? = null
    var budgetCategory:String? = null
    var amount:BigDecimal? = null
    var gst:BigDecimal? = null
    var description:String? = null
    @SerializedName("type") var Type:String? = null
}

Kotlin SetVehicleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /packages/{Id}/vehicle HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <BodyShape>String</BodyShape>
  <Colour>String</Colour>
  <Id>String</Id>
  <LicensePlate>String</LicensePlate>
  <Make>String</Make>
  <ManufactureYear>0</ManufactureYear>
  <Model>String</Model>
  <Transmission>String</Transmission>
</SetVehicleRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SetVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SalaryPackage xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Adjustments>
      <d2p1:Adjustment>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:BudgetCategory>String</d2p1:BudgetCategory>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Gst>0</d2p1:Gst>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Received>0001-01-01T00:00:00</d2p1:Received>
      </d2p1:Adjustment>
    </d2p1:Adjustments>
    <d2p1:BudgetBalances>
      <d2p1:AdministrationFee>0</d2p1:AdministrationFee>
      <d2p1:AnythingExtra>0</d2p1:AnythingExtra>
      <d2p1:CarWash>0</d2p1:CarWash>
      <d2p1:Fuel>0</d2p1:Fuel>
      <d2p1:Insurance>0</d2p1:Insurance>
      <d2p1:LeaseAmount>0</d2p1:LeaseAmount>
      <d2p1:Registration>0</d2p1:Registration>
      <d2p1:RoadSideAssistance>0</d2p1:RoadSideAssistance>
      <d2p1:Servicing>0</d2p1:Servicing>
      <d2p1:Tyres>0</d2p1:Tyres>
    </d2p1:BudgetBalances>
    <d2p1:BudgetBreakdown>
      <d2p1:AdministrationFee>0</d2p1:AdministrationFee>
      <d2p1:AnythingExtra>0</d2p1:AnythingExtra>
      <d2p1:CarWash>0</d2p1:CarWash>
      <d2p1:Fuel>0</d2p1:Fuel>
      <d2p1:Insurance>0</d2p1:Insurance>
      <d2p1:LeaseAmount>0</d2p1:LeaseAmount>
      <d2p1:Registration>0</d2p1:Registration>
      <d2p1:RoadSideAssistance>0</d2p1:RoadSideAssistance>
      <d2p1:Servicing>0</d2p1:Servicing>
      <d2p1:Tyres>0</d2p1:Tyres>
    </d2p1:BudgetBreakdown>
    <d2p1:CurrentBalance>0</d2p1:CurrentBalance>
    <d2p1:CustomerFirstName>String</d2p1:CustomerFirstName>
    <d2p1:CustomerId>String</d2p1:CustomerId>
    <d2p1:CustomerLastName>String</d2p1:CustomerLastName>
    <d2p1:Employment>
      <d2p1:EmployerId>String</d2p1:EmployerId>
      <d2p1:EmployerName>String</d2p1:EmployerName>
      <d2p1:FirstPayDate>0001-01-01T00:00:00</d2p1:FirstPayDate>
      <d2p1:PayrollCycle>String</d2p1:PayrollCycle>
    </d2p1:Employment>
    <d2p1:ForecastedOutgoingPayments>
      <d2p1:ForecastedOutgoingPayment>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:BudgetCategory>String</d2p1:BudgetCategory>
        <d2p1:Matched>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:BudgetCategory>String</d2p1:BudgetCategory>
          <d2p1:Gst>0</d2p1:Gst>
        </d2p1:Matched>
        <d2p1:Scheduled>0001-01-01T00:00:00</d2p1:Scheduled>
      </d2p1:ForecastedOutgoingPayment>
    </d2p1:ForecastedOutgoingPayments>
    <d2p1:ForecastedSalarySacrifices>
      <d2p1:ForecastedSalarySacrifice>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:Matched>
          <d2p1:ContributionId>String</d2p1:ContributionId>
          <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
          <d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
          <d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
          <d2p1:SalarySacrificeBreakdown>
            <d2p1:AdministrationFee>0</d2p1:AdministrationFee>
            <d2p1:AnythingExtra>0</d2p1:AnythingExtra>
            <d2p1:CarWash>0</d2p1:CarWash>
            <d2p1:Fuel>0</d2p1:Fuel>
            <d2p1:Insurance>0</d2p1:Insurance>
            <d2p1:LeaseAmount>0</d2p1:LeaseAmount>
            <d2p1:Registration>0</d2p1:Registration>
            <d2p1:RoadSideAssistance>0</d2p1:RoadSideAssistance>
            <d2p1:Servicing>0</d2p1:Servicing>
            <d2p1:Tyres>0</d2p1:Tyres>
          </d2p1:SalarySacrificeBreakdown>
        </d2p1:Matched>
        <d2p1:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
      </d2p1:ForecastedSalarySacrifice>
    </d2p1:ForecastedSalarySacrifices>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:LeaseDetails>
      <d2p1:AmountFinanced>0</d2p1:AmountFinanced>
      <d2p1:FinanceProvider>String</d2p1:FinanceProvider>
      <d2p1:FringeBenefitTaxBusinessUse>0</d2p1:FringeBenefitTaxBusinessUse>
      <d2p1:FringeBenefitTaxMethod>String</d2p1:FringeBenefitTaxMethod>
      <d2p1:FringeBenefitTaxStartDate>0001-01-01T00:00:00</d2p1:FringeBenefitTaxStartDate>
      <d2p1:FringeBenefitTaxValue>0</d2p1:FringeBenefitTaxValue>
      <d2p1:GstOnPostTaxDeduction>0</d2p1:GstOnPostTaxDeduction>
      <d2p1:InsuranceDueDate>0001-01-01T00:00:00</d2p1:InsuranceDueDate>
      <d2p1:LeaseProviderBankAccount>
        <d2p1:AccountNumber>String</d2p1:AccountNumber>
        <d2p1:BsbNumber>String</d2p1:BsbNumber>
      </d2p1:LeaseProviderBankAccount>
      <d2p1:LuxuryVehicleCharge>0</d2p1:LuxuryVehicleCharge>
      <d2p1:OnRoadCost>0</d2p1:OnRoadCost>
      <d2p1:PaymentAmount>0</d2p1:PaymentAmount>
      <d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
      <d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
      <d2p1:RegistrationDueDate>0001-01-01T00:00:00</d2p1:RegistrationDueDate>
      <d2p1:ResidualValue>0</d2p1:ResidualValue>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:Term>0</d2p1:Term>
      <d2p1:YearlyKmsTravelled>0</d2p1:YearlyKmsTravelled>
    </d2p1:LeaseDetails>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Transactions>
      <d2p1:Transaction>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:BudgetCategory>String</d2p1:BudgetCategory>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Gst>0</d2p1:Gst>
        <d2p1:Received>0001-01-01T00:00:00</d2p1:Received>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:Transaction>
    </d2p1:Transactions>
    <d2p1:Vehicle>
      <d2p1:BodyShape>String</d2p1:BodyShape>
      <d2p1:Colour>String</d2p1:Colour>
      <d2p1:LicensePlate>String</d2p1:LicensePlate>
      <d2p1:Make>String</d2p1:Make>
      <d2p1:ManufactureYear>0</d2p1:ManufactureYear>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:Transmission>String</d2p1:Transmission>
    </d2p1:Vehicle>
  </SalaryPackage>
</SetVehicleResponse>