Billiecart API

SearchAllContributionsRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/contributions

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 GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
    embed: Optional[str] = None
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationUnTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], IHasSearchOptions):
    distinct: Optional[str] = None
    limit: Optional[int] = None
    offset: Optional[int] = None
    sort: Optional[str] = None
    filter: Optional[str] = None
    search: Optional[str] = None


TResponse = TypeVar('TResponse')


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contribution(IIdentifiableResource):
    employer_id: Optional[str] = None
    employer_name: Optional[str] = None
    amount: Optional[Decimal] = None
    payment_date: Optional[datetime.datetime] = None
    distributed: Optional[bool] = None
    id: Optional[str] = None


class SortDirection(str, Enum):
    ASCENDING = 'Ascending'
    DESCENDING = 'Descending'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sorting:
    by: Optional[str] = None
    direction: Optional[SortDirection] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filtering:
    fields: Optional[List[str]] = None
    search: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchMetadata:
    total: Optional[int] = None
    limit: Optional[int] = None
    offset: Optional[int] = None
    sort: Optional[Sorting] = None
    filter: Optional[Filtering] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchAllContributionsResponse:
    response_status: Optional[ResponseStatus] = None
    contributions: Optional[List[Contribution]] = None
    metadata: Optional[SearchMetadata] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchAllContributionsRequest(SearchOperationTenanted[SearchAllContributionsResponse]):
    pass

Python SearchAllContributionsRequest 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.

GET /contributions HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv

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
		}
	},
	contributions: 
	[
		{
			employerId: String,
			employerName: String,
			amount: 0,
			distributed: False,
			id: String
		}
	],
	metadata: 
	{
		total: 0,
		limit: 0,
		offset: 0,
		sort: 
		{
			by: String,
			direction: Ascending
		},
		filter: 
		{
			fields: 
			[
				String
			],
			search: String
		}
	}
}