FloQast

App · 16 actions

Read close checklists, reconciliations and entities and manage FloQast workflows.

Actions

ActionWhat it does
Create a workflowCreate a workflow.
Get a entityGet a entity.
Get a roleGet a role.
Get a userGet a user.
Get a workflowGet a workflow.
Get customized role policy groupsGet customized role policy groups.
List checklists for close analyticsList checklists for close analytics.
List customized role permissionsList customized role permissions.
List entitiesList entities.
List GL groupsList GL groups.
List reconciliations for close analyticsList reconciliations for close analytics.
List rolesList roles.
List user groupsList user groups.
List usersList users.
List workflowsList workflows.
Update a workflowUpdate a workflow.

Create a workflow

Create a workflow.

Inputs

NamenametextRequired
Display name. Non-empty after trimming, maximum 32 grapheme clusters, must match `^[\p{L}\p{N}\p{P}\p{Z}]+$`. Must be unique across all workflows for the tenant.
TypetypetextRequired
Workflow type accepted by `createWorkflow`. Excludes system-managed types (`COMPLIANCE_MANAGEMENT`, `CONSOLIDATION`, `PROJECTS`).One of: CLOSE, FP_AND_A (Fp and a), JEMOPS, OPERATIONS, PAYROLL_PROCESSING (Payroll processing), REPORTING_MANAGEMENT (Reporting management), SEC_REPORTING (Sec reporting), SOX.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "createdAt": "example",
      "entities": [
        {
          "id": {},
          "name": {}
        }
      ],
      "id": "example",
      "isActive": true,
      "name": "example",
      "totalEntityCount": 1,
      "type": "example",
      "updatedAt": "example"
    }
  }
}

Get a entity

Get a entity.

Inputs

Entityentity_idtextRequired
Entity ID (24-character hex, e.g., 64abc1230000000000000001)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "calendarType": "example",
      "createdAt": "example",
      "description": "example",
      "frequency": "example",
      "glGroupId": "example",
      "id": "example",
      "name": "example",
      "updatedAt": "example",
      "workflowId": "example",
      "yearEnd": "example"
    },
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

Get a role

Get a role.

Inputs

Rolerole_idtextRequired
Role ID (24-character hex, e.g., 507f1f77bcf86cd799439011)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "resourceAssignable": true,
      "type": "example"
    },
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

Get a user

Get a user.

Inputs

Floqast userfloqast_user_idtextRequired
User ID (24-character hex, e.g., 507f1f77bcf86cd799439011)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "createdAt": "example",
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example",
      "role": {
        "id": "example",
        "name": "example"
      },
      "status": {
        "isActive": true
      },
      "updatedAt": "example"
    },
    "metadata": {
      "pagination": {
        "endCursor": "example",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example"
      }
    }
  }
}

Get a workflow

Get a workflow.

Inputs

Close workflowclose_workflow_idtextRequired
Workflow ID (24-character hex, e.g., 64abc1234def5678901234ab)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "createdAt": "example",
      "entities": [
        {
          "id": {},
          "name": {}
        }
      ],
      "id": "example",
      "isActive": true,
      "name": "example",
      "totalEntityCount": 1,
      "type": "example",
      "updatedAt": "example"
    }
  }
}

Get customized role policy groups

Get customized role policy groups.

Inputs

Rolerole_idtextRequired
Role ID (24-character hex, e.g., 507f1f77bcf86cd799439011)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "addedPolicyGroups": [
        "example"
      ],
      "removedPolicyGroups": [
        "example"
      ]
    },
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List checklists for close analytics

List checklists for close analytics.

Inputs

Filter periodfilter_periodtext
Accounting period in YYYY-MM format (e.g. `2025-01`). Required unless a `filter[updatedAt]` bound is supplied.
Start timestart_timedate and time
Items updated at or after this point in time. Accepts an ISO 8601 date (`2025-01-01`), a datetime without offset (`2025-01-01T00:00:00`, treated as UTC), or a datetime with offset (`2025-01-01T00:00:00Z`, `2025-01-01T00:00:00+05:30`). The `+` in an offset does not need to be percent-encoded. Required (with or without `lte`) when `filter[period]` is absent.
End timeend_timedate and time
Items updated at or before this point in time. Accepts the same formats as `filter[updatedAt][gte]`.
Filter entity ID infilter_entity_id_intext
Comma-separated entity ids. Intersected server-side with the entities your API key can access. this filter narrows results, it never widens them.
Firstfirstnumber
How many items to return in one page. Defaults to 100; values above 500 or below 1 are rejected with `400`.From 1 to 500.
Afteraftertext
Opaque cursor marking where the next page starts. pass the `metadata.pagination.endCursor` of the previous response. Cursors are not durable identifiers; do not construct or store them long-term.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "description": "example",
        "entity": {
          "id": {},
          "name": {},
          "workflow": {}
        },
        "folder": {
          "id": {},
          "name": {}
        },
        "frequency": "example",
        "frequencyMonths": [
          {}
        ],
        "id": "example",
        "itemStatus": "example",
        "period": "example",
        "reviewNotes": [
          {}
        ],
        "signatures": [
          {}
        ],
        "tags": [
          {}
        ],
        "updatedAt": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "endCursor": "example",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example"
      }
    }
  }
}

List customized role permissions

List customized role permissions.

Inputs

Rolerole_idtextRequired
Role ID (24-character hex, e.g., 507f1f77bcf86cd799439011)

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "controls": [
          {}
        ],
        "description": "example",
        "name": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List entities

List entities.

Inputs

Limitlimitnumber
Number of entities to return. Maximum 100.From 1 to 100.
Offsetoffsetnumber
Number of entities to skip before returning results.At least 0.
Filter namefilter_nametext
Case-insensitive substring filter on entity name. Allowed characters: alphanumeric, spaces, hyphens, underscores, apostrophes, periods, commas, ampersands, and parentheses. Regex metacharacters are not permitted for security reasons.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "calendarType": "example",
        "createdAt": "example",
        "description": "example",
        "frequency": "example",
        "glGroupId": "example",
        "id": "example",
        "name": "example",
        "updatedAt": "example",
        "workflowId": "example",
        "yearEnd": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List GL groups

List GL groups.

Inputs

None.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "erp": "example",
        "id": "example",
        "name": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List reconciliations for close analytics

List reconciliations for close analytics.

Inputs

Filter periodfilter_periodtext
Accounting period in YYYY-MM format (e.g. `2025-01`). Required unless a `filter[updatedAt]` bound is supplied.
Start timestart_timedate and time
Items updated at or after this point in time. Accepts an ISO 8601 date (`2025-01-01`), a datetime without offset (`2025-01-01T00:00:00`, treated as UTC), or a datetime with offset (`2025-01-01T00:00:00Z`, `2025-01-01T00:00:00+05:30`). The `+` in an offset does not need to be percent-encoded. Required (with or without `lte`) when `filter[period]` is absent.
End timeend_timedate and time
Items updated at or before this point in time. Accepts the same formats as `filter[updatedAt][gte]`.
Filter entity ID infilter_entity_id_intext
Comma-separated entity ids. Intersected server-side with the entities your API key can access. this filter narrows results, it never widens them.
Firstfirstnumber
How many items to return in one page. Defaults to 100; values above 500 or below 1 are rejected with `400`.From 1 to 500.
Afteraftertext
Opaque cursor marking where the next page starts. pass the `metadata.pagination.endCursor` of the previous response. Cursors are not durable identifiers; do not construct or store them long-term.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "accounts": [
          {}
        ],
        "autoRecType": "example",
        "currency": {
          "code": {},
          "decimalDigits": {},
          "name": {},
          "symbol": {}
        },
        "difference": "example",
        "entity": {
          "id": {},
          "name": {},
          "workflow": {}
        },
        "folder": {
          "id": {},
          "name": {}
        },
        "frequency": "example",
        "frequencyMonths": [
          {}
        ],
        "gl": {
          "adjustmentBookIds": {},
          "companyCodes": {},
          "currencyType": {},
          "excludeReportingBook": {},
          "internalId": {},
          "internalPeriod": {},
          "ledger": {},
          "locations": {},
          "parentCompany": {},
          "provider": {},
          "reportingBookId": {},
          "subsidiaries": {}
        },
        "glBalance": "example",
        "id": "example",
        "itemStatus": "example",
        "journalSource": "example",
        "lastBalanceChange": "example",
        "name": "example",
        "period": "example",
        "reconcilingItems": {
          "items": {},
          "sumTotal": {}
        },
        "reviewNotes": [
          {}
        ],
        "signatures": [
          {}
        ],
        "sourceBalance": "example",
        "spreadsheetLink": "example",
        "subledgerBalance": "example",
        "tags": [
          {}
        ],
        "threshold": {
          "isDefault": {},
          "operator": {},
          "rules": {}
        },
        "type": "example",
        "updatedAt": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "endCursor": "example",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example"
      }
    }
  }
}

