Billiecart API

SetBudgetBreakdownRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/packages/{Id}/budget-breakdown

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Adjustment
        : IIdentifiableResource
    {
        public virtual string BudgetCategory { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual decimal Gst { get; set; }
        public virtual string Description { get; set; }
        public virtual DateTime Received { get; set; }
        public virtual string Id { get; set; }
    }

    public partial class BankAccount
    {
        public virtual string BsbNumber { get; set; }
        public virtual string AccountNumber { get; set; }
    }

    public partial class BudgetBalances
    {
        public virtual decimal LeaseAmount { get; set; }
        public virtual decimal AdministrationFee { get; set; }
        public virtual decimal Fuel { get; set; }
        public virtual decimal Servicing { get; set; }
        public virtual decimal Tyres { get; set; }
        public virtual decimal Insurance { get; set; }
        public virtual decimal CarWash { get; set; }
        public virtual decimal Registration { get; set; }
        public virtual decimal RoadSideAssistance { get; set; }
        public virtual decimal AnythingExtra { get; set; }
    }

    public partial class BudgetBreakdown
    {
        public virtual decimal? LeaseAmount { get; set; }
        public virtual decimal? AdministrationFee { get; set; }
        public virtual decimal? Fuel { get; set; }
        public virtual decimal? Servicing { get; set; }
        public virtual decimal? Tyres { get; set; }
        public virtual decimal? Insurance { get; set; }
        public virtual decimal? CarWash { get; set; }
        public virtual decimal? Registration { get; set; }
        public virtual decimal? RoadSideAssistance { get; set; }
        public virtual decimal? AnythingExtra { get; set; }
    }

    public partial class Employment
    {
        public virtual string PayrollCycle { get; set; }
        public virtual DateTime FirstPayDate { get; set; }
        public virtual string EmployerId { get; set; }
        public virtual string EmployerName { get; set; }
    }

    public partial class Expense
    {
        public virtual string BudgetCategory { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual decimal Gst { get; set; }
    }

    public partial class ForecastedOutgoingPayment
    {
        public virtual DateTime Scheduled { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string BudgetCategory { get; set; }
        public virtual Expense Matched { get; set; }
    }

    public partial class ForecastedSalarySacrifice
    {
        public virtual DateTime PaymentDate { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual SalarySacrifice Matched { get; set; }
    }

    public partial class LeaseDetails
    {
        public virtual int? Term { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual decimal? AmountFinanced { get; set; }
        public virtual decimal? PaymentAmount { get; set; }
        public virtual string FinanceProvider { get; set; }
        public virtual decimal? ResidualValue { get; set; }
        public virtual int? YearlyKmsTravelled { get; set; }
        public virtual decimal? FringeBenefitTaxValue { get; set; }
        public virtual string FringeBenefitTaxMethod { get; set; }
        public virtual int FringeBenefitTaxBusinessUse { get; set; }
        public virtual DateTime FringeBenefitTaxStartDate { get; set; }
        public virtual decimal? PreTaxDeduction { get; set; }
        public virtual decimal? PostTaxDeduction { get; set; }
        public virtual decimal? GstOnPostTaxDeduction { get; set; }
        public virtual decimal? LuxuryVehicleCharge { get; set; }
        public virtual decimal OnRoadCost { get; set; }
        public virtual DateTime RegistrationDueDate { get; set; }
        public virtual DateTime InsuranceDueDate { get; set; }
        public virtual BankAccount LeaseProviderBankAccount { get; set; }
    }

    public partial class SalaryPackage
        : IIdentifiableResource
    {
        public SalaryPackage()
        {
            ForecastedSalarySacrifices = new List<ForecastedSalarySacrifice>{};
            ForecastedOutgoingPayments = new List<ForecastedOutgoingPayment>{};
            Adjustments = new List<Adjustment>{};
            Transactions = new List<Transaction>{};
        }

        public virtual string CustomerId { get; set; }
        public virtual string CustomerFirstName { get; set; }
        public virtual string CustomerLastName { get; set; }
        public virtual string Status { get; set; }
        public virtual string Notes { get; set; }
        public virtual BudgetBreakdown BudgetBreakdown { get; set; }
        public virtual Employment Employment { get; set; }
        public virtual Vehicle Vehicle { get; set; }
        public virtual LeaseDetails LeaseDetails { get; set; }
        public virtual BudgetBalances BudgetBalances { get; set; }
        public virtual decimal CurrentBalance { get; set; }
        public virtual List<ForecastedSalarySacrifice> ForecastedSalarySacrifices { get; set; }
        public virtual List<ForecastedOutgoingPayment> ForecastedOutgoingPayments { get; set; }
        public virtual List<Adjustment> Adjustments { get; set; }
        public virtual List<Transaction> Transactions { get; set; }
        public virtual string Id { get; set; }
    }

    public partial class SalarySacrifice
    {
        public virtual DateTime PaymentDate { get; set; }
        public virtual SalarySacrificeBreakdown SalarySacrificeBreakdown { get; set; }
        public virtual decimal PreTaxDeduction { get; set; }
        public virtual decimal PostTaxDeduction { get; set; }
        public virtual string ContributionId { get; set; }
    }

    public partial class SalarySacrificeBreakdown
    {
        public virtual decimal? LeaseAmount { get; set; }
        public virtual decimal? AdministrationFee { get; set; }
        public virtual decimal? Fuel { get; set; }
        public virtual decimal? Servicing { get; set; }
        public virtual decimal? Tyres { get; set; }
        public virtual decimal? Insurance { get; set; }
        public virtual decimal? CarWash { get; set; }
        public virtual decimal? Registration { get; set; }
        public virtual decimal? RoadSideAssistance { get; set; }
        public virtual decimal? AnythingExtra { get; set; }
    }

    public partial class Transaction
    {
        public virtual DateTime Received { get; set; }
        public virtual string BudgetCategory { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual decimal Gst { get; set; }
        public virtual string Description { get; set; }
        public virtual string Type { get; set; }
    }

    public partial class Vehicle
    {
        public virtual string Make { get; set; }
        public virtual string Model { get; set; }
        public virtual string Colour { get; set; }
        public virtual string BodyShape { get; set; }
        public virtual string LicensePlate { get; set; }
        public virtual string Transmission { get; set; }
        public virtual int ManufactureYear { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutOperationTenanted<TResponse>
        : PutOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class PutOperationUnTenanted<TResponse>
        : IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages
{
    public partial class SetBudgetBreakdownRequest
        : PutOperationTenanted<SetBudgetBreakdownResponse>
    {
        public virtual string Id { get; set; }
        public virtual decimal? LeaseAmount { get; set; }
        public virtual decimal? AdministrationFee { get; set; }
        public virtual decimal? Fuel { get; set; }
        public virtual decimal? Servicing { get; set; }
        public virtual decimal? Tyres { get; set; }
        public virtual decimal? Insurance { get; set; }
        public virtual decimal? CarWash { get; set; }
        public virtual decimal? Registration { get; set; }
        public virtual decimal? RoadSideAssistance { get; set; }
        public virtual decimal? AnythingExtra { get; set; }
    }

    public partial class SetBudgetBreakdownResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual SalaryPackage SalaryPackage { get; set; }
    }

}

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

<SetBudgetBreakdownRequest 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>
  <AdministrationFee>0</AdministrationFee>
  <AnythingExtra>0</AnythingExtra>
  <CarWash>0</CarWash>
  <Fuel>0</Fuel>
  <Id>String</Id>
  <Insurance>0</Insurance>
  <LeaseAmount>0</LeaseAmount>
  <Registration>0</Registration>
  <RoadSideAssistance>0</RoadSideAssistance>
  <Servicing>0</Servicing>
  <Tyres>0</Tyres>
</SetBudgetBreakdownRequest>

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

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