Checklists
/
Patch Checklist

FloQast External API (1.0.0)

Authentication

Requests to FloQast's API must be authenticated using an API key. The API key must be included in the x-api-key header of each request and can be generated in the FloQast application. The key should also have the correct permissions to access the API endpoints you are using. Directions to generate an API key

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.floqast.app/_mock/content/api-reference/openapi/
https://fq-api.floqast.app/
https://fq-api.eu.floqast.app/
https://fq-api.au.floqast.app/

Checklists

Operations

Create a new checklist item

Request

Bodyapplication/jsonrequired

Checklist item to create

companyIdstring^[0-9a-fA-F]{24}$required
folderNamestringrequired
scheduleobjectrequired
schedule.​periodobjectrequired
schedule.​period.​fiscalYearstring^[0-9]{4}$required
schedule.​period.​quarterstring^\d+$required
schedule.​period.​monthstringrequired

any valid month as a string i.e. "january". Ensure the period is valid.

schedule.​period.​yearstring^[0-9]{4}$required
schedule.​typestringrequired
Enum"NON_RECURRING""MONTHLY""QUARTERLY""ANNUALLY""CUSTOM""WEEKLY""BI_WEEKLY"
schedule.​frequencyPeriodsArray of strings
signaturesArray of objects
descriptionstringrequired
tagIdsArray of strings
controlsArray of strings
curl -i -X POST \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/checklists \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "companyId": "string",
    "folderName": "string",
    "schedule": {
      "period": {
        "fiscalYear": "string",
        "quarter": "string",
        "month": "string",
        "year": "string"
      },
      "type": "NON_RECURRING",
      "frequencyPeriods": [
        "string"
      ]
    },
    "signatures": [
      {
        "group": "unassigned",
        "dueDateSetting": {
          "type": "OFFSET",
          "value": 0
        },
        "dueDate": "2019-08-24T14:15:22Z",
        "assignedTo": "string",
        "estimatedTime": "2019-08-24T14:15:22Z"
      }
    ],
    "description": "string",
    "tagIds": [
      "string"
    ],
    "controls": [
      "string"
    ]
  }'

Responses

Checklist item created successfully

Bodyapplication/jsonArray [
tlcIdstring
Example: "65a6d7a9c1cc45001878718e"
folderobject
companyobject
periodobject
templateIdstring
Example: "67531818facc7d39cbac1ea6"
descriptionstring
Example: "weekly description"
frequencyinteger
Example: 1
frequencyMonthsArray of strings
reviewnotesArray of strings
signaturesArray of objects
sortOrdernumber
Example: 1.7976931348623157e+308
prioritynumber
Example: 1.7976931348623157e+308
followersArray of strings
controlsArray of strings
createdBystring
Example: "65a6d7ee800ba600199caa9f"
lockStatusobject
_idstring
Example: "675318186e1d55556aa8ab6c"
docsArray of strings
tagsArray of strings
createdAtstring(date-time)
Example: "2024-12-06T15:28:25.518Z"
updatedAtstring(date-time)
Example: "2024-12-06T15:28:25.518Z"
__vinteger
Example: 0
assigneesArray of strings
pastDueboolean
Example: false
completeboolean
Example: false
readyForReviewboolean
Example: false
updatedstring(date-time)
Example: "2024-12-06T15:28:25.518Z"
idstring
Example: "675318186e1d55556aa8ab6c"
]
Response
application/json
[
  {
    "tlcId": "65a6d7a9c1cc45001878718e",
    "folder": { … },
    "company": { … },
    "period": { … },
    "templateId": "67531818facc7d39cbac1ea6",
    "description": "weekly description",
    "frequency": 1,
    "frequencyMonths": [ … ],
    "reviewnotes": [ … ],
    "signatures": [ … ],
    "sortOrder": 1.7976931348623157e+308,
    "priority": 1.7976931348623157e+308,
    "followers": [ … ],
    "controls": [ … ],
    "createdBy": "65a6d7ee800ba600199caa9f",
    "lockStatus": { … },
    "_id": "675318186e1d55556aa8ab6c",
    "docs": [ … ],
    "tags": [ … ],
    "createdAt": "2024-12-06T15:28:25.518Z",
    "updatedAt": "2024-12-06T15:28:25.518Z",
    "__v": 0,
    "assignees": [ … ],
    "pastDue": false,
    "complete": false,
    "readyForReview": false,
    "updated": "2024-12-06T15:28:25.518Z",
    "id": "675318186e1d55556aa8ab6c"
  }
]

Get Checklists

Request

This API endpoint enables fetching a collection of checklists performed during a specific month and year. By providing the desired month and year as parameters, the API response narrows down the results to the exact period, facilitating the analysis of financial data and tracking the progress of checklist efforts.

Query
filter[month]stringrequired

Specifies the month for which the checklists should be retrieved. Valid values are the names of the months. Must be used in conjunction with filter[year].

Example: filter[month]=march
filter[year]integerrequired

Specifies the year for which the checklists should be retrieved. It should be a four-digit numerical value. Must be used in conjunction with filter[month].

Example: filter[year]=2023
filter[templateId]string

templateId for which the checklists should be retrieved.

Example: filter[templateId]=5e94d5b63f557b001420bbb1
filter[description]string