List roles

List roles.

Inputs

Limitlimitnumber
Maximum number of items to return per page.From 1 to 100.
Offsetoffsetnumber
Number of items to skip before starting to return results.At least 0.
Filter typefilter_typetext
Comma-separated list of role type values to include (DEFAULT, CUSTOMIZED). When omitted, all types are returned.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "id": "example",
        "name": "example",
        "resourceAssignable": true,
        "type": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List user groups

List user groups.

Inputs

Limitlimitnumber
Maximum number of items to return. Defaults to 25, maximum 100.From 1 to 100.
Offsetoffsetnumber
Number of items to skip before returning results. Defaults to 0.At least 0.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "groupOwner": "example",
        "id": "example",
        "name": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

List users

List users.

Inputs

Firstfirstnumber
Number of items to return from the beginning of the result set. Use with `after` for forward pagination.From 1 to 100.
Afteraftertext
Cursor for forward pagination. Returns items after this cursor.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "createdAt": "example",
        "email": "example",
        "firstName": "example",
        "id": "example",
        "lastName": "example",
        "role": {
          "id": {},
          "name": {}
        },
        "status": {
          "isActive": {}
        },
        "updatedAt": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "endCursor": "example",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example"
      }
    }
  }
}

List workflows

List workflows.

Inputs

Limitlimitnumber
Maximum number of items to return per page. Defaults to 25. Maximum 100.From 1 to 100.
Offsetoffsetnumber
Number of items to skip. Defaults to 0.At least 0.
Filter is activefilter_is_activetrue/false
Filter workflows by active status. Equality filter. When omitted, all workflows (active and inactive) are returned. Example: `filter[isActive]=true` returns only active workflows.
Filter typefilter_typetext
Filter workflows by exact type (shorthand for `filter[type][eq]`). Example: `filter[type]=CLOSE`.One of: CLOSE, COMPLIANCE_MANAGEMENT (Compliance management), CONSOLIDATION, FP_AND_A (Fp and a), JEMOPS, OPERATIONS, PAYROLL_PROCESSING (Payroll processing), PROJECTS, REPORTING_MANAGEMENT (Reporting management), SEC_REPORTING (Sec reporting), SOX.
Filter namefilter_nametext
Exact-match filter on workflow name (shorthand for `filter[name][eq]`). Example: `filter[name]=Q1 Close`.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": [
      {
        "createdAt": "example",
        "entities": [
          {}
        ],
        "id": "example",
        "isActive": true,
        "name": "example",
        "totalEntityCount": 1,
        "type": "example",
        "updatedAt": "example"
      }
    ],
    "metadata": {
      "pagination": {
        "hasMore": true,
        "limit": 1,
        "offset": 1,
        "totalCount": 1
      }
    }
  }
}

Update a workflow

Update a workflow.

Inputs

Close workflowclose_workflow_idtextRequired
Workflow ID (24-character hex, e.g., 64abc1234def5678901234ab)
Namenametext
New display name. Non-empty after trimming, maximum 32 grapheme clusters, must match `^[\p{L}\p{N}\p{P}\p{Z}]+$`, and must be unique for the tenant.
Is activeis_activetrue/false
New active status. Setting to `false` deactivates the workflow. Disallowed for workflow types `COMPLIANCE_MANAGEMENT`, `CONSOLIDATION`, and `PROJECTS`.

Outputs

dataobject
The response from FloQast.
Example output
{
  "data": {
    "data": {
      "createdAt": "example",
      "entities": [
        {
          "id": {},
          "name": {}
        }
      ],
      "id": "example",
      "isActive": true,
      "name": "example",
      "totalEntityCount": 1,
      "type": "example",
      "updatedAt": "example"
    }
  }
}

On this page