Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Saída → Include Saida

AI-generated

Overview

The "Include Saida" operation of the "Saída" resource in this node allows users to include a new output record related to service orders or vehicle attendances within the Nuvem Solution system. This operation is useful for tracking and registering details about vehicle dispatches, including mileage, dates, times, drivers, and reasons for the output.

Typical use cases include:

  • Logging the departure and return details of vehicles used for service orders.
  • Recording mileage data associated with vehicle usage.
  • Tracking driver assignments and reasons for vehicle dispatches.
  • Integrating vehicle output data into broader service order management workflows.

For example, a fleet manager could automate the recording of vehicle dispatches and returns, ensuring accurate mileage tracking and driver accountability without manual entry.

Properties

Name Meaning
Filial ID Numeric identifier of the branch or subsidiary where the output is registered.
Veículo Atendimento ID Numeric identifier of the vehicle assigned for the attendance or service.
Motorista ID Numeric identifier of the driver responsible for the vehicle during the output period.
Saída de OS Indicates if the output is related to a service order; options: "Indefinido", "Não", "Sim".
Saída KM Numeric value representing the vehicle's odometer reading at the time of departure.
Data de Saída Date and time when the vehicle departed (ISO 8601 format).
Hora de Saída Time of departure in "HH:MM" format (optional).
Retorno KM Numeric value representing the vehicle's odometer reading upon return.
Data de Retorno Date and time when the vehicle returned (ISO 8601 format).
Hora de Retorno Time of return in "HH:MM" format (optional).
KM Custo Numeric value indicating the cost-related mileage for the trip.
Motivo Text field for specifying the reason for the output, up to 1200 characters (optional).

Output

The node outputs a JSON object containing the response from the Nuvem Solution API after including the new output record. The structure typically includes confirmation details such as IDs, timestamps, and status messages confirming the successful inclusion of the output.

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the Nuvem Solution API.
  • Requires credentials including a software key, secret, user ID, and user key for authentication.
  • The node uses bearer token authentication obtained via these credentials.
  • Proper configuration of the API base URL and valid credentials are necessary for successful requests.

Troubleshooting

  • Authentication Errors: If authentication fails, verify that the software key, secret, user ID, and user key are correctly configured and have not expired.
  • Invalid or Missing Required Fields: Ensure all required properties (e.g., Filial ID, Veículo Atendimento ID, Motorista ID, Saída KM, etc.) are provided and valid.
  • Date and Time Format Issues: Dates should be in ISO 8601 format, and times should follow the "HH:MM" format. Incorrect formats may cause API errors.
  • API Endpoint Errors: Network issues or incorrect base URLs can cause request failures. Confirm the API endpoint is reachable and correct.
  • Permission Denied: The authenticated user must have permissions to include outputs; otherwise, the API will reject the request.

Links and References

This summary is based on static analysis of the node's source code and provided property definitions, focusing specifically on the "Include Saida" operation of the "Saída" resource.

Discussion