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 .xml suffix or ?format=xml

HTTP + 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>