AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Overview

The "Find Partner Invoices" operation in the Invoices resource allows users to retrieve a list of invoices associated with partners, filtered and sorted according to various criteria. This node is useful for automating financial workflows such as invoice reconciliation, reporting, or monitoring outstanding payments. For example, a user can fetch all unpaid invoices within a specific date range or sort invoices by due date to prioritize payment processing.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls to refine the invoice search results. Includes:
- Page The page number to request in the invoices list (pagination).
- Size Number of invoices to return per page.
- Sort Field and direction to sort invoices by. Options: Invoice Date, Due Date, Status, Partner Name, Total, Balance, Carried Balance. Format: fieldName,direction (e.g., invoiceDate,desc).
- Status Filter invoices by status. Options: Unpaid, Paid, Void, Carried, Nothing Due.
- Invoice Date Return only invoices matching this exact invoice date (string format).
- Invoice Date Range Start Return invoices with an invoice date greater than or equal to this date.
- Invoice Date Range End Return invoices with an invoice date less than or equal to this date.
- Due Date Return only invoices matching this exact due date.
- Total Return only invoices matching this total amount.
- Balance Return only invoices matching this balance amount.
- Carried Balance Return only invoices matching this carried balance amount.
- Company Id Return only invoices matching this company identifier.

Output

The node outputs JSON data representing the list of partner invoices that match the specified query parameters. Each item in the output typically contains invoice details such as invoice date, due date, status, partner name, total amount, balance, and other relevant financial fields. There is no indication that binary data is returned by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Pax8 Partner API.
  • The base URL for API requests is https://api.pax8.com/v1.
  • The node expects JSON responses and sends requests with appropriate headers (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Common issues:
    • Incorrect or missing API authentication token may result in authorization errors.
    • Providing invalid date formats or unsupported filter values could cause the API to reject the request.
    • Pagination parameters (page, size) set incorrectly might lead to empty or incomplete results.
  • Error messages:
    • Authorization errors typically indicate problems with the API key or credentials; verify and update them accordingly.
    • Validation errors from the API often specify which query parameter is invalid; check the input values against allowed formats and options.
    • Network or connectivity errors suggest checking internet access or API endpoint availability.

Links and References

Discussion