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 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PostOperationTenanted({this.organisationId});
    PostOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PostOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class DistributeContributionResponse implements IConvertible
{
    ResponseStatus? responseStatus;

    DistributeContributionResponse({this.responseStatus});
    DistributeContributionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "DistributeContributionResponse";
    TypeContext? context = _ctx;
}

class SalarySacrificeBreakdown implements IConvertible
{
    double? leaseAmount;
    double? administrationFee;
    double? fuel;
    double? servicing;
    double? tyres;
    double? insurance;
    double? carWash;
    double? registration;
    double? roadSideAssistance;
    double? anythingExtra;

    SalarySacrificeBreakdown({this.leaseAmount,this.administrationFee,this.fuel,this.servicing,this.tyres,this.insurance,this.carWash,this.registration,this.roadSideAssistance,this.anythingExtra});
    SalarySacrificeBreakdown.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        leaseAmount = JsonConverters.toDouble(json['leaseAmount']);
        administrationFee = JsonConverters.toDouble(json['administrationFee']);
        fuel = JsonConverters.toDouble(json['fuel']);
        servicing = JsonConverters.toDouble(json['servicing']);
        tyres = JsonConverters.toDouble(json['tyres']);
        insurance = JsonConverters.toDouble(json['insurance']);
        carWash = JsonConverters.toDouble(json['carWash']);
        registration = JsonConverters.toDouble(json['registration']);
        roadSideAssistance = JsonConverters.toDouble(json['roadSideAssistance']);
        anythingExtra = JsonConverters.toDouble(json['anythingExtra']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'leaseAmount': leaseAmount,
        'administrationFee': administrationFee,
        'fuel': fuel,
        'servicing': servicing,
        'tyres': tyres,
        'insurance': insurance,
        'carWash': carWash,
        'registration': registration,
        'roadSideAssistance': roadSideAssistance,
        'anythingExtra': anythingExtra
    };

    getTypeName() => "SalarySacrificeBreakdown";
    TypeContext? context = _ctx;
}

class ContributionSalaryPackage implements IIdentifiableResource, IConvertible
{
    double? preTaxDeduction;
    double? postTaxDeduction;
    SalarySacrificeBreakdown? salarySacrificeBreakdown;
    String? id;

    ContributionSalaryPackage({this.preTaxDeduction,this.postTaxDeduction,this.salarySacrificeBreakdown,this.id});
    ContributionSalaryPackage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        preTaxDeduction = JsonConverters.toDouble(json['preTaxDeduction']);
        postTaxDeduction = JsonConverters.toDouble(json['postTaxDeduction']);
        salarySacrificeBreakdown = JsonConverters.fromJson(json['salarySacrificeBreakdown'],'SalarySacrificeBreakdown',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'preTaxDeduction': preTaxDeduction,
        'postTaxDeduction': postTaxDeduction,
        'salarySacrificeBreakdown': JsonConverters.toJson(salarySacrificeBreakdown,'SalarySacrificeBreakdown',context!),
        'id': id
    };

    getTypeName() => "ContributionSalaryPackage";
    TypeContext? context = _ctx;
}

class DistributeContributionRequest extends PostOperationTenanted<DistributeContributionResponse> implements IConvertible
{
    String? id;
    List<ContributionSalaryPackage>? salaryPackages;

    DistributeContributionRequest({this.id,this.salaryPackages});
    DistributeContributionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        salaryPackages = JsonConverters.fromJson(json['salaryPackages'],'List<ContributionSalaryPackage>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'salaryPackages': JsonConverters.toJson(salaryPackages,'List<ContributionSalaryPackage>',context!)
    });

    getTypeName() => "DistributeContributionRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'DistributeContributionResponse': TypeInfo(TypeOf.Class, create:() => DistributeContributionResponse()),
    'SalarySacrificeBreakdown': TypeInfo(TypeOf.Class, create:() => SalarySacrificeBreakdown()),
    'ContributionSalaryPackage': TypeInfo(TypeOf.Class, create:() => ContributionSalaryPackage()),
    'DistributeContributionRequest': TypeInfo(TypeOf.Class, create:() => DistributeContributionRequest()),
    'List<ContributionSalaryPackage>': TypeInfo(TypeOf.Class, create:() => <ContributionSalaryPackage>[]),
});

Dart 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>