Actions60
- User Actions
- Teams Actions
- Custom Fields Actions
- Tickets Actions
- Deals Actions
- Webhooks Actions
- Contacts Actions
- Companies Actions
- Bussiness Types Actions
- Tags Actions
- Deal Phases Actions
- Invoices Actions
- Subscriptions Actions
- Products Actions
- Projects Actions
- Tasks Actions
- Files Actions
Overview
The "Remove payment" operation for the "Invoices" resource in this Teamleader node allows users to mark an invoice as unpaid by removing all linked payments. This action also triggers a re-rendering of the invoice PDF to reflect the updated payment status.
This operation is useful in scenarios where a payment was mistakenly registered or needs to be reversed, such as correcting accounting errors or handling refunds. For example, if a payment was recorded but later found to be invalid, this operation can remove that payment from the invoice record and update the invoice accordingly.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the invoice from which payments should be removed. This is required to specify which invoice to operate on. |
Output
The output of this operation is a JSON object representing the updated invoice data after the payments have been removed. The exact structure depends on the API response but generally includes the invoice details with payment information cleared or updated to show no payments are linked.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the Teamleader API using OAuth2 authentication.
- The node must be configured with valid API credentials (an API key or OAuth2 token) to authenticate requests.
- Network access to
https://api.focus.teamleader.euis necessary to perform API calls.
Troubleshooting
Common issues:
- Providing an invalid or non-existent invoice ID will result in an error indicating the invoice could not be found.
- Insufficient permissions or expired/invalid API credentials may cause authentication failures.
- Network connectivity problems can prevent successful API communication.
Error messages:
"No data got returned": This indicates the API call succeeded but did not return expected data; verify the invoice ID and API endpoint.- Authentication errors typically mention unauthorized access; ensure the API credentials are correctly set up and valid.
- If the node throws an error about missing required parameters, confirm that the invoice ID is provided and correctly formatted.
Links and References
- Teamleader API Documentation
- Teamleader API endpoint base URL:
https://api.focus.teamleader.eu
This summary focuses specifically on the "Remove payment" operation under the "Invoices" resource as requested.