regis

<back to all web services

FinanceCreatePayableRequest

Requires Authentication
Required permission:CreatePayables
The following routes are available for this service:
POST/Finance/CreatePayable/{vendor_id}
import Foundation
import ServiceStack

public class FinanceCreatePayableRequest : Codable
{
    public var vendor_id:String
    public var total_amount:Double
    public var tax_amount:Double?
    public var tax_schedule:String
    public var tax_account:String
    public var Description:String
    public var batch_id:String
    public var is_eft:Bool
    public var invoice_id:String
    public var chequebook:String
    public var document_date:Date
    public var post_date:Date
    public var distributions:[FinanceCreatePayableDistributionRequest] = []

    required public init(){}
}

public class FinanceCreatePayableDistributionRequest : Codable
{
    public var account:String
    public var amount:Double
    public var Description:String

    required public init(){}
}

public class FinancePayableResponse : Codable
{
    public var cheque_id:String
    public var invoice_id:String
    public var batch_id:String
    public var transaction_batch_id:String
    public var total_amount:Double
    public var unapplied_amount:Double
    public var Description:String
    public var vendor_id:String
    public var vendor_name:String
    public var doc_type:String
    public var is_posted:Bool
    public var is_paid:Bool
    public var is_voided:Bool
    public var is_reimbursed:Bool
    public var doc_date:Date?
    public var post_date:Date?
    public var cheque_date:Date?
    public var due_date:Date?
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift FinanceCreatePayableRequest 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/CreatePayable/{vendor_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
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-01,
	post_date: 0001-01-01,
	distributions: 
	[
		{
			account: String,
			amount: 0,
			description: 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
		}
	}
}