Requires the role: | manager |
POST | /payments |
---|
import Foundation
import ServiceStack
public class CreatePaymentRequest : PostOperationTenanted<CreatePaymentResponse>
{
public var salaryPackageId:String?
public var amount:Double?
public var gstAmount:Double?
public var particulars:String?
public var budgetCategory:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case salaryPackageId
case amount
case gstAmount
case particulars
case budgetCategory
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
salaryPackageId = try container.decodeIfPresent(String.self, forKey: .salaryPackageId)
amount = try container.decodeIfPresent(Double.self, forKey: .amount)
gstAmount = try container.decodeIfPresent(Double.self, forKey: .gstAmount)
particulars = try container.decodeIfPresent(String.self, forKey: .particulars)
budgetCategory = try container.decodeIfPresent(String.self, forKey: .budgetCategory)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if salaryPackageId != nil { try container.encode(salaryPackageId, forKey: .salaryPackageId) }
if amount != nil { try container.encode(amount, forKey: .amount) }
if gstAmount != nil { try container.encode(gstAmount, forKey: .gstAmount) }
if particulars != nil { try container.encode(particulars, forKey: .particulars) }
if budgetCategory != nil { try container.encode(budgetCategory, forKey: .budgetCategory) }
}
}
public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<TResponse>, ITenantedRequest
{
public var organisationId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case organisationId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
}
}
public class PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
required public init(){}
}
public class CreatePaymentResponse : Codable
{
public var responseStatus:ResponseStatus?
public var payment:Payment?
required public init(){}
}
public class Payment : IIdentifiableResource, Codable
{
public var salaryPackageId:String?
public var amount:Double?
public var gstAmount:Double?
public var particulars:String?
public var budgetCategory:String?
public var status:String?
public var toAccount:BankAccount?
public var id:String?
required public init(){}
}
public class BankAccount : Codable
{
public var bsbNumber:String?
public var accountNumber:String?
required public init(){}
}
Swift CreatePaymentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
salaryPackageId: String,
amount: 0,
gstAmount: 0,
particulars: String,
budgetCategory: String,
organisationId: String
}
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 } }