Everest icon

Everest

Interact with Everest TMS (Transport Management System)

Actions60

Client → Update

AI-generated

Overview

This node operation updates an existing client in the Everest Transport Management System (TMS). It allows users to modify various client details such as contact information, billing details, VAT information, status, and custom fields. This operation is useful for maintaining up-to-date client records, ensuring accurate billing, and managing client-specific settings within the TMS.

Use Case Examples

  1. Updating a client's email and phone number after they change contact details.
  2. Modifying billing information such as billing name and address for invoicing purposes.
  3. Changing the client's status to inactive when they are no longer active.
  4. Adding or updating custom information fields required for client-specific missions.

Properties

Name Meaning
Client ID The unique identifier of the client to update, required to specify which client record to modify.
Additional Fields A collection of optional fields to update various client attributes such as internal codes, VAT details, billing information, fuel surcharge, photo, invoicing settings, status, and establishment association.
Update Fields A collection of fields to update basic client information such as email, first name, last name, phone number, and password.
Custom Information Requirements Custom information fields that can be added or updated for the client, with options to specify the field name and whether it is mandatory for missions.

Output

JSON

  • id - The unique identifier of the updated client.
  • first_name - The updated first name of the client.
  • last_name - The updated last name of the client.
  • email - The updated email address of the client.
  • tel - The updated phone number of the client.
  • status - The updated status of the client (active or inactive).
  • additionalFields
    • internal_code - Updated internal reference code.
    • accounting_code - Updated accounting reference code.
    • vat - Updated VAT rate.
    • vat_number - Updated VAT identification number.
    • address_line1 - Updated primary address line.
    • address_line2 - Updated secondary address line.
    • billing_name - Updated billing company name.
    • billing_email - Updated billing email address.
    • billing_address - Updated billing address.
    • billing_complementary - Updated additional billing information.
    • fuel_surcharge - Updated fuel surcharge percentage.
    • photo - Updated Base64 encoded profile photo.
    • is_periodic_invoiced - Updated flag for periodic invoicing.
    • invoice_period - Updated invoicing period.
    • invoice_period_extra - Updated additional invoicing parameter.
    • status - Updated client account status.
    • establishment_id - Updated establishment association.
  • custom_infos - Updated custom information fields for the client.

Dependencies

  • An API key credential for Everest TMS to authenticate requests.

Troubleshooting

  • Ensure the Client ID is valid and exists in the system before attempting to update.
  • Verify that required fields, especially when marked mandatory, are provided to avoid validation errors.
  • If updating the password, ensure the 'Password' and 'Confirm Password' fields match to prevent errors.
  • Check API credentials and network connectivity if requests fail due to authentication or communication issues.

Links

Discussion