This connector allows creating the gift receipts /summary> More...

Static Public Member Functions
static bool	CreateAnnualGiftReceipts (Int32 ALedgerNumber, string AFrequency, DateTime AStartDate, DateTime AEndDate, string AHTMLTemplate, byte[] ALogoImage, string ALogoFilename, byte[] ASignatureImage, string ASignatureFilename, string ALanguage, string AEmailSubject, string AEmailBody, string AEmailFrom, string AEmailFromName, string AEmailFilename, out string APDFReceipt, out string AHTMLReceipt, out TVerificationResultCollection AVerification, bool ADeceasedFirst=false, string AExtract=null, Int64 ADonorKey=0, string AAction="all", bool AOnlyTest=true)
	create the annual gift receipts for all donors in the given year; returns the PDF file containing all receipts More...

static DataTable	GetUnreceiptedGifts (Int32 ALedgerNumber)

static string	FormatHtmlReceipt (String ADonorShortName, Int64 ADonorKey, TPartnerClass ADonorClass, String AGiftCurrency, string ALocalCountryCode, AGiftTable AGiftsThisDonor, string AHTMLTemplateFilename, TDBTransaction ATransaction)
	Create a single gift receipt More...

static string	PrintGiftReceipt (String AGiftCurrency, String ADonorShortName, Int64 ADonorKey, TPartnerClass ADonorClass, AGiftTable GiftsThisDonor, string AHTMLTemplateFilename)

static string	PrintReceipts (int ALedgerNumber, DataTable AGiftTbl, string AHTMLTemplateFilename)

static void	MarkReceiptsPrinted (Int32 ALedgerNumber, Int32 ABatchNumber, Int32 ATransactionNumber)
	Mark a gift as receipted in the AGift table. More...

static void	MarkReceiptsPrinted (int ALedgerNumber, DataTable AGiftTbl)
	Mark selected gifts as receipted in the AGift table. More...

static Int32	GetLastReceiptNumber (Int32 ALedgerNumber)

static void	SetLastReceiptNumber (Int32 ALedgerNumber, Int32 AReceiptNumber)

static bool	StoreDefaultFile (string APurpose, string AFileName, byte[] AFileContent, out TVerificationResultCollection AVerificationResult)
	Store a default HTML or logo or signature file. More...

static bool	LoadReceiptDefaults (out string AFileNameHTML, out string AFileNameLogo, out string AFileNameSignature, out string AEmailSubject, out string AEmailBody, out string AEmailFrom, out string AEmailFromName, out string AEmailFilename)
	get the filenames of the stored template files for annual gift receipt, and other defaults More...

Detailed Description

This connector allows creating the gift receipts /summary>

Member Function Documentation

◆ CreateAnnualGiftReceipts()

static bool Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.CreateAnnualGiftReceipts	(	Int32	ALedgerNumber,
		string	AFrequency,
		DateTime	AStartDate,
		DateTime	AEndDate,
		string	AHTMLTemplate,
		byte[]	ALogoImage,
		string	ALogoFilename,
		byte[]	ASignatureImage,
		string	ASignatureFilename,
		string	ALanguage,
		string	AEmailSubject,
		string	AEmailBody,
		string	AEmailFrom,
		string	AEmailFromName,
		string	AEmailFilename,
		out string	APDFReceipt,
		out string	AHTMLReceipt,
		out TVerificationResultCollection	AVerification,
		bool	ADeceasedFirst = `false`,
		string	AExtract = `null`,
		Int64	ADonorKey = `0`,
		string	AAction = `"all"`,
		bool	AOnlyTest = `true`
	)

inlinestatic

create the annual gift receipts for all donors in the given year; returns the PDF file containing all receipts

◆ FormatHtmlReceipt()

static string Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.FormatHtmlReceipt	(	String	ADonorShortName,
		Int64	ADonorKey,
		TPartnerClass	ADonorClass,
		String	AGiftCurrency,
		string	ALocalCountryCode,
		AGiftTable	AGiftsThisDonor,
		string	AHTMLTemplateFilename,
		TDBTransaction	ATransaction
	)

