Requires the role: | manager |
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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CreatePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Payments">
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<Amount>0</Amount>
<BudgetCategory>String</BudgetCategory>
<GstAmount>0</GstAmount>
<Particulars>String</Particulars>
<SalaryPackageId>String</SalaryPackageId>
</CreatePaymentRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreatePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Payments"> <Payment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources"> <d2p1:Amount>0</d2p1:Amount> <d2p1:BudgetCategory>String</d2p1:BudgetCategory> <d2p1:GstAmount>0</d2p1:GstAmount> <d2p1:Id>String</d2p1:Id> <d2p1:Particulars>String</d2p1:Particulars> <d2p1:SalaryPackageId>String</d2p1:SalaryPackageId> <d2p1:Status>String</d2p1:Status> <d2p1:ToAccount> <d2p1:AccountNumber>String</d2p1:AccountNumber> <d2p1:BsbNumber>String</d2p1:BsbNumber> </d2p1:ToAccount> </Payment> <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> </CreatePaymentResponse>