Billiecart API

SetCustomerBankAccountRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/customers/{Id}/bank-account

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 PutOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPut):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutOperationTenanted(Generic[TResponse], PutOperationUnTenanted[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 Customer(IIdentifiableResource):
    id: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    date_of_birth: Optional[datetime.datetime] = None
    drivers_licence_no: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    preferred_contact_method: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    suburb: Optional[str] = None
    state_territory: Optional[str] = None
    postcode: Optional[str] = None
    bank_account: Optional[BankAccount] = None
    user_account_id: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetCustomerBankAccountRequest(PutOperationTenanted[SetCustomerBankAccountResponse]):
    id: Optional[str] = None
    bank_account_number: Optional[str] = None
    bank_account_bsb_number: Optional[str] = None

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

PUT /customers/{Id}/bank-account HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	bankAccountNumber: String,
	bankAccountBsbNumber: 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
		}
	},
	customer: 
	{
		id: String,
		firstName: String,
		lastName: String,
		driversLicenceNo: String,
		email: String,
		phone: String,
		preferredContactMethod: String,
		addressLine1: String,
		addressLine2: String,
		suburb: String,
		stateTerritory: String,
		postcode: String,
		bankAccount: 
		{
			bsbNumber: String,
			accountNumber: String
		},
		userAccountId: String
	}
}