| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/DuesTransactions | Return all Dues Transactions for a given criteria. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateFrom | query | DateTime? | No | |
| PageSize | query | int | No | |
| PageNumber | query | int | No | |
| OffSet | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DuesTransactionsList | form | List<DuesTransactionData> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionID | form | int | No | |
| Status | form | string | No | |
| ClosedBy | form | string | No | |
| PaymentType | form | string | No | |
| DateSubmitted | form | DateTime | No | |
| DateScheduled | form | DateTime | No | |
| DateProcessed | form | DateTime | No | |
| Amount | form | double | No | |
| BalanceDue | form | double | No | |
| WebsiteMemberID | form | int | No | |
| ConstituentID | form | string | No | |
| DateMemberSignup | form | DateTime | No | |
| MemberPrimaryGroup | form | string | No | |
| Title | form | string | No | |
| FirstName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| Suffix | form | string | No | |
| form | string | No | ||
| Organization | form | string | No | |
| MembershipRequested | form | string | No | |
| CurrentMembershipExpDate | form | DateTime | No | |
| CurrentMembership | form | string | No | |
| CardName | form | string | No | |
| CardType | form | string | No | |
| CardNumber | form | string | No | |
| CardMonth | form | string | No | |
| CardYear | form | string | No | |
| CurrentMemberOrganization | form | string | No | |
| CurrentMemberAddress1 | form | string | No | |
| CurrentMemberAddress2 | form | string | No | |
| CurrentMemberCity | form | string | No | |
| CurrentMemberState | form | string | No | |
| CurrentMemberProvince | form | string | No | |
| CurrentMemberPostalCode | form | string | No | |
| CurrentMemberCountry | form | string | No | |
| BillingPhone | form | string | No | |
| BillingAddress1 | form | string | No | |
| BillingAddress2 | form | string | No | |
| BillingCity | form | string | No | |
| BillingState | form | string | No | |
| BillingPostalCode | form | string | No | |
| BillingCountry | form | string | No | |
| ReferenceNumber | form | string | No | |
| PromotionalCode | form | string | No | |
| MemberComments | form | string | No | |
| AdminComments | form | string | No | |
| InvoiceNumber | form | int | No | |
| Terms | form | string | No | |
| MemberType | form | string | No | |
| BillingOrganization | form | string | No | |
| MemberAPIGUID | form | string | No | |
| InvoiceDate | form | DateTime | No | |
| PurchaseOrderNo | form | string | No | |
| NextInstallmentDate | form | DateTime | No | |
| NextInstallmentAmount | form | double | No | |
| TotalInstallmentPaymentsToDate | form | double | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/DuesTransactions HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DuesTransactionsList":[{"TransactionID":0,"Status":"String","ClosedBy":"String","PaymentType":"String","DateSubmitted":"0001-01-01T00:00:00.0000000","DateScheduled":"0001-01-01T00:00:00.0000000","DateProcessed":"0001-01-01T00:00:00.0000000","Amount":0,"BalanceDue":0,"WebsiteMemberID":0,"ConstituentID":"String","DateMemberSignup":"0001-01-01T00:00:00.0000000","MemberPrimaryGroup":"String","Title":"String","FirstName":"String","MiddleName":"String","LastName":"String","Suffix":"String","Email":"String","Organization":"String","MembershipRequested":"String","CurrentMembershipExpDate":"0001-01-01T00:00:00.0000000","CurrentMembership":"String","CardName":"String","CardType":"String","CardNumber":"String","CardMonth":"String","CardYear":"String","CurrentMemberOrganization":"String","CurrentMemberAddress1":"String","CurrentMemberAddress2":"String","CurrentMemberCity":"String","CurrentMemberState":"String","CurrentMemberProvince":"String","CurrentMemberPostalCode":"String","CurrentMemberCountry":"String","BillingPhone":"String","BillingAddress1":"String","BillingAddress2":"String","BillingCity":"String","BillingState":"String","BillingPostalCode":"String","BillingCountry":"String","ReferenceNumber":"String","PromotionalCode":"String","MemberComments":"String","AdminComments":"String","InvoiceNumber":0,"Terms":"String","MemberType":"String","BillingOrganization":"String","MemberAPIGUID":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","PurchaseOrderNo":"String","NextInstallmentDate":"0001-01-01T00:00:00.0000000","NextInstallmentAmount":0,"TotalInstallmentPaymentsToDate":0}],"DateFrom":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2024-05-03T04:46:15.5457256-04:00","ServerID":"WS-4-7-585","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-03T05:56:49.2309618-04:00","Device":"Desktop"}