| Required role: | REGISUserRole |
| POST | /DynamicsCRM/Payments |
|---|
export class CRMPaymentResponse
{
public regent_id: number;
public contact_addressee: string;
public donor_first_name: string;
public donor_last_name: string;
public donor_addressee: string;
public donor_city: string;
public donor_country: string;
public donor_owner_full_name: string;
public is_contact: boolean;
public is_account: boolean;
public soft_credit_regent_id?: number;
public soft_credit_contact_addressee: string;
public soft_credit_contact_first_name: string;
public soft_credit_contact_last_name: string;
public soft_credit_contact_spouse_is_main_contact: boolean;
public soft_credit_contact_city: string;
public soft_credit_contact_country: string;
public soft_credit_contact_owner_full_name: string;
public soft_credit_second_regent_id?: number;
public soft_credit_second_contact_addressee: string;
public soft_credit_second_contact_first_name: string;
public soft_credit_second_contact_last_name: string;
public soft_credit_second_contact_spouse_is_main_contact: boolean;
public soft_credit_second_contact_city: string;
public soft_credit_second_contact_country: string;
public soft_credit_second_contact_owner_full_name: string;
public spouse_is_main_contact: boolean;
public import_id?: number;
public donation_id: string;
public payment_id: string;
public guid: string;
public name: string;
public description: string;
public appeal_code: string;
public designation: string;
public designation_description: string;
public general_ledger_account_number: string;
public campaign: string;
public total_pledge_amount: number;
public total_paid_amount: number;
public amount: number;
public canadian_amount: number;
public payment_exchange_rate: number;
public receipt_amount: number;
public gift_exchange_rate?: number;
public total_paid_canadian_amount?: number;
public is_recurring: boolean;
public is_complete: boolean;
public is_parent_donation: boolean;
public currency: string;
public source: string;
public channel: string;
public receipting_organization: string;
public type: string;
public push_to_gp: boolean;
public finance_entry_date?: string;
public finance_id: string;
public acknowledgment_sent: boolean;
public send_acknowledgment: boolean;
public acknowledgment_template_guid: string;
public parent_guid: string;
public anonymous: boolean;
public gift_date?: string;
public recurring_gift_start_date?: string;
public recurring_gift_end_date?: string;
public payment_date?: string;
public tax_receipt: string;
public tax_receipt_date_sent?: string;
public cheque_number: string;
public version_number: number;
public added_date?: string;
public constructor(init?: Partial<CRMPaymentResponse>) { (Object as any).assign(this, init); }
}
export class CRMPaymentsResponse
{
public responseStatus: ResponseStatus;
public payments: CRMPaymentResponse[];
public from_date?: string;
public to_date?: string;
public start_version_number?: number;
public end_version_number?: number;
public constructor(init?: Partial<CRMPaymentsResponse>) { (Object as any).assign(this, init); }
}
export class CRMPaymentsRequest
{
public from_date?: string;
public to_date?: string;
public regent_id?: number;
public start_version_number?: number;
public end_version_number?: number;
public recurring_only: boolean;
public completed_only: boolean;
public constructor(init?: Partial<CRMPaymentsRequest>) { (Object as any).assign(this, init); }
}
TypeScript CRMPaymentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","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/csv
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-01T00:00:00.0000000","finance_id":"String","acknowledgment_sent":false,"send_acknowledgment":false,"acknowledgment_template_guid":"String","parent_guid":"String","anonymous":false,"gift_date":"0001-01-01T00:00:00.0000000","recurring_gift_start_date":"0001-01-01T00:00:00.0000000","recurring_gift_end_date":"0001-01-01T00:00:00.0000000","payment_date":"0001-01-01T00:00:00.0000000","tax_receipt":"String","tax_receipt_date_sent":"0001-01-01T00:00:00.0000000","cheque_number":"String","version_number":0,"added_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","start_version_number":0,"end_version_number":0}