Billiecart API

CreatePaymentRequest

**Requires Authentication**
Requires the role:	manager

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

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 BankAccount:
    bsb_number: Optional[str] = None
    account_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Payment(IIdentifiableResource):
    salary_package_id: Optional[str] = None
    amount: Optional[Decimal] = None
    gst_amount: Optional[Decimal] = None
    particulars: Optional[str] = None
    budget_category: Optional[str] = None
    status: Optional[str] = None
    to_account: Optional[BankAccount] = None
    id: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreatePaymentRequest(PostOperationTenanted[CreatePaymentResponse]):
    salary_package_id: Optional[str] = None
    amount: Optional[Decimal] = None
    gst_amount: Optional[Decimal] = None
    particulars: Optional[str] = None
    budget_category: Optional[str] = None

Python CreatePaymentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"salaryPackageId":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}