regis

<back to all web services

FinancePayableRequest

Requires Authentication
Required permission:CreatePayables
The following routes are available for this service:
POST/Finance/Payable
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinancePayableRequest
    {
        public String cheque_id = null;
        public String invoice_id = null;
        
        public String getChequeId() { return cheque_id; }
        public FinancePayableRequest setChequeId(String value) { this.cheque_id = value; return this; }
        public String getInvoiceId() { return invoice_id; }
        public FinancePayableRequest setInvoiceId(String value) { this.invoice_id = value; return this; }
    }

    public static class FinancePayableResponse
    {
        public String cheque_id = null;
        public String invoice_id = null;
        public String batch_id = null;
        public String transaction_batch_id = null;
        public BigDecimal total_amount = null;
        public BigDecimal unapplied_amount = null;
        public String description = null;
        public String vendor_id = null;
        public String vendor_name = null;
        public String doc_type = null;
        public Boolean is_posted = null;
        public Boolean is_paid = null;
        public Boolean is_voided = null;
        public Boolean is_reimbursed = null;
        public Date doc_date = null;
        public Date post_date = null;
        public Date cheque_date = null;
        public Date due_date = null;
        public ResponseStatus responseStatus = null;
        
        public String getChequeId() { return cheque_id; }
        public FinancePayableResponse setChequeId(String value) { this.cheque_id = value; return this; }
        public String getInvoiceId() { return invoice_id; }
        public FinancePayableResponse setInvoiceId(String value) { this.invoice_id = value; return this; }
        public String getBatchId() { return batch_id; }
        public FinancePayableResponse setBatchId(String value) { this.batch_id = value; return this; }
        public String getTransactionBatchId() { return transaction_batch_id; }
        public FinancePayableResponse setTransactionBatchId(String value) { this.transaction_batch_id = value; return this; }
        public BigDecimal getTotalAmount() { return total_amount; }
        public FinancePayableResponse setTotalAmount(BigDecimal value) { this.total_amount = value; return this; }
        public BigDecimal getUnappliedAmount() { return unapplied_amount; }
        public FinancePayableResponse setUnappliedAmount(BigDecimal value) { this.unapplied_amount = value; return this; }
        public String getDescription() { return description; }
        public FinancePayableResponse setDescription(String value) { this.description = value; return this; }
        public String getVendorId() { return vendor_id; }
        public FinancePayableResponse setVendorId(String value) { this.vendor_id = value; return this; }
        public String getVendorName() { return vendor_name; }
        public FinancePayableResponse setVendorName(String value) { this.vendor_name = value; return this; }
        public String getDocType() { return doc_type; }
        public FinancePayableResponse setDocType(String value) { this.doc_type = value; return this; }
        public Boolean getIsPosted() { return is_posted; }
        public FinancePayableResponse setIsPosted(Boolean value) { this.is_posted = value; return this; }
        public Boolean getIsPaid() { return is_paid; }
        public FinancePayableResponse setIsPaid(Boolean value) { this.is_paid = value; return this; }
        public Boolean getIsVoided() { return is_voided; }
        public FinancePayableResponse setIsVoided(Boolean value) { this.is_voided = value; return this; }
        public Boolean getIsReimbursed() { return is_reimbursed; }
        public FinancePayableResponse setIsReimbursed(Boolean value) { this.is_reimbursed = value; return this; }
        public Date getDocDate() { return doc_date; }
        public FinancePayableResponse setDocDate(Date value) { this.doc_date = value; return this; }
        public Date getPostDate() { return post_date; }
        public FinancePayableResponse setPostDate(Date value) { this.post_date = value; return this; }
        public Date getChequeDate() { return cheque_date; }
        public FinancePayableResponse setChequeDate(Date value) { this.cheque_date = value; return this; }
        public Date getDueDate() { return due_date; }
        public FinancePayableResponse setDueDate(Date value) { this.due_date = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinancePayableResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java 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
		}
	}
}