Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Quotation Header → List Of Quotation Header

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of quotation headers. It allows users to query and filter quotations based on various criteria such as approval status, client ID, processing state, and more. This operation is useful for automating workflows that require access to quotation data, such as generating reports, syncing quotations with other systems, or triggering actions based on quotation statuses.

Practical examples:

  • Fetch all open quotations awaiting approval to notify managers.
  • Retrieve quotations filtered by client ID to update CRM records.
  • List quotations with pagination and sorting to display in dashboards.

Properties

Name Meaning
Awaiting Approval Filter quotations that are currently awaiting approval (true/false).
Client Id Filter quotations by a specific client identifier.
Closed Filter quotations that are marked as closed (true/false).
Count Limit the number of quotations returned.
Currentclientorall Filter quotations for the current client or all clients.
Includelines Include line items within each quotation header.
My Approvals Filter quotations requiring the current user's approval.
Needsprocessing Filter quotations that need processing.
Open Filter quotations that are open (true/false).
Order Primary field to order the results by (string).
Order 2 Secondary field to order the results by (string).
Order 3 Tertiary field to order the results by (string).
Order 4 Fourth-level ordering field (string).
Order 5 Fifth-level ordering field (string).
Orderdesc Boolean or flag indicating descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth-level order field.
Orderdesc 5 Descending order flag for fifth-level order field.
Page No Page number for paginated results.
Page Size Number of items per page in paginated results.
Pageinate Flag to enable or disable pagination.
Processed Filter quotations that have been processed (true/false).
Quote Status Filter quotations by their status (string).
Search Text search filter applied to quotations.
Site Id Filter quotations by site identifier.
Ticket Id Filter quotations associated with a specific ticket.
User Id Filter quotations related to a specific user.

Output

The node outputs an array of JSON objects representing quotation headers retrieved from the Halo PSA API. Each item corresponds to one quotation header and includes all fields returned by the API according to the filters and parameters specified.

If the includelines property is set, the output may also include nested line items within each quotation header.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "quotationId": "12345",
    "clientId": "67890",
    "status": "Open",
    "awaitingApproval": true,
    "lines": [
      {
        "lineId": "1",
        "description": "Product A",
        "quantity": 10
      }
    ]
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant ID, client ID, and client secret from the credentials to authorize requests.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!: Ensure that valid API authentication credentials are configured in n8n for this node.
  • Resource or Operation not found: Verify that the selected resource is "Quotation Header" and the operation is "List Of Quotation Header".
  • API request errors: Check network connectivity and API permissions. Review error messages returned in the node output if "Continue On Fail" is enabled.
  • Invalid query parameters: Make sure input properties like page size, order fields, and filters are correctly formatted and supported by the API.

Links and References

Discussion