Open Collective API

When working with the PayPal integration, be aware of the mapping differences between the legacy V1 schema and the current V2 schema. Specifically, the concept of a Transaction in V1 is now represented as a Capture within a Payment object in V2. This Capture contains the payment breakdown and corresponds to the internal Transactions table.

// V1 Concept
"Transaction"

// V2 Concept
"Payment" > "Capture"

Private organizations (including collectives, funds, and hosts) are designed to be usable via the dashboard and authorized integrations only. They are not discoverable or readable via public profiles.

Key constraints of the privacy model:

• No Visibility Toggle: Privacy is immutable once created. There is no user-facing flow to switch an account from public to private or vice versa. Private accounts are currently created via manual operations.
• Fiscal Host Inheritance: Privacy is inherited down a fiscal host tree. If a host is private, all its hosted children (projects, events, etc.) are also private. A single fiscal host tree must not mix public and private hosted accounts.
• Siloing: Privacy ensures that visibility into one private collective does not imply visibility into another, unless specific roles (ADMIN/ACCOUNTANT) grant access.

Private organizations are subject to specific business logic constraints to prevent accidental data leakage or cross-tree bridging:

• Cross-host expenses: Private payee accounts are prohibited from submitting expenses to collectives that reside under a different fiscal host (assertPrivateOrganizationNoCrossHostExpense).
• Adding funds: For a private host, the canAddFundsFromAccount check restricts source accounts to those belonging to that host's specific tree. The trusted-host or allow-all-accounts flags are only applicable to non-private hosts.
• Feature availability: Many public-facing features are either disabled or marked as UNSUPPORTED for private accounts, including public contribution flows (donate/checkout), public tier marketing, public funding goals, and public profile personalization.

Access to a private account is governed by the canSeePrivateAccount logic. A user is authorized to see a private account only if they meet one of the following criteria:

1. They are a root admin.
2. They hold an ADMIN or ACCOUNTANT role on the account itself.
3. They hold an ADMIN or ACCOUNTANT role on the account's fiscal host.
4. They hold an ADMIN or ACCOUNTANT role on the account's parent (applicable for projects and events).
5. They are an ADMIN/ACCOUNTANT on a hosted collective belonging to a private host organization (allowing host admins to access the host dashboard).

Unauthorized users attempting to access private accounts will receive a Forbidden error, which distinguishes the request as "exists but denied" rather than a generic "not found."

When you are finished testing, you should remove the Wise webhook to clean up your environment. Use the scripts/setup-transferwise-webhook.js script with the down command and the specific webhook ID provided when the webhook was created.

$ npm run script scripts/setup-transferwise-webhook.js down "YOUR_WEBHOOK_ID"

The repository contains various admin scripts located in the /scripts directory. To run these scripts in a local development environment (without Docker), use npx babel-node to execute the JavaScript files.

# Example: Running the populate_usernames script
$ npx babel-node ./scripts/populate_usernames.js

You can preview specific email templates locally by running the compilation script. Ensure that the necessary data for the template is provided in scripts/compile-email.js to allow the template to render correctly.

Run the following command, replacing <template name> with the name of the template you wish to view:

npm run compile:email <template name>

Before attempting to restore a full cold backup created by full-backup.sh, ensure the following tools are installed and available in your environment:

• 7zip (7z command): Required for extracting the encrypted backup archive.
• Heroku CLI (heroku command): Required for restoring Heroku database backups.
• AWS CLI (aws command): Required for restoring S3 bucket contents.
• PostgreSQL client tools: Required for manual database operations if necessary.

To make the new model available to the application, you must import it and add it to the setupModels function in models/index.ts. If the new model has relationships with existing models, define those associations within setupModels using Sequelize association methods (e.g., .belongsTo(), .hasMany()).

// Add the table to the map of models
import MyTable from './MyTable';

export function setupModels() {
  const m = {}; // models
  // ...
  m['MyTable'] = MyTable;
  // ...

  // If you want to add associations, you have to do it here:
  m.MyTable.belongsTo(m.Collective, { foreignKey: 'CollectiveId', as: 'collective' });
}