Billiecart API

CreatePaymentRequest

**Requires Authentication**
Requires the role:	manager

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Payments;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class BankAccount
    {
        public virtual string BsbNumber { get; set; }
        public virtual string AccountNumber { get; set; }
    }

    public partial class Payment
        : IIdentifiableResource
    {
        public virtual string SalaryPackageId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual decimal GstAmount { get; set; }
        public virtual string Particulars { get; set; }
        public virtual string BudgetCategory { get; set; }
        public virtual string Status { get; set; }
        public virtual BankAccount ToAccount { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PostOperationTenanted<TResponse>
        : PostOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class PostOperationUnTenanted<TResponse>
        : IPost
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Payments
{
    public partial class CreatePaymentRequest
        : PostOperationTenanted<CreatePaymentResponse>
    {
        public virtual string SalaryPackageId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual decimal GstAmount { get; set; }
        public virtual string Particulars { get; set; }
        public virtual string BudgetCategory { get; set; }
    }

    public partial class CreatePaymentResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Payment Payment { get; set; }
    }

}

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