Billiecart API

CreateContributionRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
POST	/contributions

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 Contribution implements IIdentifiableResource, IConvertible
{
    String? employerId;
    String? employerName;
    double? amount;
    DateTime? paymentDate;
    bool? distributed;
    String? id;

    Contribution({this.employerId,this.employerName,this.amount,this.paymentDate,this.distributed,this.id});
    Contribution.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        employerId = json['employerId'];
        employerName = json['employerName'];
        amount = JsonConverters.toDouble(json['amount']);
        paymentDate = JsonConverters.fromJson(json['paymentDate'],'DateTime',context!);
        distributed = json['distributed'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'employerId': employerId,
        'employerName': employerName,
        'amount': amount,
        'paymentDate': JsonConverters.toJson(paymentDate,'DateTime',context!),
        'distributed': distributed,
        'id': id
    };

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

class CreateContributionResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Contribution? contribution;

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

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

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

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

class CreateContributionRequest extends PostOperationTenanted<CreateContributionResponse> implements IConvertible
{
    double? amount;
    DateTime? paymentDate;
    String? employerId;

    CreateContributionRequest({this.amount,this.paymentDate,this.employerId});
    CreateContributionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        amount = JsonConverters.toDouble(json['amount']);
        paymentDate = JsonConverters.fromJson(json['paymentDate'],'DateTime',context!);
        employerId = json['employerId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'amount': amount,
        'paymentDate': JsonConverters.toJson(paymentDate,'DateTime',context!),
        'employerId': employerId
    });

    getTypeName() => "CreateContributionRequest";
    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),
    'Contribution': TypeInfo(TypeOf.Class, create:() => Contribution()),
    'CreateContributionResponse': TypeInfo(TypeOf.Class, create:() => CreateContributionResponse()),
    'CreateContributionRequest': TypeInfo(TypeOf.Class, create:() => CreateContributionRequest()),
});

Dart CreateContributionRequest 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 HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"amount":0,"employerId":"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"}},"contribution":{"employerId":"String","employerName":"String","amount":0,"distributed":false,"id":"String"}}