GigPayment

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.

amount
Type: integer | null
read-only
required

Minor units: the fixed amount, or percent_of_total of the contract’s (or gig’s) total. Computed.
created_time
Type: stringFormat: date-time
read-only
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
due_at
Type: string | nullFormat: date
required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
external_invoice_id
Type: string | null
required

The invoice in the band’s books (QuickBooks, Stripe).
external_invoice_url
Type: string | nullFormat: uri
required
gig_contract_id
Type: string | nullFormat: uuid
required

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
required

References gigs.id.
id
Type: stringFormat: uuid
read-only
required
label
Type: string | null
required

"Retainer", "Balance", "Addendum 1".
last_edited_time
Type: stringFormat: date-time
read-only
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
method
Type: string | nullenum
required
values
bankcheckcardothernull
notes
Type: string | null
required
paid_at
Type: string | nullFormat: date
required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
percent_of_total
Type: number | null
required

0 to 100. When set, amount is computed from it and follows the total.
surcharge_percent
Type: number | null
required

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