| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Payments |
|---|
"use strict";
export class CRMPaymentResponse {
/** @param {{regent_id?:number,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?:boolean,is_account?:boolean,soft_credit_regent_id?:number,soft_credit_contact_addressee?:string,soft_credit_contact_first_name?:string,soft_credit_contact_last_name?:string,soft_credit_contact_spouse_is_main_contact?:boolean,soft_credit_contact_city?:string,soft_credit_contact_country?:string,soft_credit_contact_owner_full_name?:string,soft_credit_second_regent_id?:number,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?:boolean,soft_credit_second_contact_city?:string,soft_credit_second_contact_country?:string,soft_credit_second_contact_owner_full_name?:string,spouse_is_main_contact?:boolean,import_id?:number,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?:number,total_paid_amount?:number,amount?:number,canadian_amount?:number,payment_exchange_rate?:number,receipt_amount?:number,gift_exchange_rate?:number,total_paid_canadian_amount?:number,is_recurring?:boolean,is_complete?:boolean,is_parent_donation?:boolean,currency?:string,source?:string,channel?:string,receipting_organization?:string,type?:string,push_to_gp?:boolean,finance_entry_date?:string,finance_id?:string,acknowledgment_sent?:boolean,send_acknowledgment?:boolean,acknowledgment_template_guid?:string,parent_guid?:string,anonymous?:boolean,gift_date?:string,recurring_gift_start_date?:string,recurring_gift_end_date?:string,payment_date?:string,tax_receipt?:string,tax_receipt_date_sent?:string,cheque_number?:string,version_number?:number,added_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
regent_id;
/** @type {string} */
contact_addressee;
/** @type {string} */
donor_first_name;
/** @type {string} */
donor_last_name;
/** @type {string} */
donor_addressee;
/** @type {string} */
donor_city;
/** @type {string} */
donor_country;
/** @type {string} */
donor_owner_full_name;
/** @type {boolean} */
is_contact;
/** @type {boolean} */
is_account;
/** @type {?number} */
soft_credit_regent_id;
/** @type {string} */
soft_credit_contact_addressee;
/** @type {string} */
soft_credit_contact_first_name;
/** @type {string} */
soft_credit_contact_last_name;
/** @type {boolean} */
soft_credit_contact_spouse_is_main_contact;
/** @type {string} */
soft_credit_contact_city;
/** @type {string} */
soft_credit_contact_country;
/** @type {string} */
soft_credit_contact_owner_full_name;
/** @type {?number} */
soft_credit_second_regent_id;
/** @type {string} */
soft_credit_second_contact_addressee;
/** @type {string} */
soft_credit_second_contact_first_name;
/** @type {string} */
soft_credit_second_contact_last_name;
/** @type {boolean} */
soft_credit_second_contact_spouse_is_main_contact;
/** @type {string} */
soft_credit_second_contact_city;
/** @type {string} */
soft_credit_second_contact_country;
/** @type {string} */
soft_credit_second_contact_owner_full_name;
/** @type {boolean} */
spouse_is_main_contact;
/** @type {?number} */
import_id;
/** @type {string} */
donation_id;
/** @type {string} */
payment_id;
/** @type {string} */
guid;
/** @type {string} */
name;
/** @type {string} */
description;
/** @type {string} */
appeal_code;
/** @type {string} */
designation;
/** @type {string} */
designation_description;
/** @type {string} */
general_ledger_account_number;
/** @type {string} */
campaign;
/** @type {number} */
total_pledge_amount;
/** @type {number} */
total_paid_amount;
/** @type {number} */
amount;
/** @type {number} */
canadian_amount;
/** @type {number} */
payment_exchange_rate;
/** @type {number} */
receipt_amount;
/** @type {?number} */
gift_exchange_rate;
/** @type {?number} */
total_paid_canadian_amount;
/** @type {boolean} */
is_recurring;
/** @type {boolean} */
is_complete;
/** @type {boolean} */
is_parent_donation;
/** @type {string} */
currency;
/** @type {string} */
source;
/** @type {string} */
channel;
/** @type {string} */
receipting_organization;
/** @type {string} */
type;
/** @type {boolean} */
push_to_gp;
/** @type {?string} */
finance_entry_date;
/** @type {string} */
finance_id;
/** @type {boolean} */
acknowledgment_sent;
/** @type {boolean} */
send_acknowledgment;
/** @type {string} */
acknowledgment_template_guid;
/** @type {string} */
parent_guid;
/** @type {boolean} */
anonymous;
/** @type {?string} */
gift_date;
/** @type {?string} */
recurring_gift_start_date;
/** @type {?string} */
recurring_gift_end_date;
/** @type {?string} */
payment_date;
/** @type {string} */
tax_receipt;
/** @type {?string} */
tax_receipt_date_sent;
/** @type {string} */
cheque_number;
/** @type {number} */
version_number;
/** @type {?string} */
added_date;
}
export class CRMPaymentsResponse {
/** @param {{responseStatus?:ResponseStatus,payments?:CRMPaymentResponse[],from_date?:string,to_date?:string,start_version_number?:number,end_version_number?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {CRMPaymentResponse[]} */
payments;
/** @type {?string} */
from_date;
/** @type {?string} */
to_date;
/** @type {?number} */
start_version_number;
/** @type {?number} */
end_version_number;
}
export class CRMPaymentsRequest {
/** @param {{from_date?:string,to_date?:string,regent_id?:number,start_version_number?:number,end_version_number?:number,recurring_only?:boolean,completed_only?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
from_date;
/** @type {?string} */
to_date;
/** @type {?number} */
regent_id;
/** @type {?number} */
start_version_number;
/** @type {?number} */
end_version_number;
/** @type {boolean} */
recurring_only;
/** @type {boolean} */
completed_only;
}
JavaScript CRMPaymentsRequest DTOs
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>