Menu

API reference · Schema

V1PeoplePayrollDrafts

V1PeoplePayrollDraftscontract v1.people.payroll-drafts
  • itemsarray of objectrequired
    • payroll_draft_idUuid7required
    • outlet_idUuid7required
    • period_monthstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • statusenum (3)required
      approvedpaid_externallyvoid
    • currencystringrequired
      pattern ^[A-Z]{3}$
    • created_atIsoDatetimerequired
    • linesarray of objectrequired
      • payroll_line_idUuid7required
      • staff_idUuid7required
      • base_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • overtime_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • tips_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • advance_recovery_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • net_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • currencystringrequired
        pattern ^[A-Z]{3}$
  • next_cursorUuid7 | nullrequired

Used by