Period Close Task Definition

The period close task definition resource.

Basehttps://rest.carbon.ms/periodCloseTaskDefinition

GET/periodCloseTaskDefinition

List period close task definitions

Retrieve a paginated list of period close task definitions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/periodCloseTaskDefinition

curl --request GET \
  --url 'https://rest.carbon.ms/periodCloseTaskDefinition?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "taskType": "string",
    "sortOrder": 0,
    "required": true,
    "active": true,
    "isSystem": true
  }
]

GET/periodCloseTaskDefinition

Retrieve a period close task definition

Fetch a single period close task definition by filtering on `id`.

Query parameters

idstring

Match on the period close task definition's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/periodCloseTaskDefinition

curl --request GET \
  --url 'https://rest.carbon.ms/periodCloseTaskDefinition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "taskType": "string",
  "sortOrder": 0,
  "required": true,
  "active": true,
  "isSystem": true
}

POST/periodCloseTaskDefinition

Create a period close task definition

Create a new period close task definition.

Body parameters

namestringrequired

taskTypestringrequired

autoCheckKeystring

sortOrdernumberrequired

requiredbooleanrequired

severitystring

activebooleanrequired

isSystembooleanrequired

defaultAssigneeIdstring

References user.id

customFieldsobject

POSThttps://rest.carbon.ms/periodCloseTaskDefinition

curl --request POST \
  --url https://rest.carbon.ms/periodCloseTaskDefinition \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","taskType":"string","sortOrder":0,"required":true,"active":true,"isSystem":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "taskType": "string",
  "sortOrder": 0,
  "required": true,
  "active": true,
  "isSystem": true
}

PATCH/periodCloseTaskDefinition

Update a period close task definition

Update an existing period close task definition, matched on `id`.

Body parameters

namestringrequired

taskTypestringrequired

autoCheckKeystring

sortOrdernumberrequired

requiredbooleanrequired

severitystring

activebooleanrequired

isSystembooleanrequired

defaultAssigneeIdstring

References user.id

customFieldsobject

PATCHhttps://rest.carbon.ms/periodCloseTaskDefinition

curl --request PATCH \
  --url 'https://rest.carbon.ms/periodCloseTaskDefinition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "taskType": "string",
  "sortOrder": 0,
  "required": true,
  "active": true,
  "isSystem": true
}

DELETE/periodCloseTaskDefinition

Delete a period close task definition

Delete a period close task definition, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the period close task definition to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/periodCloseTaskDefinition

curl --request DELETE \
  --url 'https://rest.carbon.ms/periodCloseTaskDefinition?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content