ZUzuper

Update Invoice Associations

Changed on

Currently only manages the invoice's linked estimate (quote) — despite the generic name, no job/organization/property association is supported by this endpoint today.

The estimate_uid key must be present in the body: a valid estimate uid associates/replaces the link, null dissociates it. Omitting the key entirely returns 400. If the given estimate is already the one linked, this is a no-op (200, no data object). Otherwise it recomputes the invoice's payment_history/amount_paid/amount_due/invoice_status (merging in any uncollected estimate deposit) and updates both the newly- and previously-linked estimate's conversion state.

patch/invoice/{invoice_uid}/associations

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoice/{invoice_uid}/associations
  • Auth
    API key in header x-api-key

Path parameters

invoice_uidstring required

Request body

estimate_uidstring nullable required

An estimate uid to associate, or null to dissociate the current one. The key must be present even when null.

Response

200

typestring
messagestring

Example response

{
  "type": "success"
}

Changes