Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Invoice Api → Patch Api Contractors Invoices Invoice

AI-generated

Summary

Update an existing invoice in Contractors.es by specifying its invoice ID and providing any fields to change. Fields left as 'DO_NOT_UPDATE' remain unchanged.

Inputs

  • Invoice (required) — The numeric ID of the invoice to update.
  • Project Id — Optional string to update the associated project ID.
  • Project Stage Id — Optional string to update the associated project stage ID.
  • Type — Optional invoice type ('partial', 'prepayment', 'final'). Setting to 'DO_NOT_UPDATE' leaves it unchanged.
  • Invoice No — Optional string to update the invoice number.
  • Date — Optional string date to update the invoice date.
  • Due Date — Optional string date to update the invoice due date.
  • Description — Optional string to update the invoice description.
  • Footer — Optional string to update the invoice footer.
  • Tax Rates — Optional JSON to update the tax rates applied.
  • Amount — Optional string to update the invoice amount.
  • Amount Currency — Optional string to update the currency of the amount.
  • Order Amount — Optional string to update the order amount.
  • Order Amount Currency — Optional string to update the currency for order amount.
  • Paid Amount — Optional string to update the amount paid.
  • Document Paid Amount — Optional string to update the document paid amount.
  • Document Paid Amount Currency — Optional string to update the currency of document paid amount.
  • Paid Amount Currency — Optional string to update the currency of the paid amount.
  • Paid In Full — Optional string flag indicating if the invoice is paid in full.
  • Paid In Full Date — Optional string date when invoice was paid in full.
  • Update Progress — Optional string to update progress status.
  • Job Progress — Optional string to update job progress.
  • External Id — Optional string external identifier.
  • Prepayment Ids — Optional JSON array of prepayment invoice IDs (required if type is 'final').

Output shape

a single updated invoice record as returned by the Contractors.es API

Only fields with values different from 'DO_NOT_UPDATE' in the request body are sent and potentially updated. The operation requires the invoice ID to identify which invoice to patch.

Links

Discussion