YM REST Services

<back to all web services

InformzBulkUploadForDuesRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permissions:/admin/email/, Informz
The following routes are available for this service:
POST/Ams/{ClientID}/InformzBulkUploadForDuesUpload emails and personal data to Informz for dues.
InformzBulkUploadForDuesRequest Parameters:
NameParameterData TypeRequiredDescription
GroupNamebodystringNo
Statusbodyint?No
datLowerbodystringNo
datUpperbodystringNo
CardFailedbodyboolNo
InvoiceNobodyint?No
PaymentOptionbodyint?No
cdlIDsToExcludebodystringNo
InvoiceURLbodystringNo
datSentMinbodystringNo
datSentMaxbodystringNo
cdlModifierIDsbodystringNo
HasOutstandingBalancebodyint?No
datDueminbodystringNo
datDuemaxbodystringNo
datPaymentAppliedMinbodystringNo
datPaymentAppliedMaxbodystringNo
datPaymentCreatedMinbodystringNo
datPaymentCreatedMaxbodystringNo
OrganizationbodystringNo
InvoicePaymentURLbodystringNo
cdlGroupIDsbodystringNo
InstallmentFilterbodyint?No
cdlMembershipIDsbodystringNo
NamebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

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 /Ams/{ClientID}/InformzBulkUploadForDues HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GroupName":"String","Status":0,"datLower":"String","datUpper":"String","CardFailed":false,"InvoiceNo":0,"PaymentOption":0,"cdlIDsToExclude":"String","InvoiceURL":"String","datSentMin":"String","datSentMax":"String","cdlModifierIDs":"String","HasOutstandingBalance":0,"datDuemin":"String","datDuemax":"String","datPaymentAppliedMin":"String","datPaymentAppliedMax":"String","datPaymentCreatedMin":"String","datPaymentCreatedMax":"String","Organization":"String","InvoicePaymentURL":"String","cdlGroupIDs":"String","InstallmentFilter":0,"cdlMembershipIDs":"String","Name":"String","UsingRedis":true,"AppInitTime":"2024-05-03T02:57:06.8960121-04:00","ServerID":"WS-5-59-079","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T04:29:23.6511639-04:00","Device":"Desktop"}