Billiecart API

<back to all web services

DistributeContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/contributions/{Id}/distribute
namespace Application.Interfaces.Resources

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

    [<AllowNullLiteral>]
    type DistributeContributionResponse() = 
        member val ResponseStatus:ResponseStatus = null 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 ContributionSalaryPackage() = 
        member val PreTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PostTaxDeduction:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val SalarySacrificeBreakdown:SalarySacrificeBreakdown = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type DistributeContributionRequest() = 
        inherit PostOperationTenanted<DistributeContributionResponse>()
        member val Id:String = null with get,set
        member val SalaryPackages:ResizeArray<ContributionSalaryPackage> = new ResizeArray<ContributionSalaryPackage>() with get,set

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

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# DistributeContributionRequest DTOs

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

HTTP + CSV

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

POST /contributions/{Id}/distribute HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","salaryPackages":[{"preTaxDeduction":0,"postTaxDeduction":0,"salarySacrificeBreakdown":{"leaseAmount":0,"administrationFee":0,"fuel":0,"servicing":0,"tyres":0,"insurance":0,"carWash":0,"registration":0,"roadSideAssistance":0,"anythingExtra":0},"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"}}}