Billiecart API

GetPaymentRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/payments/{Id}

import 'package:servicestack/servicestack.dart';

abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    String? embed;

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

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

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

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

abstract class GetOperationTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    GetOperationTenanted({this.organisationId});
    GetOperationTenanted.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() => "GetOperationTenanted<$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 GetPaymentResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Payment? payment;

    GetPaymentResponse({this.responseStatus,this.payment});
    GetPaymentResponse.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() => "GetPaymentResponse";
    TypeContext? context = _ctx;
}

class GetPaymentRequest extends GetOperationTenanted<GetPaymentResponse> implements IConvertible
{
    String? id;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'BankAccount': TypeInfo(TypeOf.Class, create:() => BankAccount()),
    'Payment': TypeInfo(TypeOf.Class, create:() => Payment()),
    'GetPaymentResponse': TypeInfo(TypeOf.Class, create:() => GetPaymentResponse()),
    'GetPaymentRequest': TypeInfo(TypeOf.Class, create:() => GetPaymentRequest()),
});

Dart GetPaymentRequest DTOs

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

HTTP + JSV

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

GET /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}