| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Payments |
|---|
namespace regis.DynamicsCRM.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CRMPaymentResponse() =
member val regent_id:Int32 = new Int32() with get,set
member val contact_addressee:String = null with get,set
member val donor_first_name:String = null with get,set
member val donor_last_name:String = null with get,set
member val donor_addressee:String = null with get,set
member val donor_city:String = null with get,set
member val donor_country:String = null with get,set
member val donor_owner_full_name:String = null with get,set
member val is_contact:Boolean = new Boolean() with get,set
member val is_account:Boolean = new Boolean() with get,set
member val soft_credit_regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val soft_credit_contact_addressee:String = null with get,set
member val soft_credit_contact_first_name:String = null with get,set
member val soft_credit_contact_last_name:String = null with get,set
member val soft_credit_contact_spouse_is_main_contact:Boolean = new Boolean() with get,set
member val soft_credit_contact_city:String = null with get,set
member val soft_credit_contact_country:String = null with get,set
member val soft_credit_contact_owner_full_name:String = null with get,set
member val soft_credit_second_regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val soft_credit_second_contact_addressee:String = null with get,set
member val soft_credit_second_contact_first_name:String = null with get,set
member val soft_credit_second_contact_last_name:String = null with get,set
member val soft_credit_second_contact_spouse_is_main_contact:Boolean = new Boolean() with get,set
member val soft_credit_second_contact_city:String = null with get,set
member val soft_credit_second_contact_country:String = null with get,set
member val soft_credit_second_contact_owner_full_name:String = null with get,set
member val spouse_is_main_contact:Boolean = new Boolean() with get,set
member val import_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val donation_id:String = null with get,set
member val payment_id:String = null with get,set
member val guid:String = null with get,set
member val name:String = null with get,set
member val description:String = null with get,set
member val appeal_code:String = null with get,set
member val designation:String = null with get,set
member val designation_description:String = null with get,set
member val general_ledger_account_number:String = null with get,set
member val campaign:String = null with get,set
member val total_pledge_amount:Decimal = new Decimal() with get,set
member val total_paid_amount:Decimal = new Decimal() with get,set
member val amount:Decimal = new Decimal() with get,set
member val canadian_amount:Decimal = new Decimal() with get,set
member val payment_exchange_rate:Decimal = new Decimal() with get,set
member val receipt_amount:Decimal = new Decimal() with get,set
member val gift_exchange_rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val total_paid_canadian_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val is_recurring:Boolean = new Boolean() with get,set
member val is_complete:Boolean = new Boolean() with get,set
member val is_parent_donation:Boolean = new Boolean() with get,set
member val currency:String = null with get,set
member val source:String = null with get,set
member val channel:String = null with get,set
member val receipting_organization:String = null with get,set
member val type:String = null with get,set
member val push_to_gp:Boolean = new Boolean() with get,set
member val finance_entry_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val finance_id:String = null with get,set
member val acknowledgment_sent:Boolean = new Boolean() with get,set
member val send_acknowledgment:Boolean = new Boolean() with get,set
member val acknowledgment_template_guid:String = null with get,set
member val parent_guid:String = null with get,set
member val anonymous:Boolean = new Boolean() with get,set
member val gift_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val recurring_gift_start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val recurring_gift_end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val payment_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val tax_receipt:String = null with get,set
member val tax_receipt_date_sent:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val cheque_number:String = null with get,set
member val version_number:Int32 = new Int32() with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type CRMPaymentsResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val payments:ResizeArray<CRMPaymentResponse> = new ResizeArray<CRMPaymentResponse>() with get,set
member val from_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val to_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val start_version_number:Nullable<Int32> = new Nullable<Int32>() with get,set
member val end_version_number:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type CRMPaymentsRequest() =
member val from_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val to_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val regent_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val start_version_number:Nullable<Int32> = new Nullable<Int32>() with get,set
member val end_version_number:Nullable<Int32> = new Nullable<Int32>() with get,set
member val recurring_only:Boolean = new Boolean() with get,set
member val completed_only:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /DynamicsCRM/Payments HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
from_date: 0001-01-01,
to_date: 0001-01-01,
regent_id: 0,
start_version_number: 0,
end_version_number: 0,
recurring_only: False,
completed_only: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
payments:
[
{
regent_id: 0,
contact_addressee: String,
donor_first_name: String,
donor_last_name: String,
donor_addressee: String,
donor_city: String,
donor_country: String,
donor_owner_full_name: String,
is_contact: False,
is_account: False,
soft_credit_regent_id: 0,
soft_credit_contact_addressee: String,
soft_credit_contact_first_name: String,
soft_credit_contact_last_name: String,
soft_credit_contact_spouse_is_main_contact: False,
soft_credit_contact_city: String,
soft_credit_contact_country: String,
soft_credit_contact_owner_full_name: String,
soft_credit_second_regent_id: 0,
soft_credit_second_contact_addressee: String,
soft_credit_second_contact_first_name: String,
soft_credit_second_contact_last_name: String,
soft_credit_second_contact_spouse_is_main_contact: False,
soft_credit_second_contact_city: String,
soft_credit_second_contact_country: String,
soft_credit_second_contact_owner_full_name: String,
spouse_is_main_contact: False,
import_id: 0,
donation_id: String,
payment_id: String,
guid: String,
name: String,
description: String,
appeal_code: String,
designation: String,
designation_description: String,
general_ledger_account_number: String,
campaign: String,
total_pledge_amount: 0,
total_paid_amount: 0,
amount: 0,
canadian_amount: 0,
payment_exchange_rate: 0,
receipt_amount: 0,
gift_exchange_rate: 0,
total_paid_canadian_amount: 0,
is_recurring: False,
is_complete: False,
is_parent_donation: False,
currency: String,
source: String,
channel: String,
receipting_organization: String,
type: String,
push_to_gp: False,
finance_entry_date: 0001-01-01,
finance_id: String,
acknowledgment_sent: False,
send_acknowledgment: False,
acknowledgment_template_guid: String,
parent_guid: String,
anonymous: False,
gift_date: 0001-01-01,
recurring_gift_start_date: 0001-01-01,
recurring_gift_end_date: 0001-01-01,
payment_date: 0001-01-01,
tax_receipt: String,
tax_receipt_date_sent: 0001-01-01,
cheque_number: String,
version_number: 0,
added_date: 0001-01-01
}
],
from_date: 0001-01-01,
to_date: 0001-01-01,
start_version_number: 0,
end_version_number: 0
}