Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon One Donations API

Donations, pledges, pledge payments, recurring donations, and soft credits.

Neon One Donations API is one of 12 APIs that Neon One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Donations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 27 operations across 13 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 2.11.

Requests are made against 2 base URLs: https://api.neoncrm.com/v2, https://trial.z2systems.com/v2.

27 operations 13 paths 7 schemas 6 DELETE9 GET1 PATCH7 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.11
Base URL
https://api.neoncrm.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Neon One Donations API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication. Username is the Neon CRM organization's Org ID; password is an API key generated for a system user under Settings User Management.

Paths & Operations 27

Across 13 paths, the API surfaces 27 operations — 6 DELETE, 9 GET, 1 PATCH, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Donations 27

Donations, pledges, pledge payments, recurring donations, and soft credits.

POST
/donations
Create a donation
createDonation body → 200401
GET
/donations/{id}
Retrieve a donation
getDonation 1 param → 200404
PUT
/donations/{id}
Update a donation
updateDonation 1 param body → 200404
PATCH
/donations/{id}
Partially update a donation
patchDonation 1 param body → 200404
DELETE
/donations/{id}
Delete a donation
deleteDonation 1 param → 200404
POST
/donations/search
Search donations
searchDonations body → 200429
POST
/pledges
Create a pledge
createPledge body → 200401
GET
/pledges/{id}
Retrieve a pledge
getPledge 1 param → 200404
PUT
/pledges/{id}
Update a pledge
updatePledge 1 param body → 200404
DELETE
/pledges/{id}
Delete a pledge
deletePledge 1 param → 200404
GET
/pledges/{id}/pledgePayments
List payments made against a pledge
listPledgePayments 1 param → 200401
POST
/pledges/{id}/pledgePayments
Create a payment against a pledge
createPledgePayment 1 param body → 200401
GET
/pledges/{id}/pledgePayments/{paymentId}
Retrieve a pledge payment
getPledgePayment 2 params → 200404
DELETE
/pledges/{id}/pledgePayments/{paymentId}
Delete a pledge payment
deletePledgePayment 2 params → 200404
POST
/pledges/{pledgeId}/installments
Create a pledge installment
createPledgeInstallment 1 param body → 200401
GET
/pledges/{pledgeId}/installments/{id}
Retrieve a pledge installment
getPledgeInstallment 2 params → 200404
PUT
/pledges/{pledgeId}/installments/{id}
Update a pledge installment
updatePledgeInstallment 2 params body → 200404
DELETE
/pledges/{pledgeId}/installments/{id}
Delete a pledge installment
deletePledgeInstallment 2 params → 200404
GET
/recurring
List recurring donation schedules
listRecurringDonations → 200401
POST
/recurring
Create a recurring donation schedule
createRecurringDonation body → 200401
GET
/recurring/{id}
Retrieve a recurring donation schedule
getRecurringDonation 1 param → 200404
PUT
/recurring/{id}
Update a recurring donation schedule
updateRecurringDonation 1 param body → 200404
DELETE
/recurring/{id}
Cancel/delete a recurring donation schedule
deleteRecurringDonation 1 param → 200404
GET
/softCredits
List soft credits
listSoftCredits → 200401
POST
/softCredits
Create a soft credit
createSoftCredit body → 200401
GET
/softCredits/{id}
Retrieve a soft credit
getSoftCredit 1 param → 200404
DELETE
/softCredits/{id}
Delete a soft credit
deleteSoftCredit 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DonationInput (7 properties), RecurringDonation (6 properties), PledgeInput (4 properties), SearchRequest (3 properties). Each schema is shown below with its type and property counts.

Donation
PledgeInput
object
4 properties 2 required
RecurringDonation
object
6 properties
SearchRequest
object
3 properties 2 required
Error
object
1 property
Pledge
DonationInput
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-donations-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Accounts API
Neon One Campaigns API
Neon One Custom Fields API
Neon One Events API
Neon One Households API
Neon One Memberships API
Neon One Orders API
Neon One Properties API
Neon One Store API
Neon One Volunteers API
Neon One Webhooks API