regis

FinancePayableRequest

**Requires Authentication**
Required permission:	CreatePayables

The following routes are available for this service:
POST	/Finance/Payable

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePayableResponse:
    cheque_id: Optional[str] = None
    invoice_id: Optional[str] = None
    batch_id: Optional[str] = None
    transaction_batch_id: Optional[str] = None
    total_amount: Decimal = decimal.Decimal(0)
    unapplied_amount: Decimal = decimal.Decimal(0)
    description: Optional[str] = None
    vendor_id: Optional[str] = None
    vendor_name: Optional[str] = None
    doc_type: Optional[str] = None
    is_posted: bool = False
    is_paid: bool = False
    is_voided: bool = False
    is_reimbursed: bool = False
    doc_date: Optional[datetime.datetime] = None
    post_date: Optional[datetime.datetime] = None
    cheque_date: Optional[datetime.datetime] = None
    due_date: Optional[datetime.datetime] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancePayableRequest:
    cheque_id: Optional[str] = None
    invoice_id: Optional[str] = None

Python FinancePayableRequest 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 /Finance/Payable HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	cheque_id: String,
	invoice_id: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	cheque_id: String,
	invoice_id: String,
	batch_id: String,
	transaction_batch_id: String,
	total_amount: 0,
	unapplied_amount: 0,
	description: String,
	vendor_id: String,
	vendor_name: String,
	doc_type: String,
	is_posted: False,
	is_paid: False,
	is_voided: False,
	is_reimbursed: False,
	doc_date: 0001-01-01,
	post_date: 0001-01-01,
	cheque_date: 0001-01-01,
	due_date: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}