Get a summary of the transaction schedules

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

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- daily object
  
  The transaction schedules daily estimate.
  
  Hide daily attributes Show daily attributes object
  
  incoming object
  
  Hide incoming attributes Show incoming attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  outgoing object
  
  Hide outgoing attributes Show outgoing attributes object
  
  amount string
  
  currency string
  
  formatted string
- weekly object
  
  The transaction schedules weekly estimate.
  
  Hide weekly attributes Show weekly attributes object
  
  incoming object
  
  Hide incoming attributes Show incoming attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  outgoing object
  
  Hide outgoing attributes Show outgoing attributes object
  
  amount string
  
  currency string
  
  formatted string
- monthly object
  
  The transaction schedules monthly estimate.
  
  Hide monthly attributes Show monthly attributes object
  
  incoming object
  
  Hide incoming attributes Show incoming attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  outgoing object
  
  Hide outgoing attributes Show outgoing attributes object
  
  amount string
  
  currency string
  
  formatted string
- quarterly object
  
  The transaction schedules quarterly estimate.
  
  Hide quarterly attributes Show quarterly attributes object
  
  incoming object
  
  Hide incoming attributes Show incoming attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  outgoing object
  
  Hide outgoing attributes Show outgoing attributes object
  
  amount string
  
  currency string
  
  formatted string
- annually object
  
  The transaction schedules annual estimate.
  
  Hide annually attributes Show annually attributes object
  
  incoming object
  
  Hide incoming attributes Show incoming attributes object
  
  amount string
  
  currency string
  
  formatted string
  
  outgoing object
  
  Hide outgoing attributes Show outgoing attributes object
  
  amount string
  
  currency string
  
  formatted string

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/transaction-schedule/summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --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"
    }
  }
}