Holded icon

Holded

Manage Holded contacts, documents, payments, projects, tasks, leads, and custom API requests

Actions45

Document → Update

AI-generated

Summary

Update an existing Holded commercial document by specifying its document ID, type, and any fields to modify, including contact details, dates, currency, notes, line items, and other metadata.

Inputs

  • Document ID (required) — The unique identifier of the Holded document to update.
  • Document Type (required) — The type of commercial document to update (e.g., invoice, estimate, credit note). If set to 'Custom', requires a custom type string.
  • Custom Document Type — Custom document type segment when 'Document Type' is set to 'Custom'.
  • Contact ID — Holded contact ID for the document's recipient; used to associate the document with an existing contact.
  • Contact Code — NIF, CIF, VAT, or contact code used when Contact ID is empty for contact identification.
  • Contact Name — Contact name to create or match a contact if Contact ID and Contact Code are empty.
  • Contact Email — Email address for a new or matched contact.
  • Contact Address — Billing address for a new or matched contact.
  • Contact City — Billing city for a new or matched contact.
  • Contact Postal Code — Billing postal code for a new or matched contact.
  • Contact Province — Billing province for a new or matched contact.
  • Contact Country Code — Billing country code (e.g., ES) for a new or matched contact.
  • Apply Contact Defaults — Boolean indicating whether Holded should apply contact default settings to the document.
  • Issue Date — Document issue date in YYYY-MM-DD, ISO date, Unix seconds, or milliseconds format.
  • Due Date — Document due date in YYYY-MM-DD, ISO date, Unix seconds, or milliseconds format.
  • Currency — Currency code for the document, such as EUR or USD.
  • Notes — Internal or customer-facing notes to include with the document.
  • Description — Short description or concept for the document.
  • Language — Language code for the document, e.g., 'es' or 'en'.
  • Sales Channel ID — Holded sales channel ID associated with this document.
  • Warehouse ID — Warehouse ID for relevant document types such as sales orders or waybills.
  • Tags — Comma-separated list of tags to assign to the document.
  • Shipping Address — Shipping address for this document.
  • Shipping Postal Code — Shipping postal code.
  • Shipping City — Shipping city.
  • Shipping Province — Shipping province.
  • Shipping Country — Shipping country.
  • Approve Document — Boolean to indicate if Holded should approve the document immediately, if supported.
  • Line Items — One or more line items (invoice or estimate lines) with details such as name, description, unit price, tax, discount, and quantity.
  • Fields — Additional simple body fields as name-value pairs to include in the update.
  • Advanced Body JSON — Optional JSON string with request body fields that override all other simple fields, allowing nested structures.

Output shape

a single record

Returns the updated document object as received from the Holded API. Throws an error if the Document ID is missing or invalid, or if required contact identification is missing during creation (though this is not applicable for update).

Examples

Example 1: Update an invoice document with new contact email, due date, and line items

Provide Document ID and select 'Invoice' as Document Type; specify new Contact Email, Due Date; add Line Items with descriptions and prices.

Links

Discussion