Overview

This node manages surcharges in the KiotViet system, specifically supporting the update operation for surcharges. It allows users to update surcharge details such as the surcharge name and additional optional fields like code, description, auto-add status, required status, applicable branch IDs, and active status. This is useful for businesses that need to modify surcharge information dynamically within their KiotViet account, for example, updating the name or status of a surcharge applied to invoices.

Use Case Examples

1. Updating the name and description of an existing surcharge by its ID.
2. Changing the active status or branch applicability of a surcharge.

Properties

Output

JSON

• id - The unique identifier of the updated surcharge.
• name - The updated name of the surcharge.
• code - The updated identifier code of the surcharge.
• description - The updated description of the surcharge.
• isAutoAdd - Whether the surcharge is automatically added to invoices.
• isRequired - Whether the surcharge is mandatory.
• branchIds - The branch IDs where the surcharge applies.
• isActive - The active status of the surcharge.

Dependencies

• KiotViet API with authentication credentials

Troubleshooting

• Common issues include providing an invalid surcharge ID, which results in errors when attempting to update a non-existent surcharge.
• Errors may occur if required fields like surcharge ID or name are missing or invalid.
• Network or authentication errors with the KiotViet API can cause update failures; ensure API credentials are correctly configured.

Links

• KiotViet API Documentation - Official API documentation for KiotViet, useful for understanding surcharge management endpoints and parameters.