Billiecart API

CreatePaymentRequest

**Requires Authentication**
Requires the role:	manager

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

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 BankAccount implements IConvertible
{
    String? bsbNumber;
    String? accountNumber;

    BankAccount({this.bsbNumber,this.accountNumber});
    BankAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        bsbNumber = json['bsbNumber'];
        accountNumber = json['accountNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'bsbNumber': bsbNumber,
        'accountNumber': accountNumber
    };

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

class Payment implements IIdentifiableResource, IConvertible
{
    String? salaryPackageId;
    double? amount;
    double? gstAmount;
    String? particulars;
    String? budgetCategory;
    String? status;
    BankAccount? toAccount;
    String? id;

    Payment({this.salaryPackageId,this.amount,this.gstAmount,this.particulars,this.budgetCategory,this.status,this.toAccount,this.id});
    Payment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        salaryPackageId = json['salaryPackageId'];
        amount = JsonConverters.toDouble(json['amount']);
        gstAmount = JsonConverters.toDouble(json['gstAmount']);
        particulars = json['particulars'];
        budgetCategory = json['budgetCategory'];
        status = json['status'];
        toAccount = JsonConverters.fromJson(json['toAccount'],'BankAccount',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'salaryPackageId': salaryPackageId,
        'amount': amount,
        'gstAmount': gstAmount,
        'particulars': particulars,
        'budgetCategory': budgetCategory,
        'status': status,
        'toAccount': JsonConverters.toJson(toAccount,'BankAccount',context!),
        'id': id
    };

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

class CreatePaymentResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Payment? payment;

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

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

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

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

class CreatePaymentRequest extends PostOperationTenanted<CreatePaymentResponse> implements IConvertible
{
    String? salaryPackageId;
    double? amount;
    double? gstAmount;
    String? particulars;
    String? budgetCategory;

    CreatePaymentRequest({this.salaryPackageId,this.amount,this.gstAmount,this.particulars,this.budgetCategory});
    CreatePaymentRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        salaryPackageId = json['salaryPackageId'];
        amount = JsonConverters.toDouble(json['amount']);
        gstAmount = JsonConverters.toDouble(json['gstAmount']);
        particulars = json['particulars'];
        budgetCategory = json['budgetCategory'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'salaryPackageId': salaryPackageId,
        'amount': amount,
        'gstAmount': gstAmount,
        'particulars': particulars,
        'budgetCategory': budgetCategory
    });

    getTypeName() => "CreatePaymentRequest";
    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),
    'BankAccount': TypeInfo(TypeOf.Class, create:() => BankAccount()),
    'Payment': TypeInfo(TypeOf.Class, create:() => Payment()),
    'CreatePaymentResponse': TypeInfo(TypeOf.Class, create:() => CreatePaymentResponse()),
    'CreatePaymentRequest': TypeInfo(TypeOf.Class, create:() => CreatePaymentRequest()),
});

Dart CreatePaymentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /payments HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"salaryPackageId":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"payment":{"salaryPackageId":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","status":"String","toAccount":{"bsbNumber":"String","accountNumber":"String"},"id":"String"}}