A template for generating reports
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | ReportTemplate |
| TypeScript | Services.ReportTemplate, attributes Services.ReportTemplateAttributes, schema Services.ReportTemplateSchema |
| Planning Center path | /services/v2/report_templates |
| Planning Center docs | ReportTemplate |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.report_templates |
Collection | matrix, people, plans, without_defaults |
No |
From a collection, .id(reportTemplateId) addresses one ReportTemplate: pco.services.report_templates.id(reportTemplateId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.ReportTemplateAttributes. Every resource also has id and type ('ReportTemplate') next to its attributes.
| Name | Type | Description |
|---|---|---|
body |
string | null |
|
default |
boolean | null |
A template provided by Planning Center |
title |
string | null |
|
type |
string | null |
Possible values: ReportMatrix, ReportPeople, ReportPlan |
Querying
No documented where fields.
No documented order fields.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.services.report_templates |
matrix, people, plans, without_defaults |
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const page = await pco.services.report_templates.perPage(25).list();
const items: Services.ReportTemplate[] = page.data;