Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Subcontractors Paid Relation Api → Patch Api Contractors Subcontractors Agreements Subcontractors Agreement Paid Paid

AI-generated

Summary

Update the payment details of a subcontractor's agreement by sending a PATCH request with specified fields to the Contractors.es API.

Inputs

  • Subcontractors Agreement (required) — The numeric ID of the subcontractor's agreement to update.
  • Paid (required) — The numeric ID representing the payment record associated with the subcontractor's agreement.
  • Agreement Id — Optionally update the agreement ID; if set to 'DO_NOT_UPDATE', this field is omitted from the request.
  • Date — Optionally update the payment date; if set to 'DO_NOT_UPDATE', this field is omitted from the request.
  • Amount — Optionally update the payment amount; if set to 'DO_NOT_UPDATE', this field is omitted from the request.
  • Amount Currency — Optionally update the currency of the payment amount; if set to 'DO_NOT_UPDATE', this field is omitted from the request.
  • Description — Optionally update the payment description; if set to 'DO_NOT_UPDATE', this field is omitted from the request.
  • Request Options — Optional settings such as batching, SSL certificate validation, proxy, and timeout configurations used for the API request.

Output shape

a single updated payment record for the specified subcontractor's agreement

The output shape corresponds to the updated payment resource returned by the PATCH API. Only fields provided (i.e., not set to 'DO_NOT_UPDATE') are modified. Errors in the API request will cause failure.

Links

Discussion