Skip to content

ItemNote (Services)

A plan item note that belongs to a category.

A plan item note that belongs to a category.

Note: You can only assign the category on create. If you want to change category; delete the current note, and create a new one passing in the item_note_category_id then.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type ItemNote
TypeScript Services.ItemNote, attributes Services.ItemNoteAttributes, schema Services.ItemNoteSchema
Planning Center path /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/item_notes
Planning Center docs ItemNote

How to reach it

Client path Returns Filters Create
pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_notes Collection Yes

From a collection, .id(itemNoteId) addresses one ItemNote: pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_notes.id(itemNoteId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.ItemNoteAttributes. Every resource also has id and type ('ItemNote') next to its attributes.

Name Type Description
category_name string | null
content string | null
created_at string | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): item_note_category.

Relationship Type To Includable
item To one Item No
item_note_category To one ItemNoteCategory Yes

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one ItemNote, ref = pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_notes.id(itemNoteId):

Edge Leads to Returns Filters Create
ref.item_note_category ItemNoteCategory Collection No

Writing

Property Value
Create Yes, create() on item_notes on Item
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Services.ItemNoteSchema['create'].

Attribute Type
content string | null
item_note_category_id string

Update attributes

Typed as Services.ItemNoteSchema['update'].

Attribute Type
content string | null

See Writing data.

Example

import type { Services } from '@mackenly/planningcenterkit';

const songId = '1'; // Song id
const itemId = '1'; // Item id

const page = await pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_notes.perPage(25).list();
const items: Services.ItemNote[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close