Update a gig payment

​

Partial update: only the fields sent change.

Path Parameters

  • id
    Type: stringFormat: uuid
    required

    Gig payment id.

Body·

required
application/json

Any subset of writable fields. At least one is required. Unknown or read-only fields are rejected.

  • amount
    Type: number | null

    Minor units. Fixed when percent_of_total is empty; otherwise computed and returned, never stored.

  • due_at
    Type: string | nullFormat: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • external_invoice_id
    Type: string | null

    The invoice in the band’s books (QuickBooks, Stripe).

  • external_invoice_url
    Type: string | nullFormat: uri
  • gig_contract_id
    Type: string | nullFormat: uuid

    The contract this payment settles. With percent_of_total, the base is that contract’s total; without a contract, the gig’s. References gig_contracts.id.

  • gig_id
    Type: string | nullFormat: uuid

    References gigs.id.

  • label
    Type: string | null

    "Retainer", "Balance", "Addendum 1".

  • method
    Type: string | nullenum
    values
    bankcheckcardothernull
  • notes
    Type: string | null
  • paid_at
    Type: string | nullFormat: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • percent_of_total
    Type: number | null

    0 to 100. When set, amount is computed from it and follows the total.

  • surcharge_percent
    Type: number | null

    Added to the amount when paid this way, e.g. 3 for cards.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/gig-payments/{id}
curl https://api.weddingoperatingsystems.com/api/v1/gig-payments/123e4567-e89b-12d3-a456-426614174000 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "label": null,
  "gig_id": null,
  "gig_contract_id": null,
  "percent_of_total": null,
  "amount": null,
  "due_at": null,
  "paid_at": null,
  "method": "bank",
  "surcharge_percent": null,
  "external_invoice_id": null,
  "external_invoice_url": null,
  "notes": null
}'

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": null,
    "gig_id": null,
    "gig_contract_id": null,
    "percent_of_total": null,
    "amount": null,
    "due_at": null,
    "paid_at": null,
    "method": "bank",
    "surcharge_percent": null,
    "external_invoice_id": null,
    "external_invoice_url": null,
    "notes": null,
    "created_time": "2026-10-08T19:05:34.878Z",
    "last_edited_time": "2026-10-08T19:05:34.878Z"
  }
}

The updated gig payment.

A Wedding Operating Systems, LLC product hireorpheus.com