Overview

This node interacts with the KiotViet API to manage surcharges. Specifically, the 'Lấy Theo ID' (Get By ID) operation retrieves a surcharge by its unique ID. This is useful for scenarios where you need detailed information about a specific surcharge, such as viewing or processing surcharge details in an order or invoice.

Use Case Examples

1. Retrieve surcharge details by providing the surcharge ID to display or use in further workflow steps.
2. Fetch surcharge information to verify or update related data in an inventory or billing system.

Properties

Output

JSON

• id - The unique identifier of the surcharge.
• name - The name of the surcharge.
• value - The value of the surcharge, either as a fixed amount or percentage.
• isPercent - Indicates if the surcharge value is a percentage (true) or a fixed amount (false).
• code - The code identifying the surcharge.
• description - Description of the surcharge.
• isAutoAdd - Whether the surcharge is automatically added to invoices.
• isRequired - Whether the surcharge is mandatory.
• branchIds - IDs of branches where the surcharge applies.
• isActive - The active status of the surcharge.

Dependencies

• KiotViet API with API key credential

Troubleshooting

• Ensure the surcharge ID provided is valid and exists in the KiotViet system to avoid 'not found' errors.
• Check API credentials and network connectivity if the node fails to connect to the KiotViet API.
• If the node throws errors related to permissions, verify that the API key has sufficient rights to access surcharge data.

Links

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