regis

CRMPaymentsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/DynamicsCRM/Payments

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.DynamicsCRM.Requests
Imports regis.DynamicsCRM.Responses

Namespace Global

    Namespace regis.DynamicsCRM.Requests

        Public Partial Class CRMPaymentsRequest
            Public Overridable Property from_date As Nullable(Of Date)
            Public Overridable Property to_date As Nullable(Of Date)
            Public Overridable Property regent_id As Nullable(Of Integer)
            Public Overridable Property start_version_number As Nullable(Of Integer)
            Public Overridable Property end_version_number As Nullable(Of Integer)
            Public Overridable Property recurring_only As Boolean
            Public Overridable Property completed_only As Boolean
        End Class
    End Namespace

    Namespace regis.DynamicsCRM.Responses

        Public Partial Class CRMPaymentResponse
            Public Overridable Property regent_id As Integer
            Public Overridable Property contact_addressee As String
            Public Overridable Property donor_first_name As String
            Public Overridable Property donor_last_name As String
            Public Overridable Property donor_addressee As String
            Public Overridable Property donor_city As String
            Public Overridable Property donor_country As String
            Public Overridable Property donor_owner_full_name As String
            Public Overridable Property is_contact As Boolean
            Public Overridable Property is_account As Boolean
            Public Overridable Property soft_credit_regent_id As Nullable(Of Integer)
            Public Overridable Property soft_credit_contact_addressee As String
            Public Overridable Property soft_credit_contact_first_name As String
            Public Overridable Property soft_credit_contact_last_name As String
            Public Overridable Property soft_credit_contact_spouse_is_main_contact As Boolean
            Public Overridable Property soft_credit_contact_city As String
            Public Overridable Property soft_credit_contact_country As String
            Public Overridable Property soft_credit_contact_owner_full_name As String
            Public Overridable Property soft_credit_second_regent_id As Nullable(Of Integer)
            Public Overridable Property soft_credit_second_contact_addressee As String
            Public Overridable Property soft_credit_second_contact_first_name As String
            Public Overridable Property soft_credit_second_contact_last_name As String
            Public Overridable Property soft_credit_second_contact_spouse_is_main_contact As Boolean
            Public Overridable Property soft_credit_second_contact_city As String
            Public Overridable Property soft_credit_second_contact_country As String
            Public Overridable Property soft_credit_second_contact_owner_full_name As String
            Public Overridable Property spouse_is_main_contact As Boolean
            Public Overridable Property import_id As Nullable(Of Integer)
            Public Overridable Property donation_id As String
            Public Overridable Property payment_id As String
            Public Overridable Property guid As String
            Public Overridable Property name As String
            Public Overridable Property description As String
            Public Overridable Property appeal_code As String
            Public Overridable Property designation As String
            Public Overridable Property designation_description As String
            Public Overridable Property general_ledger_account_number As String
            Public Overridable Property campaign As String
            Public Overridable Property total_pledge_amount As Decimal
            Public Overridable Property total_paid_amount As Decimal
            Public Overridable Property amount As Decimal
            Public Overridable Property canadian_amount As Decimal
            Public Overridable Property payment_exchange_rate As Decimal
            Public Overridable Property receipt_amount As Decimal
            Public Overridable Property gift_exchange_rate As Nullable(Of Decimal)
            Public Overridable Property total_paid_canadian_amount As Nullable(Of Decimal)
            Public Overridable Property is_recurring As Boolean
            Public Overridable Property is_complete As Boolean
            Public Overridable Property is_parent_donation As Boolean
            Public Overridable Property currency As String
            Public Overridable Property source As String
            Public Overridable Property channel As String
            Public Overridable Property receipting_organization As String
            Public Overridable Property type As String
            Public Overridable Property push_to_gp As Boolean
            Public Overridable Property finance_entry_date As Nullable(Of Date)
            Public Overridable Property finance_id As String
            Public Overridable Property acknowledgment_sent As Boolean
            Public Overridable Property send_acknowledgment As Boolean
            Public Overridable Property acknowledgment_template_guid As String
            Public Overridable Property parent_guid As String
            Public Overridable Property anonymous As Boolean
            Public Overridable Property gift_date As Nullable(Of Date)
            Public Overridable Property recurring_gift_start_date As Nullable(Of Date)
            Public Overridable Property recurring_gift_end_date As Nullable(Of Date)
            Public Overridable Property payment_date As Nullable(Of Date)
            Public Overridable Property tax_receipt As String
            Public Overridable Property tax_receipt_date_sent As Nullable(Of Date)
            Public Overridable Property cheque_number As String
            Public Overridable Property version_number As Integer
            Public Overridable Property added_date As Nullable(Of Date)
        End Class

        Public Partial Class CRMPaymentsResponse
            Public Sub New()
                payments = New List(Of CRMPaymentResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property payments As List(Of CRMPaymentResponse)
            Public Overridable Property from_date As Nullable(Of Date)
            Public Overridable Property to_date As Nullable(Of Date)
            Public Overridable Property start_version_number As Nullable(Of Integer)
            Public Overridable Property end_version_number As Nullable(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET CRMPaymentsRequest DTOs

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

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