| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Payments |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class CRMPaymentsRequest
{
var from_date:Date? = null
var to_date:Date? = null
var regent_id:Int? = null
var start_version_number:Int? = null
var end_version_number:Int? = null
var recurring_only:Boolean? = null
var completed_only:Boolean? = null
}
open class CRMPaymentsResponse
{
var responseStatus:ResponseStatus? = null
var payments:ArrayList<CRMPaymentResponse> = ArrayList<CRMPaymentResponse>()
var from_date:Date? = null
var to_date:Date? = null
var start_version_number:Int? = null
var end_version_number:Int? = null
}
open class CRMPaymentResponse
{
var regent_id:Int? = null
var contact_addressee:String? = null
var donor_first_name:String? = null
var donor_last_name:String? = null
var donor_addressee:String? = null
var donor_city:String? = null
var donor_country:String? = null
var donor_owner_full_name:String? = null
var is_contact:Boolean? = null
var is_account:Boolean? = null
var soft_credit_regent_id:Int? = null
var soft_credit_contact_addressee:String? = null
var soft_credit_contact_first_name:String? = null
var soft_credit_contact_last_name:String? = null
var soft_credit_contact_spouse_is_main_contact:Boolean? = null
var soft_credit_contact_city:String? = null
var soft_credit_contact_country:String? = null
var soft_credit_contact_owner_full_name:String? = null
var soft_credit_second_regent_id:Int? = null
var soft_credit_second_contact_addressee:String? = null
var soft_credit_second_contact_first_name:String? = null
var soft_credit_second_contact_last_name:String? = null
var soft_credit_second_contact_spouse_is_main_contact:Boolean? = null
var soft_credit_second_contact_city:String? = null
var soft_credit_second_contact_country:String? = null
var soft_credit_second_contact_owner_full_name:String? = null
var spouse_is_main_contact:Boolean? = null
var import_id:Int? = null
var donation_id:String? = null
var payment_id:String? = null
var guid:String? = null
var name:String? = null
var description:String? = null
var appeal_code:String? = null
var designation:String? = null
var designation_description:String? = null
var general_ledger_account_number:String? = null
var campaign:String? = null
var total_pledge_amount:BigDecimal? = null
var total_paid_amount:BigDecimal? = null
var amount:BigDecimal? = null
var canadian_amount:BigDecimal? = null
var payment_exchange_rate:BigDecimal? = null
var receipt_amount:BigDecimal? = null
var gift_exchange_rate:BigDecimal? = null
var total_paid_canadian_amount:BigDecimal? = null
var is_recurring:Boolean? = null
var is_complete:Boolean? = null
var is_parent_donation:Boolean? = null
var currency:String? = null
var source:String? = null
var channel:String? = null
var receipting_organization:String? = null
@SerializedName("type") var Type:String? = null
var push_to_gp:Boolean? = null
var finance_entry_date:Date? = null
var finance_id:String? = null
var acknowledgment_sent:Boolean? = null
var send_acknowledgment:Boolean? = null
var acknowledgment_template_guid:String? = null
var parent_guid:String? = null
var anonymous:Boolean? = null
var gift_date:Date? = null
var recurring_gift_start_date:Date? = null
var recurring_gift_end_date:Date? = null
var payment_date:Date? = null
var tax_receipt:String? = null
var tax_receipt_date_sent:Date? = null
var cheque_number:String? = null
var version_number:Int? = null
var added_date:Date? = null
}
Kotlin CRMPaymentsRequest DTOs
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
}