Billiecart API

ForecastRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/packages/{id}/forecast

namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BudgetBreakdown() = 
        member val LeaseAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AdministrationFee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Fuel:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Servicing:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Tyres:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Insurance:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CarWash:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Registration:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RoadSideAssistance:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AnythingExtra:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type Employment() = 
        member val PayrollCycle:String = null with get,set
        member val FirstPayDate:DateTime = new DateTime() with get,set
        member val EmployerId:String = null with get,set
        member val EmployerName:String = null with get,set

    [<AllowNullLiteral>]
    type Vehicle() = 
        member val Make:String = null with get,set
        member val Model:String = null with get,set
        member val Colour:String = null with get,set
        member val BodyShape:String = null with get,set
        member val LicensePlate:String = null with get,set
        member val Transmission:String = null with get,set
        member val ManufactureYear:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BankAccount() = 
        member val BsbNumber:String = null with get,set
        member val AccountNumber:String = null with get,set

    [<AllowNullLiteral>]
    type LeaseDetails() = 
        member val Term:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AmountFinanced:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PaymentAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FinanceProvider:String = null with get,set
        member val ResidualValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val YearlyKmsTravelled:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FringeBenefitTaxValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FringeBenefitTaxMethod:String = null with get,set
        member val FringeBenefitTaxBusinessUse:Int32 = new Int32() with get,set
        member val FringeBenefitTaxStartDate:DateTime = new DateTime() with get,set
        member val PreTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PostTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val GstOnPostTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LuxuryVehicleCharge:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OnRoadCost:Decimal = new Decimal() with get,set
        member val RegistrationDueDate:DateTime = new DateTime() with get,set
        member val InsuranceDueDate:DateTime = new DateTime() with get,set
        member val LeaseProviderBankAccount:BankAccount = null with get,set

    [<AllowNullLiteral>]
    type BudgetBalances() = 
        member val LeaseAmount:Decimal = new Decimal() with get,set
        member val AdministrationFee:Decimal = new Decimal() with get,set
        member val Fuel:Decimal = new Decimal() with get,set
        member val Servicing:Decimal = new Decimal() with get,set
        member val Tyres:Decimal = new Decimal() with get,set
        member val Insurance:Decimal = new Decimal() with get,set
        member val CarWash:Decimal = new Decimal() with get,set
        member val Registration:Decimal = new Decimal() with get,set
        member val RoadSideAssistance:Decimal = new Decimal() with get,set
        member val AnythingExtra:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type SalarySacrificeBreakdown() = 
        member val LeaseAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AdministrationFee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Fuel:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Servicing:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Tyres:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Insurance:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CarWash:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Registration:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RoadSideAssistance:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AnythingExtra:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type SalarySacrifice() = 
        member val PaymentDate:DateTime = new DateTime() with get,set
        member val SalarySacrificeBreakdown:SalarySacrificeBreakdown = null with get,set
        member val PreTaxDeduction:Decimal = new Decimal() with get,set
        member val PostTaxDeduction:Decimal = new Decimal() with get,set
        member val ContributionId:String = null with get,set

    [<AllowNullLiteral>]
    type ForecastedSalarySacrifice() = 
        member val PaymentDate:DateTime = new DateTime() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Matched:SalarySacrifice = null with get,set

    [<AllowNullLiteral>]
    type Expense() = 
        member val BudgetCategory:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Gst:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type ForecastedOutgoingPayment() = 
        member val Scheduled:DateTime = new DateTime() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val BudgetCategory:String = null with get,set
        member val Matched:Expense = null with get,set

    [<AllowNullLiteral>]
    type Adjustment() = 
        member val BudgetCategory:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Gst:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set
        member val Received:DateTime = new DateTime() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type Transaction() = 
        member val Received:DateTime = new DateTime() with get,set
        member val BudgetCategory:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Gst:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type SalaryPackage() = 
        member val CustomerId:String = null with get,set
        member val CustomerFirstName:String = null with get,set
        member val CustomerLastName:String = null with get,set
        member val Status:String = null with get,set
        member val Notes:String = null with get,set
        member val BudgetBreakdown:BudgetBreakdown = null with get,set
        member val Employment:Employment = null with get,set
        member val Vehicle:Vehicle = null with get,set
        member val LeaseDetails:LeaseDetails = null with get,set
        member val BudgetBalances:BudgetBalances = null with get,set
        member val CurrentBalance:Decimal = new Decimal() with get,set
        member val ForecastedSalarySacrifices:ResizeArray<ForecastedSalarySacrifice> = new ResizeArray<ForecastedSalarySacrifice>() with get,set
        member val ForecastedOutgoingPayments:ResizeArray<ForecastedOutgoingPayment> = new ResizeArray<ForecastedOutgoingPayment>() with get,set
        member val Adjustments:ResizeArray<Adjustment> = new ResizeArray<Adjustment>() with get,set
        member val Transactions:ResizeArray<Transaction> = new ResizeArray<Transaction>() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type ForecastResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val SalaryPackage:SalaryPackage = null with get,set

    [<AllowNullLiteral>]
    type ForecastRequest() = 
        inherit PutOperationTenanted<ForecastResponse>()
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type PutOperationTenanted<'TResponse>() = 
        inherit PutOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PutOperationUnTenanted<'TResponse>() = 
        interface IPut

F# ForecastRequest 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}/forecast HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ForecastRequest 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>
  <Id>String</Id>
</ForecastRequest>

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

<ForecastResponse 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>
</ForecastResponse>