inlinestatic

Create a single gift receipt

Parameters

ADonorShortName
ADonorKey
ADonorClass
AGiftCurrency
ALocalCountryCode	If the addressee's country is the same as this, it won't be printed on the address label.
AGiftsThisDonor
AHTMLTemplateFilename
ATransaction	This can be read-only - nothing is written to the DB.

Returns: Complete (simple) HTML file

◆ GetLastReceiptNumber()

static Int32 Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.GetLastReceiptNumber ( Int32 ALedgerNumber )

inlinestatic

Returns

◆ GetUnreceiptedGifts()

static DataTable Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.GetUnreceiptedGifts ( Int32 ALedgerNumber )

inlinestatic

Parameters

ALedgerNumber

Returns

◆ LoadReceiptDefaults()

static bool Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.LoadReceiptDefaults	(	out string	AFileNameHTML,
		out string	AFileNameLogo,
		out string	AFileNameSignature,
		out string	AEmailSubject,
		out string	AEmailBody,
		out string	AEmailFrom,
		out string	AEmailFromName,
		out string	AEmailFilename
	)

inlinestatic

get the filenames of the stored template files for annual gift receipt, and other defaults

◆ MarkReceiptsPrinted() [1/2]

static void Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.MarkReceiptsPrinted	(	int	ALedgerNumber,
		DataTable	AGiftTbl
	)

inlinestatic

Mark selected gifts as receipted in the AGift table.

Parameters

ALedgerNumber
AGiftTbl	Custom DataTable from GetUnreceiptedGifts, above. For this method, only {bool}Selected, LedgerNumber, BatchNumber and TransactionNumber fields are needed.

Returns: True if successful

◆ MarkReceiptsPrinted() [2/2]

static void Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.MarkReceiptsPrinted	(	Int32	ALedgerNumber,
		Int32	ABatchNumber,
		Int32	ATransactionNumber
	)

inlinestatic

Mark a gift as receipted in the AGift table.

Parameters

ALedgerNumber
ABatchNumber
ATransactionNumber

◆ PrintGiftReceipt()

static string Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.PrintGiftReceipt	(	String	AGiftCurrency,
		String	ADonorShortName,
		Int64	ADonorKey,
		TPartnerClass	ADonorClass,
		AGiftTable	GiftsThisDonor,
		string	AHTMLTemplateFilename
	)

inlinestatic

Parameters

AGiftCurrency
ADonorShortName
ADonorKey
ADonorClass
GiftsThisDonor
AHTMLTemplateFilename

Returns: A Receipt formatted with HTML

◆ PrintReceipts()

static string Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.PrintReceipts	(	int	ALedgerNumber,
		DataTable	AGiftTbl,
		string	AHTMLTemplateFilename
	)

inlinestatic

Parameters

ALedgerNumber
AGiftTbl	Custom table from GetUnreceiptedGifts, above
AHTMLTemplateFilename

Returns: One or more HTML documents in a single string

◆ SetLastReceiptNumber()

static void Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.SetLastReceiptNumber	(	Int32	ALedgerNumber,
		Int32	AReceiptNumber
	)

inlinestatic

Returns

◆ StoreDefaultFile()

static bool Ict.Petra.Server.MFinance.Gift.WebConnectors.TReceiptingWebConnector.StoreDefaultFile	(	string	APurpose,
		string	AFileName,
		byte[]	AFileContent,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

Store a default HTML or logo or signature file.

The documentation for this class was generated from the following file:

csharp/ICT/Petra/Server/lib/MFinance/Gift/Gift.Receipting.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateAnnualGiftReceipts()

◆ FormatHtmlReceipt()

◆ GetLastReceiptNumber()

◆ GetUnreceiptedGifts()

◆ LoadReceiptDefaults()

◆ MarkReceiptsPrinted() [1/2]

◆ MarkReceiptsPrinted() [2/2]

◆ PrintGiftReceipt()

◆ PrintReceipts()

◆ SetLastReceiptNumber()

◆ StoreDefaultFile()