PerfexCRM

Interact with PerfexCRM API

Actions181

Invoice Actions
- Get
- Create
- Delete
- Get Many
- Get Payments
- Send
- Update
Timesheet Actions
- Get Many
- Create
- Delete
- Get
- Update
Customer Actions
- Create
- Delete
- Get
- Get Many
- Update
- Get Contacts
- Get Contracts
- Get Invoices
- Get Projects
- Get Tickets
Ticket Actions
- Add Reply
- Assign
- Change Status
- Create
- Delete
- Delete Reply
- Get
- Get Attachments
- Get History
- Get Many
- Get Reply
- List Replies
- Update
- Update Reply
Lead Actions
- Convert
- Create
- Delete
- Get
- Get Activities
- Get Many
- Get Notes
- Update
Project Actions
- Create
- Delete
- Get
- Get Activity
- Get Files
- Get Many
- Get Milestones
- Get Tasks
- Update
Contract Actions
- Create
- Delete
- Get
- Get Attachments
- Get Comments
- Get Expired
- Get Expiring
- Get Many
- Renew
- Sign
- Update
Estimate Actions
- Convert
- Create
- Delete
- Get
- Get Many
- Send
- Update
- Get PDF
Expense Actions
- Create
- Delete
- Get
- Get Categories
- Get Many
- Update
Proposal Actions
- Accept
- Add Comment
- Create
- Decline
- Delete
- Get
- Get Many
- List Comments
- Send
- Update
- Get PDF
Staff Actions
- Activate
- Create
- Deactivate
- Delete
- Get
- Get Department List
- Get Departments
- Get Many
- Get Permissions
- Get Roles
- Update
- Change Password
- Get Tasks
- Get Timesheets
Task Actions
- Add Checklist Item
- Add Comment
- Add Timesheet
- Assign
- Change Status
- Create
- Delete
- Delete Checklist Item
- Get
- Get Attachments
- Get Checklist Item
- Get Many
- List Checklist
- List Comments
- List Timesheets
- Mark Complete
- Update
- Update Checklist Item
- Change Priority
- List Followers
- Add Follower
- Remove Follower
Credit Note Actions
- Add Refund
- Apply Credit
- Create
- Delete
- Get
- Get Many
- List Credits
- List Refunds
- Update
- Get PDF
Item Actions
- Create
- Delete
- Get
- Get Groups
- Get Many
- Update
Payment Actions
- Create
- Delete
- Get
- Get Many
- Update
Contact Actions
- Create
- Delete
- Get
- Get Many
- Update
Note Actions
- Create
- Delete
- Get
- Get Many
- Update
Knowledge Base Actions
- Create
- Delete
- Get
- Get Many
- Update
Knowledge Base Group Actions
- Create
- Delete
- Get
- Get Many
- Update
Subscription Actions
- Create
- Delete
- Get
- Get Many
- Update
Utility Actions
- Get Contract Types
- Get Countries
- Get Currencies
- Get Departments
- Get Lead Sources
- Get Lead Statuses
- Get Payment Modes
- Get Taxes
- Get Ticket Priorities
- Get Ticket Statuses

Credit Note → Get

AI-generated

Summary

Retrieve detailed information about a specific Credit Note in PerfexCRM by its ID, optionally including applied credits and refunds.

Inputs

Credit Note ID (required) — The unique identifier of the credit note to retrieve.
Options — Optional flags to include related applied credits and refunds in the response. Contains:
Include Credits — Boolean flag to include applied credits linked to the credit note.
Include Refunds — Boolean flag to include refunds linked to the credit note.

Output shape

a single JSON object representing the credit note details, potentially including nested applied credits and refunds if requested

The response contains the credit note data as returned by the PerfexCRM API. If 'Include Credits' or 'Include Refunds' options are enabled, these related collections are included in the result. Errors are returned as error objects if the request fails.

Examples

Example 1: Get a credit note with ID '123' including credits and refunds

Credit Note ID set to '123', Options: Include Credits and Include Refunds enabled

PerfexCRMInstall