custom-table-templates

Create Template

Create a Custom Table Template

post/v2/custom-table-templates

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

namestring required
entity_typestring required
columnsobject[] required
include_totalsboolean
aging_summary_position'above' | 'below' | 'hidden'

Where a custom table shows its aging summary row, if at all.

include_unapplied_paymentsboolean

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

User-facing display name for this table template.

entity_typestring required

Which data list to iterate, e.g. 'overdue_invoices', 'open_invoices'.

columnsobject[] required

Ordered array of {key, header} dicts defining the table columns.

include_totalsboolean required

Whether to append a totals row summing amount/balance columns.

aging_summary_position'above' | 'below' | 'hidden' required

Where a custom table shows its aging summary row, if at all.

include_unapplied_paymentsboolean required

Whether to include unapplied payment rows alongside invoices and credit memos.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.