AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

This node allows you to create a new company record in the Pax8 system. It is useful for automating the onboarding of companies into your Pax8 partner account, managing company data programmatically, or integrating company creation into larger workflows such as CRM synchronization or billing setup.

Typical use cases include:

  • Automatically adding new customer companies when they sign up on your platform.
  • Syncing company information from external systems into Pax8.
  • Setting up company profiles with billing and self-service preferences during automated provisioning.

Properties

Name Meaning
Name The company name (string).
Address The company's address as a JSON object including street, street2, city, state/province, postal code, and country.
Phone The primary phone number of the company (string).
Website The full URL of the company website (string).
Bill On Behalf Of Enabled Boolean indicating if Pax8 handles billing transactions (true) or if the partner handles them (false).
Self Service Allowed Boolean indicating if self-service privileges are available to the company (true or false).
Order Approval Required Boolean indicating if the company's self-service orders require approval (true or false).
Additional Body Fields Optional additional fields that can be included:
- Id Unique ID of the company (string).
- External Id An external reference ID for the company (string).
- Status Company status with options: Active, Inactive, or Deleted.
- Updated Date The date and time the company was last updated (string).

Output

The node outputs JSON data representing the newly created company record as returned by the Pax8 API. This typically includes all the submitted fields along with any additional metadata assigned by the API, such as unique identifiers or timestamps.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Pax8 API.
  • The node sends requests to the Pax8 API endpoint at https://api.pax8.com/v1.
  • Proper configuration of the API authentication credentials within n8n is necessary.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Validation errors: Missing required fields like name, address, phone, or invalid JSON in the address field may cause request failures.
  • API rate limits: Excessive requests might be throttled; implement retry logic or reduce request frequency.
  • Incorrect field formats: For example, the address must be valid JSON; malformed JSON will cause errors.
  • Status field values: Only Active, Inactive, or Deleted are accepted; other values will be rejected.

Links and References

Discussion