Specifies a description for which checklists should be retrieved.

Example: filter[description]=Generate balance sheet
filter[entityId]string

Specifies the entity for which the checklists should be retrieved

Example: filter[entityId]=656abc949ec04a00096b56d7
page[size]integer

The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.

Example: page[size]=12000
page[cursor]string

Pagination cursor that indicates the starting position for the next set of items

Example: page[cursor]=5e94d5b63f557b001420bbe3
allowRedirectboolean

If set to true, the API will return a 303 redirect response if the response payload is too large. The header Location and body.data.url will also include the URL to the actual resource.

Example: allowRedirect=true
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/checklists?allowRedirect=true&filter%5Bdescription%5D=Generate%20balance%20sheet&filter%5BentityId%5D=656abc949ec04a00096b56d7&filter%5Bmonth%5D=march&filter%5BtemplateId%5D=5e94d5b63f557b001420bbb1&filter%5Byear%5D=2023&page%5Bcursor%5D=5e94d5b63f557b001420bbe3&page%5Bsize%5D=12000' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(ChecklistModel)

Array of Checklists

linksobject
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "/api/v1/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    "next": "/api/v1/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe6"
  }
}

Patch Checklist

Request

This API endpoint updates a checklist.

Path
checklistIdstringrequired

The ID of the checklist item

Bodyapplication/jsonrequired
forwardboolean

If provided, only signoff on this signature

Example: true
groupstring

If provided, only signoff on signatures in this group

Enum"preparer""reviewer""unassigned"
Example: "preparer"
dataobject
curl -i -X POST \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/checklists/{checklistId}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "forward": true,
    "group": "preparer",
    "data": {
      "companyId": "5e94d5b63f557b001420bbe3",
      "folderName": "Accounts Payable",
      "description": "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense.",
      "entityId": "656abc949ec04a00096b56d7",
      "schedule": {
        "period": {
          "month": "december",
          "year": "2025",
          "fiscalYear": "2025",
          "quarter": "3"
        },
        "type": "NON_RECURRING",
        "frequencyPeriods": [
          "string"
        ]
      },
      "signatures": [
        {
          "id": "5e94d5b63f557b001420bbe5",
          "group": "preparer",
          "signedDate": "2021-01-01T00:00:00.000Z",
          "signedBy": "5e94d5b63f557b001420bba5",
          "assignedTo": "5e94d5b63f557b001420bba5",
          "dueDate": "2021-01-01T00:00:00.000Z",
          "dueDateSetting": {},
          "value": 2,
          "metaData": {
            "token": "5e94d5b63f557b001420bbe6"
          }
        }
      ],
      "tagIds": [
        "5e94d5b63f557b001420bbe6"
      ]
    }
  }'

Responses

Success

Bodyapplication/json
idstring

Id of checklist

Example: "5e94d5b63f557b001420bbe3"
templateIdstring

Template Id of checklist

Example: "5e94d5b63f557b001420bbe4"
descriptionstring
Example: "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense."
entityIdstring
Example: "656abc949ec04a00096b56d7"
periodobject
signaturesArray of objects
tagsArray of objects
Response
application/json
{
  "id": "5e94d5b63f557b001420bbe3",
  "templateId": "5e94d5b63f557b001420bbe4",
  "description": "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense.",
  "entityId": "656abc949ec04a00096b56d7",
  "period": {
    "month": "december",
    "year": "2023"
  },
  "signatures": [
    { … }
  ],
  "tags": [
    { … }
  ]
}

Post Checklist Signatures

Request

This API endpoint updates the signature status of a checklist.

Path
checklistIdstringrequired

The ID of the checklist item

Bodyapplication/jsonrequired
signatureIdstring

If provided, only signoff on this signature

Example: "5e94d5b63f557b001420bbe5"
userIdstring

If provided, only signoff on signatures assigned to this user

Example: "5e94d5b63f557b001420bbe6"
groupstring

If provided, only signoff on signatures in this group

Enum"preparer""reviewer""unassigned"
Example: "preparer"
setSignedOffboolean

The status of the signature. Defaults to true

Example: true
curl -i -X POST \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/checklists/{checklistId}/sign' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "signatureId": "5e94d5b63f557b001420bbe5",
    "userId": "5e94d5b63f557b001420bbe6",
    "group": "preparer",
    "setSignedOff": true
  }'

Responses

Success

Bodyapplication/json
idstring

Id of checklist

Example: "5e94d5b63f557b001420bbe3"
templateIdstring

Template Id of checklist

Example: "5e94d5b63f557b001420bbe4"
descriptionstring
Example: "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense."
entityIdstring
Example: "656abc949ec04a00096b56d7"
periodobject
signaturesArray of objects
tagsArray of objects
Response
application/json
{
  "id": "5e94d5b63f557b001420bbe3",
  "templateId": "5e94d5b63f557b001420bbe4",
  "description": "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense.",
  "entityId": "656abc949ec04a00096b56d7",
  "period": {
    "month": "december",
    "year": "2023"
  },
  "signatures": [
    { … }
  ],
  "tags": [
    { … }
  ]
}

Reconciliations

Operations

Checklist Analytics

Operations

Reconciliation Analytics

Operations

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations