# New Zealand Charities Register Portfolio Status Monitor (`plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor`) Actor

Watch named New Zealand Charities Register CC numbers; emit Registered/Deregistered/Removed status events (with deregistration date + reason) and register notices from official Charities Services open data. Portfolio PPE only - not a register dump.

- **URL**: https://apify.com/plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor.md
- **Developed by:** [Daniel Witney](https://apify.com/plym-actor-factory) (community)
- **Categories:** Business, Automation, AI
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $20.00 / 1,000 nz charity status event delivereds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## New Zealand Charities Register Portfolio Status Monitor

Watch named **New Zealand Charities Register registration numbers (CC#####)** against the official **Charities Services (Department of Internal Affairs) open-data OData** feed.

**Who this is for:** NZ grant-makers and community / gaming trusts that must fund eligible registered charities; corporate giving and payroll-giving programmes; donation and fundraising platforms that badge "registered charity"; banks and accountants doing charity KYC; and umbrella / federation bodies watching member branches. The recurring job: **tell me when a charity on my grantee or partner list is deregistered or removed, why, and when a register warning notice (e.g. failure to file an annual return) appears.**

Billable events (PPE `nz-charity-status-event-delivered` @ $0.02):

| Group | Event | Meaning |
|-------|-------|---------|
| `status` | `STATUS_CHANGED` | Registered → Deregistered / Removed (with deregistration date and reason, e.g. failed to file annual returns, at own request, incorporated-society entity removed) |
| `status` | `DEREGISTRATION_REASON_CHANGED` | Deregistration reason text changed |
| `notices` | `NOTICE_CHANGED` | Register notice added / updated / cleared (e.g. failure-to-file warnings) |
| `directory` | `APPEARED` / `DROPPED` | Number appeared on / disappeared from the open data |
| `attributes` (opt-in) | `NAME_CHANGED` / `NZBN_CHANGED` / `ANNUAL_RETURN_DUE_CHANGED` | Name, NZBN or annual-return due-date changed |

Non-billable: `RUN_STATUS` (`FIXTURE_HEALTH`, `MONITOR_IDLE`, `CATCHUP_COMPLETE`, `HEALTH_OK`), first-run baselines, duplicates. Quiet books cost only the platform start fee.

**Not** a register dump billed per row (batched watchlist `$filter` only). **Not** annual-return financial extraction.

### Quick start

1. Replace the example `charityNumbers` with your watchlist (e.g. `CC48519`).
2. Set `sourceMode` = **live**.
3. Save as an Actor Task and schedule (weekly or daily).
4. **First run vs later runs:** run 1 baselines each charity (no change events, no product charge). Run 2+ emits diffs against that checkpoint — keep the same Task.

Default `sourceMode=fixture` is a **free health check** (one non-billable `RUN_STATUS` row), not product data.

### What you get per $0.02 event

One delivered unique change for a named charity, with charity name, registration status, deregistration date and reason, before/after values and the official source URL. Never charged: `RUN_STATUS`, baselines, quiet `MONITOR_IDLE`, invalid numbers, duplicates, fixture SAMPLE rows.

### Example output (SAMPLE)

SAMPLE — illustrative field shape; not a real event:

```json
{
  "charity_number": "SAMPLE01",
  "charity_name": "EXAMPLE CHARITY A (SAMPLE)",
  "event_type": "STATUS_CHANGED",
  "previous_value": "Registered",
  "new_value": "Deregistered",
  "deregistration_date": "2026-09-30",
  "billable": false,
  "sample": true,
  "summary": "SAMPLE (fixture demo data with placeholder entities, not a real event)"
}
```

### Input

- `charityNumbers` — CC numbers (aliases: `registrationNumbers`, `ccNumbers`); group members like `CC11026-1` supported
- `sourceMode` — `fixture` (free health check) | `live` (official OData)
- `signalGroups` — `directory`, `status`, `notices`, `attributes` (default: directory+status+notices)

### Source and honesty notes

- Official endpoint: `https://www.odata.charities.govt.nz/Organisations` (Charities Services open data; no key).
- Durable key: `CharityRegistrationNumber` (~46,000 unique; ~29,300 Registered, ~16,500 Deregistered, ~270 Removed as of 2026-10-05). Rows without a registration number are ignored.
- Cadence: live OData read at run time; `as_of` = fetch date. Register changes follow Charities Services processing, not a real-time push.
- Attribution: Source: Charities Services (Department of Internal Affairs, Te Tari Taiwhenua) New Zealand Charities Register open data. This Actor is not affiliated with or endorsed by Charities Services.

### Pricing

| Event | USD |
|-------|-----|
| `nz-charity-status-event-delivered` | $0.02 |
| `apify-actor-start` | $0.00005 |

### Limitations

- Always confirm funding or tax decisions on the official register (register.charities.govt.nz) and IRD donee lists.
- Deregistered / removed charities stay listed with their status; `DROPPED` fires only if a number disappears from the open data entirely.
- Does not extract annual-return financials.

# Actor input Schema

## `charityNumbers` (type: `array`):

NZ Charities Register registration numbers to watch (e.g. CC48519; the CC prefix is optional).

## `registrationNumbers` (type: `array`):

Optional alias merged into the watchlist.

## `ccNumbers` (type: `array`):

Optional alias merged into the watchlist.

## `signalGroups` (type: `array`):

directory (APPEARED/DROPPED), status (STATUS_CHANGED Registered/Deregistered/Removed, DEREGISTRATION_REASON_CHANGED), notices (NOTICE_CHANGED e.g. failure-to-file warnings), attributes (NAME / NZBN / annual-return-due changes). Default: directory+status+notices.

## `maxRunSeconds` (type: `integer`):

Wall-clock budget.

## `maxEvents` (type: `integer`):

Stop after this many unique change events are delivered (RUN_STATUS excluded).

## `resumeFromCheckpoint` (type: `boolean`):

If true, resume charity snapshots and seen event_uids from the default Key-Value Store (keep the same Task).

## `sourceMode` (type: `string`):

fixture = free Store/CI health check (no network; one non-billable RUN_STATUS row unless emitFixtureDemoEvents=true). live = official NZ Charities Register OData (no API key). Fixture demo rows use placeholder entities, are flagged sample=true / isSample=true, billable=false, and are never charged.

## `emitFixtureDemoEvents` (type: `boolean`):

When sourceMode=fixture, emit SAMPLE demo events from local fixtures (never charged). Default false.

## `maxTotalChargeUsd` (type: `number`):

Optional soft budget hint.

## `asOfHint` (type: `string`):

Optional as_of label (defaults to the fetch date).

## `odataBaseUrl` (type: `string`):

Optional override for the official Charities Services OData Organisations endpoint.

## Actor input object example

```json
{
  "charityNumbers": [
    "CC48519",
    "CC48103"
  ],
  "signalGroups": [
    "directory",
    "status",
    "notices"
  ],
  "maxRunSeconds": 120,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

## `OUTPUT` (type: `string`):

JSON summary: delivered, charged, runStatus, checkpoint, stats, coverage, attribution

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "charityNumbers": [
        "CC48519",
        "CC48103"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "charityNumbers": [
        "CC48519",
        "CC48103",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "charityNumbers": [
    "CC48519",
    "CC48103"
  ]
}' |
apify call plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,plym-actor-factory/nz-charities-register-cc-number-portfolio-status-monitor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/zdjlH7i2O3FGw2AId/builds/42Iu3aQ8DJYKf3M46/openapi.json