| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Payments |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.DynamicsCRM.Requests;
using regis.DynamicsCRM.Responses;
namespace regis.DynamicsCRM.Requests
{
public partial class CRMPaymentsRequest
{
public virtual DateTime? from_date { get; set; }
public virtual DateTime? to_date { get; set; }
public virtual int? regent_id { get; set; }
public virtual int? start_version_number { get; set; }
public virtual int? end_version_number { get; set; }
public virtual bool recurring_only { get; set; }
public virtual bool completed_only { get; set; }
}
}
namespace regis.DynamicsCRM.Responses
{
public partial class CRMPaymentResponse
{
public virtual int regent_id { get; set; }
public virtual string contact_addressee { get; set; }
public virtual string donor_first_name { get; set; }
public virtual string donor_last_name { get; set; }
public virtual string donor_addressee { get; set; }
public virtual string donor_city { get; set; }
public virtual string donor_country { get; set; }
public virtual string donor_owner_full_name { get; set; }
public virtual bool is_contact { get; set; }
public virtual bool is_account { get; set; }
public virtual int? soft_credit_regent_id { get; set; }
public virtual string soft_credit_contact_addressee { get; set; }
public virtual string soft_credit_contact_first_name { get; set; }
public virtual string soft_credit_contact_last_name { get; set; }
public virtual bool soft_credit_contact_spouse_is_main_contact { get; set; }
public virtual string soft_credit_contact_city { get; set; }
public virtual string soft_credit_contact_country { get; set; }
public virtual string soft_credit_contact_owner_full_name { get; set; }
public virtual int? soft_credit_second_regent_id { get; set; }
public virtual string soft_credit_second_contact_addressee { get; set; }
public virtual string soft_credit_second_contact_first_name { get; set; }
public virtual string soft_credit_second_contact_last_name { get; set; }
public virtual bool soft_credit_second_contact_spouse_is_main_contact { get; set; }
public virtual string soft_credit_second_contact_city { get; set; }
public virtual string soft_credit_second_contact_country { get; set; }
public virtual string soft_credit_second_contact_owner_full_name { get; set; }
public virtual bool spouse_is_main_contact { get; set; }
public virtual int? import_id { get; set; }
public virtual string donation_id { get; set; }
public virtual string payment_id { get; set; }
public virtual string guid { get; set; }
public virtual string name { get; set; }
public virtual string description { get; set; }
public virtual string appeal_code { get; set; }
public virtual string designation { get; set; }
public virtual string designation_description { get; set; }
public virtual string general_ledger_account_number { get; set; }
public virtual string campaign { get; set; }
public virtual decimal total_pledge_amount { get; set; }
public virtual decimal total_paid_amount { get; set; }
public virtual decimal amount { get; set; }
public virtual decimal canadian_amount { get; set; }
public virtual decimal payment_exchange_rate { get; set; }
public virtual decimal receipt_amount { get; set; }
public virtual decimal? gift_exchange_rate { get; set; }
public virtual decimal? total_paid_canadian_amount { get; set; }
public virtual bool is_recurring { get; set; }
public virtual bool is_complete { get; set; }
public virtual bool is_parent_donation { get; set; }
public virtual string currency { get; set; }
public virtual string source { get; set; }
public virtual string channel { get; set; }
public virtual string receipting_organization { get; set; }
public virtual string type { get; set; }
public virtual bool push_to_gp { get; set; }
public virtual DateTime? finance_entry_date { get; set; }
public virtual string finance_id { get; set; }
public virtual bool acknowledgment_sent { get; set; }
public virtual bool send_acknowledgment { get; set; }
public virtual string acknowledgment_template_guid { get; set; }
public virtual string parent_guid { get; set; }
public virtual bool anonymous { get; set; }
public virtual DateTime? gift_date { get; set; }
public virtual DateTime? recurring_gift_start_date { get; set; }
public virtual DateTime? recurring_gift_end_date { get; set; }
public virtual DateTime? payment_date { get; set; }
public virtual string tax_receipt { get; set; }
public virtual DateTime? tax_receipt_date_sent { get; set; }
public virtual string cheque_number { get; set; }
public virtual int version_number { get; set; }
public virtual DateTime? added_date { get; set; }
}
public partial class CRMPaymentsResponse
{
public CRMPaymentsResponse()
{
payments = new List<CRMPaymentResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<CRMPaymentResponse> payments { get; set; }
public virtual DateTime? from_date { get; set; }
public virtual DateTime? to_date { get; set; }
public virtual int? start_version_number { get; set; }
public virtual int? end_version_number { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CRMPaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
<completed_only>false</completed_only>
<end_version_number>0</end_version_number>
<from_date>0001-01-01T00:00:00</from_date>
<recurring_only>false</recurring_only>
<regent_id>0</regent_id>
<start_version_number>0</start_version_number>
<to_date>0001-01-01T00:00:00</to_date>
</CRMPaymentsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CRMPaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.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>
<end_version_number>0</end_version_number>
<from_date>0001-01-01T00:00:00</from_date>
<payments>
<CRMPaymentResponse>
<acknowledgment_sent>false</acknowledgment_sent>
<acknowledgment_template_guid>String</acknowledgment_template_guid>
<added_date>0001-01-01T00:00:00</added_date>
<amount>0</amount>
<anonymous>false</anonymous>
<appeal_code>String</appeal_code>
<campaign>String</campaign>
<canadian_amount>0</canadian_amount>
<channel>String</channel>
<cheque_number>String</cheque_number>
<contact_addressee>String</contact_addressee>
<currency>String</currency>
<description>String</description>
<designation>String</designation>
<designation_description>String</designation_description>
<donation_id>String</donation_id>
<donor_addressee>String</donor_addressee>
<donor_city>String</donor_city>
<donor_country>String</donor_country>
<donor_first_name>String</donor_first_name>
<donor_last_name>String</donor_last_name>
<donor_owner_full_name>String</donor_owner_full_name>
<finance_entry_date>0001-01-01T00:00:00</finance_entry_date>
<finance_id>String</finance_id>
<general_ledger_account_number>String</general_ledger_account_number>
<gift_date>0001-01-01T00:00:00</gift_date>
<gift_exchange_rate>0</gift_exchange_rate>
<guid>String</guid>
<import_id>0</import_id>
<is_account>false</is_account>
<is_complete>false</is_complete>
<is_contact>false</is_contact>
<is_parent_donation>false</is_parent_donation>
<is_recurring>false</is_recurring>
<name>String</name>
<parent_guid>String</parent_guid>
<payment_date>0001-01-01T00:00:00</payment_date>
<payment_exchange_rate>0</payment_exchange_rate>
<payment_id>String</payment_id>
<push_to_gp>false</push_to_gp>
<receipt_amount>0</receipt_amount>
<receipting_organization>String</receipting_organization>
<recurring_gift_end_date>0001-01-01T00:00:00</recurring_gift_end_date>
<recurring_gift_start_date>0001-01-01T00:00:00</recurring_gift_start_date>
<regent_id>0</regent_id>
<send_acknowledgment>false</send_acknowledgment>
<soft_credit_contact_addressee>String</soft_credit_contact_addressee>
<soft_credit_contact_city>String</soft_credit_contact_city>
<soft_credit_contact_country>String</soft_credit_contact_country>
<soft_credit_contact_first_name>String</soft_credit_contact_first_name>
<soft_credit_contact_last_name>String</soft_credit_contact_last_name>
<soft_credit_contact_owner_full_name>String</soft_credit_contact_owner_full_name>
<soft_credit_contact_spouse_is_main_contact>false</soft_credit_contact_spouse_is_main_contact>
<soft_credit_regent_id>0</soft_credit_regent_id>
<soft_credit_second_contact_addressee>String</soft_credit_second_contact_addressee>
<soft_credit_second_contact_city>String</soft_credit_second_contact_city>
<soft_credit_second_contact_country>String</soft_credit_second_contact_country>
<soft_credit_second_contact_first_name>String</soft_credit_second_contact_first_name>
<soft_credit_second_contact_last_name>String</soft_credit_second_contact_last_name>
<soft_credit_second_contact_owner_full_name>String</soft_credit_second_contact_owner_full_name>
<soft_credit_second_contact_spouse_is_main_contact>false</soft_credit_second_contact_spouse_is_main_contact>
<soft_credit_second_regent_id>0</soft_credit_second_regent_id>
<source>String</source>
<spouse_is_main_contact>false</spouse_is_main_contact>
<tax_receipt>String</tax_receipt>
<tax_receipt_date_sent>0001-01-01T00:00:00</tax_receipt_date_sent>
<total_paid_amount>0</total_paid_amount>
<total_paid_canadian_amount>0</total_paid_canadian_amount>
<total_pledge_amount>0</total_pledge_amount>
<type>String</type>
<version_number>0</version_number>
</CRMPaymentResponse>
</payments>
<start_version_number>0</start_version_number>
<to_date>0001-01-01T00:00:00</to_date>
</CRMPaymentsResponse>