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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class DistributeContributionRequest extends PostOperationTenanted<DistributeContributionResponse>
    {
        public String id = null;
        public ArrayList<ContributionSalaryPackage> salaryPackages = null;
        
        public String getId() { return id; }
        public DistributeContributionRequest setId(String value) { this.id = value; return this; }
        public ArrayList<ContributionSalaryPackage> getSalaryPackages() { return salaryPackages; }
        public DistributeContributionRequest setSalaryPackages(ArrayList<ContributionSalaryPackage> value) { this.salaryPackages = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class DistributeContributionResponse
    {
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public DistributeContributionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ContributionSalaryPackage implements IIdentifiableResource
    {
        public BigDecimal preTaxDeduction = null;
        public BigDecimal postTaxDeduction = null;
        public SalarySacrificeBreakdown salarySacrificeBreakdown = null;
        public String id = null;
        
        public BigDecimal getPreTaxDeduction() { return preTaxDeduction; }
        public ContributionSalaryPackage setPreTaxDeduction(BigDecimal value) { this.preTaxDeduction = value; return this; }
        public BigDecimal getPostTaxDeduction() { return postTaxDeduction; }
        public ContributionSalaryPackage setPostTaxDeduction(BigDecimal value) { this.postTaxDeduction = value; return this; }
        public SalarySacrificeBreakdown getSalarySacrificeBreakdown() { return salarySacrificeBreakdown; }
        public ContributionSalaryPackage setSalarySacrificeBreakdown(SalarySacrificeBreakdown value) { this.salarySacrificeBreakdown = value; return this; }
        public String getId() { return id; }
        public ContributionSalaryPackage setId(String value) { this.id = value; return this; }
    }

    public static class SalarySacrificeBreakdown
    {
        public BigDecimal leaseAmount = null;
        public BigDecimal administrationFee = null;
        public BigDecimal fuel = null;
        public BigDecimal servicing = null;
        public BigDecimal tyres = null;
        public BigDecimal insurance = null;
        public BigDecimal carWash = null;
        public BigDecimal registration = null;
        public BigDecimal roadSideAssistance = null;
        public BigDecimal anythingExtra = null;
        
        public BigDecimal getLeaseAmount() { return leaseAmount; }
        public SalarySacrificeBreakdown setLeaseAmount(BigDecimal value) { this.leaseAmount = value; return this; }
        public BigDecimal getAdministrationFee() { return administrationFee; }
        public SalarySacrificeBreakdown setAdministrationFee(BigDecimal value) { this.administrationFee = value; return this; }
        public BigDecimal getFuel() { return fuel; }
        public SalarySacrificeBreakdown setFuel(BigDecimal value) { this.fuel = value; return this; }
        public BigDecimal getServicing() { return servicing; }
        public SalarySacrificeBreakdown setServicing(BigDecimal value) { this.servicing = value; return this; }
        public BigDecimal getTyres() { return tyres; }
        public SalarySacrificeBreakdown setTyres(BigDecimal value) { this.tyres = value; return this; }
        public BigDecimal getInsurance() { return insurance; }
        public SalarySacrificeBreakdown setInsurance(BigDecimal value) { this.insurance = value; return this; }
        public BigDecimal getCarWash() { return carWash; }
        public SalarySacrificeBreakdown setCarWash(BigDecimal value) { this.carWash = value; return this; }
        public BigDecimal getRegistration() { return registration; }
        public SalarySacrificeBreakdown setRegistration(BigDecimal value) { this.registration = value; return this; }
        public BigDecimal getRoadSideAssistance() { return roadSideAssistance; }
        public SalarySacrificeBreakdown setRoadSideAssistance(BigDecimal value) { this.roadSideAssistance = value; return this; }
        public BigDecimal getAnythingExtra() { return anythingExtra; }
        public SalarySacrificeBreakdown setAnythingExtra(BigDecimal value) { this.anythingExtra = value; return this; }
    }

}

Java DistributeContributionRequest 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.

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

<DistributeContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Id>String</Id>
  <SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:ContributionSalaryPackage>
      <d2p1:Id>String</d2p1:Id>
      <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:ContributionSalaryPackage>
  </SalaryPackages>
</DistributeContributionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DistributeContributionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Contributions">
  <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>
</DistributeContributionResponse>