DocsPayments

Take in search parameters to query the Zpass Database and Central Payments Database then merge the data into as single merged object.

post/api/v1/DocsPayments/GetAdminPortalPayments

Request

Request body

ProviderIdinteger
PageSizeinteger
PageNumberinteger
StartDateRangestring date-time
EndDateRangestring date-time
CheckNumberstring
PayerCheckNumberstring
PaymentIdinteger
AmountTextstring
OnHoldboolean
PaymentStatusesstring
PaymentPoliciesstring
ExcludePaymentPoliciesstring
PaymentMethodinteger
PayerIdsinteger[]
GroupCodestring
Source'Unknown' | 'Zpass' | 'Docs' | 'DocsPayee'
EvaluateGoGreenboolean
UseJaguarVersionboolean
RetrievePaymentsForFallbackProviderboolean
RinTinPayableProviderIdsinteger[]
RINsstring[]

Response

OK

Countinteger
Successboolean
UserFriendlyMessagestring
Exceptionstring

Changes

No recorded changes to this operation across all 1 revision of this API.