NewPath-Consulting / warm

Pro Reports for Wild Apricot is a Google Data Studio connector that helps Wild Apricot administrators understand your organization’s membership engagement, renewal rates, and demographics. Trend your revenue and get expense analyses. Whatever your question, enjoy all the organized data you need at your fingertips to make the business decisions want.
https://newpathconsulting.com/warm
GNU General Public License v3.0
6 stars 4 forks source link

support Payments endpoint #4

Closed asirota closed 4 years ago

asirota commented 4 years ago

Add support for the Payments Wild Apricot endpoint

asirota commented 4 years ago

The /Payments object has several pieces of information required for analysis of payments & refunds.

Here are the elements to retrieve and the dimension names to apply following the ->

Id -> Payment ID (number) Value -> Payment Amount (currency) RefundedAmount -> Refunded Amount (currency) Contact.Id -> User ID (number) Contact.Name -> Contact Name (string) CreatedDate -> Payment Created Date (date) UpdatedDate -> Payment Updated Date (date) Tender.Name -> Tender (string) Comment -> Internal Comment (string) PublicComment -> Public Comment (string) AllocatedValue -> Allocated Value (currency) Type -> Payment Type (string) DonationId -> Donation ID (number)


{
  "PaymentIdentifiers": [
    0
  ],
  "Payments": [
    {
      "Id": 0,
      "Url": "string",
      "Value": 0,
      "DocumentDate": "2020-03-16",
      "Contact": {
        "Id": 0,
        "Url": "string",
        "Name": "string"
      },
      "CreatedDate": "2020-03-16",
      "CreatedBy": {
        "Id": 0,
        "Url": "string"
      },
      "UpdatedDate": "2020-03-16",
      "UpdatedBy": {
        "Id": 0,
        "Url": "string"
      },
      "Tender": {
        "Id": 0,
        "Url": "string",
        "Name": "string"
      },
      "Comment": "string",
      "PublicComment": "string",
      "AllocatedValue": 0,
      "RefundedAmount": 0,
      "Type": "Unknown",
      "DonationId": 0,
      "FieldValues": [
        {
          "FieldName": "string",
          "SystemCode": "string",
          "Value": {}
        }
      ]
    }
  ]
}```
asirota commented 4 years ago

Note paging is supported in this endpoint, there are filters too but they are specific filters rather than a filter string so can leave filters off this endpoint

miasmos commented 4 years ago

Added support for payments endpoint.