regis

<back to all web services

CRMTaxReceiptsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/TaxReceipts
POST/DynamicsCRM/TaxReceipts/{regent_id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptResponse:
    regent_id: int = 0
    donor_first_name: Optional[str] = None
    donor_last_name: Optional[str] = None
    guid: Optional[str] = None
    title: Optional[str] = None
    total_paid_amount: Decimal = decimal.Decimal(0)
    total_receipt_amount: Decimal = decimal.Decimal(0)
    is_annual: bool = False
    year: Optional[int] = None
    has_document: bool = False
    tax_receipt_send_method: Optional[str] = None
    status: Optional[str] = None
    tax_receipt_template_guid: Optional[str] = None
    tax_receipt_template_name: Optional[str] = None
    tax_receipt_email: Optional[str] = None
    email_sent_date: Optional[datetime.datetime] = None
    email_sent_to: Optional[str] = None
    gift_date: Optional[datetime.datetime] = None
    sent_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptsResponse:
    response_status: Optional[ResponseStatus] = None
    tax_receipts: Optional[List[CRMTaxReceiptResponse]] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMTaxReceiptsRequest:
    regent_id: Optional[int] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    has_document: bool = False
    year: Optional[int] = None

Python CRMTaxReceiptsRequest 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/TaxReceipts HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"regent_id":0,"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","has_document":false,"year":0}
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"}},"tax_receipts":[{"regent_id":0,"donor_first_name":"String","donor_last_name":"String","guid":"String","title":"String","total_paid_amount":0,"total_receipt_amount":0,"is_annual":false,"year":0,"has_document":false,"tax_receipt_send_method":"String","status":"String","tax_receipt_template_guid":"String","tax_receipt_template_name":"String","tax_receipt_email":"String","email_sent_date":"0001-01-01T00:00:00.0000000","email_sent_to":"String","gift_date":"0001-01-01T00:00:00.0000000","sent_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}