LIlight
v1 - Document Templates

List document templates

Returns the company's document templates, optionally filtered by document type

get/v1/document-templates

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

companyEntityIdstring uuid

Only return templates that apply to this company entity

sortstring

Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

Available directions: asc, desc.

Available fields: name, createdAt.

Example:amount:desc,createdAt:asc
filterstring

Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

Available fields: id, name, description, documentType, state.

Example:state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
limitinteger

Maximum number of items to return. Default is 50, maximum is 200.

offsetinteger

Number of items to skip before starting to collect the result set

Response

default response

totalinteger

Changes

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