Autotask icon

Autotask

Work with Autotask PSA REST API resources

Actions125

Contract Note → List Contract Notes

AI-generated

Summary

List contract notes attached to a contract, with pagination, filtering, and optional field selection.

Inputs

  • parentId (required) — Numeric ID of the parent contract. Required to fetch notes for a specific contract.
  • returnAll — Source defaults to true (return all pages); UI properties declare false. When false, results are limited to the configured limit.
  • limit — Source default is 100; UI properties declare 50. Maximum number of results to return when returnAll is false. Min value is 1.
  • includeFields — Optional comma-separated list of Autotask contract note field names to include in the response. Leave blank to return all fields.
  • useAdvancedFilters — Source default is false. When true, enables advanced filter controls (row-builder + raw JSON escape hatch).
  • advancedFilters — Fixed collection of filter clauses (AND-joined). Each clause has a field (loaded from entity metadata), operator (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn), value, and optional UDF flag.
  • filterJson — Raw Autotask filter array for OR groups, nested clauses, or any filter the UI cannot express. Default is empty array.
  • requestOptions — Optional collection for header overrides, including Impersonation Resource ID to override the credential default for this request.

Output shape

An array of contract note objects. Pagination continues until no further pages exist, respecting returnAll and limit. Max page size is 500. If no filters are provided, a match-all clause (id >= 0) is applied automatically. Fields returned correspond to those specified via includeFields, or all fields by default.

The operation queries the Autotask REST API endpoint Contracts/{parentId}/ContractNotes/query. Filtering is handled by buildFiltersFromContext, which merges advancedFilters and filterJson with any quick filters (none are configured for this operation-scoped view, so only advanced/filterJson apply). The includeFields parameter is passed through to the API's IncludeFields request body property.

Examples

Example 1: List up to 20 contract notes for contract 12345.

parentId: 12345; returnAll: false; limit: 20

Example 2: List all contract notes for contract 12345 with only id and description fields.

parentId: 12345; returnAll: true; includeFields: id,description

Example 3: List contract notes filtered by status equals 1, using advanced filters.

parentId: 12345; useAdvancedFilters: true; advancedFilters: [{clause: [{field: 'status', operator: 'eq', value: '1'}]}]

Links

Discussion