Required permission: | CreatePayables |
POST | /Finance/CreatePayable/{vendor_id} |
---|
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 FinanceCreatePayableDistributionRequest:
account: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinanceCreatePayableRequest:
vendor_id: Optional[str] = None
total_amount: Decimal = decimal.Decimal(0)
tax_amount: Optional[Decimal] = None
tax_schedule: Optional[str] = None
tax_account: Optional[str] = None
description: Optional[str] = None
batch_id: Optional[str] = None
is_eft: bool = False
invoice_id: Optional[str] = None
chequebook: Optional[str] = None
document_date: datetime.datetime = datetime.datetime(1, 1, 1)
post_date: datetime.datetime = datetime.datetime(1, 1, 1)
distributions: Optional[List[FinanceCreatePayableDistributionRequest]] = None
Python FinanceCreatePayableRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/CreatePayable/{vendor_id} HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"vendor_id":"String","total_amount":0,"tax_amount":0,"tax_schedule":"String","tax_account":"String","description":"String","batch_id":"String","is_eft":false,"invoice_id":"String","chequebook":"String","document_date":"0001-01-01T00:00:00.0000000","post_date":"0001-01-01T00:00:00.0000000","distributions":[{"account":"String","amount":0,"description":"String"}]}
HTTP/1.1 200 OK Content-Type: application/json 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-01T00:00:00.0000000","post_date":"0001-01-01T00:00:00.0000000","cheque_date":"0001-01-01T00:00:00.0000000","due_date":"0001-01-01T00:00:00.0000000","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}