LEDGERS icon

LEDGERS

Interact with LEDGERS API
Join our community

Actions34

Overview

The "Update Contact" operation in this node allows users to modify details of an existing contact within the LEDGERS system. This is useful for keeping contact information current, such as updating email addresses, phone numbers, tax identifiers, currency preferences, business names, and financial opening balances.

Common scenarios include:

  • Updating a customer's or supplier's contact details after changes.
  • Correcting or adding missing information like tax numbers or PAN (for India).
  • Adjusting financial opening balances for receivables or payables linked to the contact.
  • Changing the status of a contact between active and inactive.

Practical example: A business wants to update the mobile number and currency preference of a client contact after receiving new information, ensuring all future transactions use the updated data.

Properties

Name Meaning
Contact ID The unique identifier of the contact to update. This is required to specify which contact record will be modified.
Additional Fields A collection of optional fields that can be updated for the contact:
- Email The contact's email address.
- Mobile Country Code The country calling code for the contact's mobile number. Options include many countries such as UAE (+971), India (+91), USA (+1), UK (+44), Saudi Arabia (+966), and others.
- Mobile The contact's mobile phone number (without country code).
- TAX Number The tax identification number associated with the contact.
- PAN (India Only) Permanent Account Number used in India for tax purposes.
- Currency The preferred currency for the contact, selectable from a comprehensive list including AED, INR, USD, EUR, GBP, and many more.
- Business Name The name of the business associated with the contact.
- Opening Customer Receivable A fixed collection specifying the opening customer receivable amount and the corresponding financial year. Useful for setting initial outstanding amounts owed by the contact.
- Opening Supplier Payable A fixed collection specifying the opening supplier payable amount and the corresponding financial year. Useful for setting initial outstanding amounts the contact owes.
- Status The status of the contact, either "Active" or "Inactive". This controls whether the contact is currently considered active in the system.

Output

The node outputs JSON data representing the updated contact record as returned by the LEDGERS API. This typically includes the contact's updated fields reflecting the changes made during the update operation.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential and authentication token for the LEDGERS API.
  • The node performs login requests to obtain an API token before making update calls.
  • The API URL endpoint must be configured correctly in the credentials.
  • Network connectivity to the LEDGERS API service is necessary.

Troubleshooting

  • Authentication Failures: If the node throws errors related to authentication, verify that the API key, email, password, and API URL are correctly configured in the credentials.
  • Invalid Contact ID: Errors may occur if the specified Contact ID does not exist or is invalid. Ensure the Contact ID is correct.
  • Missing Required Fields: The Contact ID is mandatory; omitting it will cause the operation to fail.
  • API Rate Limits or Downtime: Temporary failures might happen due to API rate limits or service downtime. Retrying later or checking service status may help.
  • Incorrect Field Formats: For fields like mobile number or tax numbers, ensure values conform to expected formats to avoid validation errors.

Links and References

Discussion