Skip to main content

CrewSheetSubmitItem

One sheet to submit. Identify the sheet in one of two ways:

  • By id_sheet, for a sheet that already exists. This is the id_sheet from a time, expense, or custom block in the crew sheets collection.

  • By id_user and sheet_date together, for a period the user has no sheet for yet. The sheet is created and then submitted in one step. This fails if the user is not active for the period.

sheettype is always required, because it selects which of the three sheet tables to look in.

id_sheetstring

The ID of an existing sheet to submit. When given, id_user and sheet_date are ignored.

Example: 6C5469825DAE4ABF9654B7A567141CD8
id_userstring

The user whose sheet should be created and submitted. Required when id_sheet is not given.

Example: bob
sheet_datestring

Any date inside the period to submit, in YYYYMMDD form. Required when id_sheet is not given.

Possible values: Value must match regular expression ^\d{8}$

Example: 20250309
sheettypestringrequired

Which entry type's sheet to submit. Always required.

Possible values: [time, expense, custom]

Example: time
user_namestring

Optional. Used only to label this sheet in any error message the response returns, which helps when submitting many sheets at once. You can pass the user_name straight back from the sheet block.

Example: Bob Dev
sheettype_labelstring

Optional, and used the same way as user_name: it only labels error messages. You can pass the sheettype_label straight back from the sheet block.

Example: Expense
CrewSheetSubmitItem
{
  "id_sheet": "6C5469825DAE4ABF9654B7A567141CD8",
  "id_user": "bob",
  "sheet_date": "20250309",
  "sheettype": "time",
  "user_name": "Bob Dev",
  "sheettype_label": "Expense"
}