ReportCatalogue

object

What the caller may report on: entities, fields, outcomes, ratios.

entitiesrequired: array of object
entities[].keyrequired: "leads" | "deals" | "visits" | "calls" | "tasks" | "messages" | …
entities[].labelrequired: string
entities[].nounrequired: array of any
entities[].descriptionrequired: string
entities[].default_daterequired: string
entities[].fieldsrequired: array of ReportCatalogueField
entities[].outcomesrequired: array of object
entities[].outcomes[].keyrequired: string
entities[].outcomes[].labelrequired: string
entities[].ratiosrequired: array of object
entities[].ratios[].keyrequired: string
entities[].ratios[].labelrequired: string
entities[].ratios[].moneyrequired: boolean
teamsrequired: array of object
Teams the caller may share with.
teams[].idrequired: Id
Opaque record id.
teams[].namerequired: string
canrequired: object
can.buildrequired: boolean
The plan includes the report builder (advanced reports).
can.share_companyrequired: boolean
can.schedulerequired: boolean
`reports.schedule` and a plan with scheduled reports.
can.exportrequired: boolean
can.settingsrequired: boolean
May switch outside recipients on or off (settings.company).
can.external_recipientsrequired: boolean
The company allows outside recipients.

Example

{
  "entities": [
    {
      "key": "leads",
      "label": "string",
      "noun": [],
      "description": "string",
      "default_date": "string",
      "fields": [
        {
          "key": "string",
          "label": "string",
          "type": "string",
          "section": "string",
          "options": [
            {
              "value": null,
              "label": null
            }
          ],
          "of": "string",
          "nullable": true,
          "groupable": true,
          "measurable": true,
          "rangeable": true,
          "money": true,
          "unit": "minutes",
          "day": true
        }
      ],
      "outcomes": [
        {
          "key": "string",
          "label": "string"
        }
      ],
      "ratios": [
        {
          "key": "string",
          "label": "string",
          "money": true
        }
      ]
    }
  ],
  "teams": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  ],
  "can": {
    "build": true,
    "share_company": true,
    "schedule": true,
    "export": true,
    "settings": true,
    "external_recipients": true
  }
}

{ "entities": [ { "key": "leads", "label": "string", "noun": [], "description": "string", "default_date": "string", "fields": [ { "key": "string", "label": "string", "type": "string", "section": "string", "options": [ { "value": null, "label": null } ], "of": "string", "nullable": true, "groupable": true, "measurable": true, "rangeable": true, "money": true, "unit": "minutes", "day": true } ], "outcomes": [ { "key": "string", "label": "string" } ], "ratios": [ { "key": "string", "label": "string", "money": true } ] } ], "teams": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "can": { "build": true, "share_company": true, "schedule": true, "export": true, "settings": true, "external_recipients": true } }