Billiecart API

CreatePaymentRequest

**Requires Authentication**
Requires the role:	manager

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

namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BankAccount() = 
        member val BsbNumber:String = null with get,set
        member val AccountNumber:String = null with get,set

    [<AllowNullLiteral>]
    type Payment() = 
        member val SalaryPackageId:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val GstAmount:Decimal = new Decimal() with get,set
        member val Particulars:String = null with get,set
        member val BudgetCategory:String = null with get,set
        member val Status:String = null with get,set
        member val ToAccount:BankAccount = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type CreatePaymentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Payment:Payment = null with get,set

    [<AllowNullLiteral>]
    type CreatePaymentRequest() = 
        inherit PostOperationTenanted<CreatePaymentResponse>()
        member val SalaryPackageId:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val GstAmount:Decimal = new Decimal() with get,set
        member val Particulars:String = null with get,set
        member val BudgetCategory:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# CreatePaymentRequest 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.

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
	}
}