Billiecart API

DistributeContributionRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
POST	/contributions/{Id}/distribute

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPost):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostOperationTenanted(Generic[TResponse], PostOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DistributeContributionResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalarySacrificeBreakdown:
    lease_amount: Optional[Decimal] = None
    administration_fee: Optional[Decimal] = None
    fuel: Optional[Decimal] = None
    servicing: Optional[Decimal] = None
    tyres: Optional[Decimal] = None
    insurance: Optional[Decimal] = None
    car_wash: Optional[Decimal] = None
    registration: Optional[Decimal] = None
    road_side_assistance: Optional[Decimal] = None
    anything_extra: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContributionSalaryPackage(IIdentifiableResource):
    pre_tax_deduction: Optional[Decimal] = None
    post_tax_deduction: Optional[Decimal] = None
    salary_sacrifice_breakdown: Optional[SalarySacrificeBreakdown] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DistributeContributionRequest(PostOperationTenanted[DistributeContributionResponse]):
    id: Optional[str] = None
    salary_packages: Optional[List[ContributionSalaryPackage]] = None

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