Teamleader icon

Teamleader

Consume Teamleader API

Actions67

Invoices → Remove payment

AI-generated

Overview

This node operation interacts with the Teamleader API to remove payments from an invoice. It marks the specified invoice as unpaid and removes all linked payments, which also triggers a re-rendering of the invoice PDF. This operation is useful in scenarios where a payment was incorrectly registered or needs to be reversed for accounting or correction purposes.

Use Case Examples

  1. A user wants to reverse a payment made on an invoice due to a refund or error.
  2. An accountant needs to update the invoice status to unpaid after a payment was mistakenly recorded.

Properties

Name Meaning
ID The ID of the invoice from which payments will be removed.

Output

JSON

  • id - The ID of the invoice affected by the payment removal.
  • status - The updated status of the invoice after payment removal.
  • message - Any message or confirmation returned by the API regarding the removal operation.

Dependencies

  • Requires an OAuth2 API credential for Teamleader to authenticate requests.

Troubleshooting

  • Common issues include providing an invalid or non-existent invoice ID, which will cause the API to return an error indicating the invoice could not be found.
  • If the OAuth2 credentials are expired or invalid, the node will fail to authenticate and return an authorization error.
  • Ensure the invoice is in a state that allows payment removal; some invoices may not allow this operation depending on their status or business rules.

Links

Discussion