Billiecart API

<back to all web services

DistributeContributionRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/contributions/{Id}/distribute
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Contributions
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class ContributionSalaryPackage
            Implements IIdentifiableResource
            Public Overridable Property PreTaxDeduction As Nullable(Of Decimal)
            Public Overridable Property PostTaxDeduction As Nullable(Of Decimal)
            Public Overridable Property SalarySacrificeBreakdown As SalarySacrificeBreakdown
            Public Overridable Property Id As String
        End Class

        Public Partial Class SalarySacrificeBreakdown
            Public Overridable Property LeaseAmount As Nullable(Of Decimal)
            Public Overridable Property AdministrationFee As Nullable(Of Decimal)
            Public Overridable Property Fuel As Nullable(Of Decimal)
            Public Overridable Property Servicing As Nullable(Of Decimal)
            Public Overridable Property Tyres As Nullable(Of Decimal)
            Public Overridable Property Insurance As Nullable(Of Decimal)
            Public Overridable Property CarWash As Nullable(Of Decimal)
            Public Overridable Property Registration As Nullable(Of Decimal)
            Public Overridable Property RoadSideAssistance As Nullable(Of Decimal)
            Public Overridable Property AnythingExtra As Nullable(Of Decimal)
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationTenanted(Of TResponse)
            Inherits PostOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Contributions

        Public Partial Class DistributeContributionRequest
            Inherits PostOperationTenanted(Of DistributeContributionResponse)
            Public Sub New()
                SalaryPackages = New List(Of ContributionSalaryPackage)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property SalaryPackages As List(Of ContributionSalaryPackage)
        End Class

        Public Partial Class DistributeContributionResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET DistributeContributionRequest 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 /contributions/{Id}/distribute HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	salaryPackages: 
	[
		{
			preTaxDeduction: 0,
			postTaxDeduction: 0,
			salarySacrificeBreakdown: 
			{
				leaseAmount: 0,
				administrationFee: 0,
				fuel: 0,
				servicing: 0,
				tyres: 0,
				insurance: 0,
				carWash: 0,
				registration: 0,
				roadSideAssistance: 0,
				anythingExtra: 0
			},
			id: 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
		}
	}
}