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 .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/CreatePayable/{vendor_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceCreatePayableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <batch_id>String</batch_id>
  <chequebook>String</chequebook>
  <description>String</description>
  <distributions>
    <FinanceCreatePayableDistributionRequest>
      <account>String</account>
      <amount>0</amount>
      <description>String</description>
    </FinanceCreatePayableDistributionRequest>
  </distributions>
  <document_date>0001-01-01T00:00:00</document_date>
  <invoice_id>String</invoice_id>
  <is_eft>false</is_eft>
  <post_date>0001-01-01T00:00:00</post_date>
  <tax_account>String</tax_account>
  <tax_amount>0</tax_amount>
  <tax_schedule>String</tax_schedule>
  <total_amount>0</total_amount>
  <vendor_id>String</vendor_id>
</FinanceCreatePayableRequest>
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>