Tiny ERP icon

Tiny ERP

Interact with Tiny ERP API v3
Join our community

Actions25

Overview

This node integrates with the Tiny ERP API v3, specifically enabling users to interact with various resources such as products, customers, orders, invoices, stock, contacts, and accounts. For the Invoice resource with the Get All operation, the node fetches a list of invoices from the Tiny ERP system.

Typical use cases include:

  • Retrieving all invoices for reporting or auditing purposes.
  • Filtering invoices by search terms to find specific records.
  • Paginating through large sets of invoices to process them in batches.

For example, a user might want to get the first 50 invoices that match a certain customer name or invoice number, or paginate through pages of invoices to sync data with another system.

Properties

Name Meaning
Options Collection of optional parameters to control the query:
- Limit Maximum number of invoices to return (1 to 100). Defaults to 50.
- Page Page number of results to retrieve, starting at 1. Defaults to 1.
- Search Search term to filter invoices by matching text fields. Defaults to empty (no filtering).

Output

The output is an array of JSON objects, each representing an invoice retrieved from the Tiny ERP API. Each object contains the invoice data fields as returned by the API, which typically include invoice identifiers, dates, amounts, customer details, status, and other relevant invoice metadata.

No binary data is output by this operation.

Example output structure (simplified):

[
  {
    "json": {
      "id": "12345",
      "date": "2024-01-15",
      "customerName": "Acme Corp",
      "totalAmount": 1500.00,
      "status": "Paid",
      ...
    }
  },
  {
    "json": {
      "id": "12346",
      "date": "2024-01-16",
      "customerName": "Beta LLC",
      "totalAmount": 750.00,
      "status": "Pending",
      ...
    }
  }
]

Dependencies

  • Requires an OAuth2 API credential configured for authenticating with the Tiny ERP API.
  • The node makes HTTP requests to https://erp.tiny.com.br/public-api/v3.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Authentication failures if the OAuth2 credentials are not set up correctly or have expired.
    • API rate limits or request throttling by Tiny ERP.
    • Invalid parameter values, e.g., setting limit outside the allowed range (1-100).

  • Error messages:

    • "Tiny ERP API request failed: <error message>": Indicates a problem with the API call, such as network issues, invalid credentials, or malformed requests.
    • "Unknown operation: getAll": Should not occur if the node is used correctly; indicates an internal mismatch in operation handling.

  • Resolutions:

    • Verify and refresh API credentials.
    • Ensure input parameters respect allowed ranges and formats.
    • Check network connectivity and API service status.

Links and References

Discussion