Get a summary of the transaction schedules

GET /api/v1/plans/{plan_uuid}/transaction-schedule/summary

Headers

Path parameters

plan_uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- daily object
  
  The transaction schedules daily estimate.
  
  Additional properties are allowed.
- weekly object
  
  The transaction schedules weekly estimate.
  
  Additional properties are allowed.
- monthly object
  
  The transaction schedules monthly estimate.
  
  Additional properties are allowed.
- quarterly object
  
  The transaction schedules quarterly estimate.
  
  Additional properties are allowed.
- annually object
  
  The transaction schedules annual estimate.
  
  Additional properties are allowed.

GET /api/v1/plans/{plan_uuid}/transaction-schedule/summary

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/transaction-schedule/summary \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "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"
    }
  }
}