| Requires the role: | manager |
| PUT | /packages/{Id}/update-notes |
|---|
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 SetNotesResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val SalaryPackage:SalaryPackage = null with get,set
[<AllowNullLiteral>]
type SetNotesRequest() =
inherit PutOperationTenanted<SetNotesResponse>()
member val Id:String = null with get,set
member val Notes: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
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}/update-notes HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","notes":"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"}}