regis

<back to all web services

CRMPaymentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
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; }
    }

}

C# CRMPaymentsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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}