List gig payments

​

One expected or received payment on a gig: the retainer at signing, the balance a month out, an addendum due with the balance. A row with percent_of_total recomputes its amount from the contract (or gig) total; a fixed amount stays. The links to the band’s invoicing system ride along.

Query Parameters

  • limit
    Type: integer
    min:  
    0
    max:  
    200

    Page size, 50 by default, 200 at most.

  • offset
    Type: integer
    min:  
    0

    Records to skip.

  • sort
    Type: string

    Comma-separated fields; prefix with - for descending. Sortable: label, gig_id, gig_contract_id, percent_of_total, amount, due_at, paid_at, method, surcharge_percent, external_invoice_id, external_invoice_url, notes, created_time, last_edited_time, id. Default: due_at,created_time.

  • fields
    Type: string

    Comma-separated subset of fields to return. id is always included.

  • filter[label]

    Shorthand filter[label]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[gig_id]

    Shorthand filter[gig_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • filter[gig_contract_id]

    Shorthand filter[gig_contract_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • filter[percent_of_total]

    Shorthand filter[percent_of_total]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • filter[amount]

    Shorthand filter[amount]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • filter[due_at]

    Shorthand filter[due_at]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • filter[paid_at]

    Shorthand filter[paid_at]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • filter[method]

    Shorthand filter[method]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • filter[surcharge_percent]

    Shorthand filter[surcharge_percent]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • filter[external_invoice_id]

    Shorthand filter[external_invoice_id]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[external_invoice_url]

    Shorthand filter[external_invoice_url]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[notes]

    Shorthand filter[notes]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • filter[created_time]

    Shorthand filter[created_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • filter[last_edited_time]

    Shorthand filter[last_edited_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/gig-payments
curl 'https://api.weddingoperatingsystems.com/api/v1/gig-payments?limit=50&offset=0&sort=due_at%2Ccreated_time' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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.884Z",
      "last_edited_time": "2026-10-08T19:05:34.884Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of gig payments.

A Wedding Operating Systems, LLC product hireorpheus.com