Pax8
No catalog description yet.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| OAuth 2.0 | oauth2 | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "PAX8_CREATE_COMPANY", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("PAX8_CREATE_COMPANY", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute PAX8_CREATE_COMPANY --data '{ }'Tool catalog
Available tools
30 callable operations
Create CompanyPAX8_CREATE_COMPANYCreates a new company. You can optionally include contacts in the request body to create the company with contacts in a single request. If no contacts are provided, the company will be placed in an "inactive" status until the [company has primary contacts added](#tag/Contacts). Once contacts are added, the company will move to "Active".Connection
Creates a new company. You can optionally include contacts in the request body to create the company with contacts in a single request. If no contacts are provided, the company will be placed in an "inactive" status until the [company has primary contacts added](#tag/Contacts). Once contacts are added, the company will move to "Active".
Authentication
Connected account requiredTags
Create OrderPAX8_CREATE_ORDERCreate a new order. Currently NOT supported for scheduled orders(orders with a future date).Connection
Create a new order. Currently NOT supported for scheduled orders(orders with a future date).
Authentication
Connected account requiredTags
Delete ContactPAX8_DELETE_COMPANIES_COMPANY_ID_CONTACTS_CONTACT_IDDeletes a contactConnection
Deletes a contact
Authentication
Connected account requiredTags
Cancel SubscriptionPAX8_DELETE_SUBSCRIPTIONS_SUBSCRIPTION_IDCancels the Subscription specified by subscriptionIdConnection
Cancels the Subscription specified by subscriptionId
Authentication
Connected account requiredTags
List ProductsPAX8_FIND_ALL_PRODUCTSReturns a paginated list of Pax8 products filtered by optional query parametersConnection
Returns a paginated list of Pax8 products filtered by optional query parameters
Authentication
Connected account requiredTags
List CompaniesPAX8_FIND_COMPANIESReturns a paginated list of all your companies filtered by optional parametersConnection
Returns a paginated list of all your companies filtered by optional parameters
Authentication
Connected account requiredTags
Customizable ReportPAX8_FIND_FINANCE_REPORT_INVOICE_LINE_ITEMSReturns a customizable report of invoices line items matching the supplied search and filter criteria, along with optional faceted aggregations.Connection
Returns a customizable report of invoices line items matching the supplied search and filter criteria, along with optional faceted aggregations.
Authentication
Connected account requiredTags
List OrdersPAX8_FIND_ORDERSReturns a paginated list of orders. Currently NOT supported for scheduled orders(orders with a future date).Connection
Returns a paginated list of orders. Currently NOT supported for scheduled orders(orders with a future date).
Authentication
Connected account requiredTags
Get Order By IDPAX8_FIND_ORDERS_BY_ORDER_IDReturns the Order record specified by OrderId. Currently NOT supported for scheduled ordersConnection
Returns the Order record specified by OrderId. Currently NOT supported for scheduled orders
Authentication
Connected account requiredTags
List Draft Invoice ItemsPAX8_FIND_PARTNER_DRAFT_INVOICE_ITEMSFetch a paginated list of draft invoice items before they are finalized into invoices. Default page is 0 and default size is 10. The maximum page size is 200. DISCLAIMER: For future-dated items, the data represents a snapshot of charges that will be applied to a future invoice as of the request date. This is not an actual invoice. Clients should be aware that the final invoice generated on the 5th of the month may differ. This endpoint does not include charges for usage-based products billed in arrears. Tax calculations are based on current account taxability status and current month tax rates, both of which are subject to change for future invoices.Connection
Fetch a paginated list of draft invoice items before they are finalized into invoices. Default page is 0 and default size is 10. The maximum page size is 200. DISCLAIMER: For future-dated items, the data represents a snapshot of charges that will be applied to a future invoice as of the request date. This is not an actual invoice. Clients should be aware that the final invoice generated on the 5th of the month may differ. This endpoint does not include charges for usage-based products billed in arrears. Tax calculations are based on current account taxability status and current month tax rates, both of which are subject to change for future invoices.
Authentication
Connected account requiredTags
List Invoice ItemsPAX8_FIND_PARTNER_INVOICE_ITEMSFetch a paginated list of invoice items. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of invoice items. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
List InvoicesPAX8_FIND_PARTNER_INVOICESFetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
Get PricingPAX8_FIND_PRICING_BY_PRODUCT_IDReturns recommended pricing and partner cost for the specified productId. A products pricing is dynamic data.Connection
Returns recommended pricing and partner cost for the specified productId. A products pricing is dynamic data.
Authentication
Connected account requiredTags
Get Product By IDPAX8_FIND_PRODUCT_BY_PRODUCT_IDReturns only the product record for the productId you specifyConnection
Returns only the product record for the productId you specify
Authentication
Connected account requiredTags
Get Product DependenciesPAX8_FIND_PRODUCT_DEPENDENCIES_BY_PRODUCT_IDReturns associated dependencies for the specified ```productId```. A products dependencies are dynamic data.Connection
Returns associated dependencies for the specified ```productId```. A products dependencies are dynamic data.
Authentication
Connected account requiredTags
Get Provisioning DetailsPAX8_FIND_PROVISION_DETAILS_BY_PRODUCT_IDReturns provisioning details for the specified productId. Provisioning details for a product are dynamic data.Connection
Returns provisioning details for the specified productId. Provisioning details for a product are dynamic data.
Authentication
Connected account requiredTags
Get Subscription By IDPAX8_FIND_SUBSCRIPTION_BY_SUBSCRIPTION_IDReturns the Subscription record specified by the subscriptionIdConnection
Returns the Subscription record specified by the subscriptionId
Authentication
Connected account requiredTags
Get Subscription HistoryPAX8_FIND_SUBSCRIPTION_HISTORY_BY_SUBSCRIPTION_IDReturns a list of changes for a subscriptionConnection
Returns a list of changes for a subscription
Authentication
Connected account requiredTags
List Usage SummariesPAX8_FIND_SUBSCRIPTION_USAGE_SUMMARIESFetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
Get Usage Summary By IDPAX8_FIND_SUBSCRIPTION_USAGE_SUMMARYFetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
List SubscriptionsPAX8_FIND_SUBSCRIPTIONSFetch a paginated list of subscriptions. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of subscriptions. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
List Usage Summary LinesPAX8_FIND_USAGE_LINESFetch a paginated list of usage lines. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of usage lines. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
Get Company By IDPAX8_GET_COMPANIES_COMPANY_IDReturns a single company record matching the ```companyId``` you specifyConnection
Returns a single company record matching the ```companyId``` you specify
Authentication
Connected account requiredTags
List ContactsPAX8_GET_COMPANIES_COMPANY_ID_CONTACTSReturns a paginated list of contacts ordered by ```createDate``` descendingConnection
Returns a paginated list of contacts ordered by ```createDate``` descending
Authentication
Connected account requiredTags
Get Contact By IDPAX8_GET_COMPANIES_COMPANY_ID_CONTACTS_CONTACT_IDReturns a contactConnection
Returns a contact
Authentication
Connected account requiredTags
Get Invoice By IDPAX8_GET_PARTNER_INVOICEFetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200Connection
Fetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200
Authentication
Connected account requiredTags
Create ContactPAX8_POST_COMPANIES_COMPANY_ID_CONTACTSCreates a new ContactConnection
Creates a new Contact
Authentication
Connected account requiredTags
Update ContactPAX8_PUT_COMPANIES_COMPANY_ID_CONTACTS_CONTACT_IDUpdate a contacts informationConnection
Update a contacts information
Authentication
Connected account requiredTags
Update CompanyPAX8_UPDATE_COMPANYUpdates an existing Company. ATTENTION - at least one parameter has to be modified.Connection
Updates an existing Company. ATTENTION - at least one parameter has to be modified.
Authentication
Connected account requiredTags
Update SubscriptionPAX8_UPDATE_SUBSCRIPTIONUpdates a subscription. Currently NOT supported for subscriptions with a future date. At least one of the following fields are required: Price, BillingTerm, Quantity, StartDateConnection
Updates a subscription. Currently NOT supported for subscriptions with a future date. At least one of the following fields are required: Price, BillingTerm, Quantity, StartDate
Authentication
Connected account requiredTags