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}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FinancePayableResponse() = 
        member val cheque_id:String = null with get,set
        member val invoice_id:String = null with get,set
        member val batch_id:String = null with get,set
        member val transaction_batch_id:String = null with get,set
        member val total_amount:Decimal = new Decimal() with get,set
        member val unapplied_amount:Decimal = new Decimal() with get,set
        member val description:String = null with get,set
        member val vendor_id:String = null with get,set
        member val vendor_name:String = null with get,set
        member val doc_type:String = null with get,set
        member val is_posted:Boolean = new Boolean() with get,set
        member val is_paid:Boolean = new Boolean() with get,set
        member val is_voided:Boolean = new Boolean() with get,set
        member val is_reimbursed:Boolean = new Boolean() with get,set
        member val doc_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val post_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val cheque_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val due_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FinanceCreatePayableDistributionRequest() = 
        member val account:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val description:String = null with get,set

    [<AllowNullLiteral>]
    type FinanceCreatePayableRequest() = 
        member val vendor_id:String = null with get,set
        member val total_amount:Decimal = new Decimal() with get,set
        member val tax_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val tax_schedule:String = null with get,set
        member val tax_account:String = null with get,set
        member val description:String = null with get,set
        member val batch_id:String = null with get,set
        member val is_eft:Boolean = new Boolean() with get,set
        member val invoice_id:String = null with get,set
        member val chequebook:String = null with get,set
        member val document_date:DateTime = new DateTime() with get,set
        member val post_date:DateTime = new DateTime() with get,set
        member val distributions:ResizeArray<FinanceCreatePayableDistributionRequest> = new ResizeArray<FinanceCreatePayableDistributionRequest>() with get,set

F# 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
		}
	}
}