sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to retrieve multiple invoices based on specified filters and limits. It is useful for scenarios where users need to fetch a list of invoices from their accounting system, such as generating reports, syncing invoice data with other tools, or performing batch operations on invoices.

For example, a user might want to get all invoices for a specific contact within a date range or only retrieve open invoices up to a certain limit.

Properties

Name Meaning
Return All Whether to return all matching invoices or limit the number of results returned.
Limit Maximum number of invoices to return (only applicable if "Return All" is false).
Filters Collection of optional filters to narrow down the invoices retrieved:
- Contact ID Filter invoices by the ID of the contact they belong to.
- End Date Retrieve invoices with a date equal to or before this date.
- Invoice Number Filter invoices by their invoice number.
- Start Date Retrieve invoices with a date equal to or after this date.
- Status Filter invoices by status; options include Draft, Open / Due, and Paid.

Output

The node outputs an array of JSON objects representing invoices that match the query parameters. Each object contains invoice details as provided by the sevDesk API, such as invoice number, date, status, contact information, amounts, and other relevant fields.

If binary data were involved (e.g., PDF attachments), it would be summarized here, but this operation focuses on JSON invoice data only.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • Environment configuration validation is performed at runtime to ensure proper setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Using incorrect filter values (e.g., invalid dates or contact IDs) may result in empty responses or errors.
    • Exceeding rate limits imposed by the sevDesk API could lead to request failures.
  • Error messages:

    • Errors thrown by the API are caught and can be output as error JSON objects if "Continue On Fail" is enabled.
    • Typical error messages include authentication errors, invalid parameter errors, or network-related issues.
  • Resolution tips:

    • Verify API credentials and permissions.
    • Double-check filter values for correctness.
    • Use "Return All" cautiously to avoid large data loads.
    • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion