Get a summary of the transaction schedules

GET /api/v1/plans/{plan_uuid}/transaction-schedule/summary
Personal access token & O auth2

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • daily object

      The transaction schedules daily estimate.

    • weekly object

      The transaction schedules weekly estimate.

    • monthly object

      The transaction schedules monthly estimate.

    • quarterly object

      The transaction schedules quarterly estimate.

    • annually object

      The transaction schedules annual estimate.
GET /api/v1/plans/{plan_uuid}/transaction-schedule/summary 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction-schedule/summary' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "daily": {
    "incoming": {
      "amount": "1000",
      "currency": "GBP",
      "formatted": "£10.00"
    },
    "outgoing": {
      "amount": "-1000",
      "currency": "GBP",
      "formatted": "-£10.00"
    }
  },
  "weekly": {
    "incoming": {
      "amount": "1000",
      "currency": "GBP",
      "formatted": "£10.00"
    },
    "outgoing": {
      "amount": "-1000",
      "currency": "GBP",
      "formatted": "-£10.00"
    }
  },
  "monthly": {
    "incoming": {
      "amount": "1000",
      "currency": "GBP",
      "formatted": "£10.00"
    },
    "outgoing": {
      "amount": "-1000",
      "currency": "GBP",
      "formatted": "-£10.00"
    }
  },
  "annually": {
    "incoming": {
      "amount": "1000",
      "currency": "GBP",
      "formatted": "£10.00"
    },
    "outgoing": {
      "amount": "-1000",
      "currency": "GBP",
      "formatted": "-£10.00"
    }
  },
  "quarterly": {
    "incoming": {
      "amount": "1000",
      "currency": "GBP",
      "formatted": "£10.00"
    },
    "outgoing": {
      "amount": "-1000",
      "currency": "GBP",
      "formatted": "-£10.00"
    }
  }
}