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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePayableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <cheque_id>String</cheque_id>
  <invoice_id>String</invoice_id>
</FinancePayableRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePayableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <batch_id>String</batch_id>
  <cheque_date>0001-01-01T00:00:00</cheque_date>
  <cheque_id>String</cheque_id>
  <description>String</description>
  <doc_date>0001-01-01T00:00:00</doc_date>
  <doc_type>String</doc_type>
  <due_date>0001-01-01T00:00:00</due_date>
  <invoice_id>String</invoice_id>
  <is_paid>false</is_paid>
  <is_posted>false</is_posted>
  <is_reimbursed>false</is_reimbursed>
  <is_voided>false</is_voided>
  <post_date>0001-01-01T00:00:00</post_date>
  <total_amount>0</total_amount>
  <transaction_batch_id>String</transaction_batch_id>
  <unapplied_amount>0</unapplied_amount>
  <vendor_id>String</vendor_id>
  <vendor_name>String</vendor_name>
</FinancePayableResponse>