Lấy Danh Sách
AI-generatedOverview
This node interacts with the KiotViet API to retrieve a list of surcharges. It supports fetching either all surcharges or a limited number based on user-defined filters such as search term, active status, and branch ID. This is useful for scenarios where users need to manage or analyze surcharge data from KiotViet, such as generating reports or syncing surcharge information with other systems.
Use Case Examples
- Retrieve all surcharges without limit to get a complete dataset.
- Fetch a limited number of surcharges (e.g., 50) for performance optimization.
- Filter surcharges by active status or specific branch ID to narrow down results.
Properties
| Name | Meaning |
|---|---|
| Lấy Toàn Bộ | Determines whether to fetch all surcharge records or limit the number of results. |
| Giới Hạn | Specifies the maximum number of surcharge records to retrieve when not fetching all. |
| Bộ Lọc | Allows filtering the surcharge list by search term (name or code), active status, and branch ID. |
Output
JSON
id- Unique identifier of the surcharge.name- Name of the surcharge.value- Value of the surcharge, either as a fixed amount or percentage.isPercent- Indicates if the value is a percentage or a fixed amount.code- Code identifier for the surcharge.description- Description of the surcharge.isAutoAdd- Indicates if the surcharge is automatically added to invoices.isRequired- Indicates if the surcharge is mandatory.branchIds- Comma-separated list of branch IDs where the surcharge applies.isActive- Indicates if the surcharge is currently active.
Dependencies
- KiotViet API with an API key credential
Troubleshooting
- Common issues include API authentication failures due to invalid or missing credentials. Ensure the KiotViet API key is correctly configured.
- Errors may occur if invalid filter parameters are provided; verify that filter values such as branch ID and search terms are valid.
- If the node returns no results, check if the filters are too restrictive or if there are no surcharges matching the criteria.
- Network connectivity issues can cause request failures; ensure stable internet connection.
Links
- KiotViet API Documentation - Official API documentation for KiotViet, useful for understanding surcharge data and API usage.