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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinanceCreatePayableDistributionRequest
            Public Overridable Property account As String
            Public Overridable Property amount As Decimal
            Public Overridable Property description As String
        End Class

        Public Partial Class FinanceCreatePayableRequest
            Public Sub New()
                distributions = New List(Of FinanceCreatePayableDistributionRequest)
            End Sub

            Public Overridable Property vendor_id As String
            Public Overridable Property total_amount As Decimal
            Public Overridable Property tax_amount As Nullable(Of Decimal)
            Public Overridable Property tax_schedule As String
            Public Overridable Property tax_account As String
            Public Overridable Property description As String
            Public Overridable Property batch_id As String
            Public Overridable Property is_eft As Boolean
            Public Overridable Property invoice_id As String
            Public Overridable Property chequebook As String
            Public Overridable Property document_date As Date
            Public Overridable Property post_date As Date
            Public Overridable Property distributions As List(Of FinanceCreatePayableDistributionRequest)
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancePayableResponse
            Public Overridable Property cheque_id As String
            Public Overridable Property invoice_id As String
            Public Overridable Property batch_id As String
            Public Overridable Property transaction_batch_id As String
            Public Overridable Property total_amount As Decimal
            Public Overridable Property unapplied_amount As Decimal
            Public Overridable Property description As String
            Public Overridable Property vendor_id As String
            Public Overridable Property vendor_name As String
            Public Overridable Property doc_type As String
            Public Overridable Property is_posted As Boolean
            Public Overridable Property is_paid As Boolean
            Public Overridable Property is_voided As Boolean
            Public Overridable Property is_reimbursed As Boolean
            Public Overridable Property doc_date As Nullable(Of Date)
            Public Overridable Property post_date As Nullable(Of Date)
            Public Overridable Property cheque_date As Nullable(Of Date)
            Public Overridable Property due_date As Nullable(Of Date)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}