Skip to content

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

Reconciliations

Operations

Checklist Analytics

Operations

Reconciliation Analytics

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Get Chart Of Accounts Data

Request

This API endpoint returns chart of accounts data used in FloQast.

Security
x-api-key
Query
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
filter[entityIds]string

Comma separated entity ids for which the chart of accounts should be retrieved.

Example: filter[entityIds]=648118111cc2ef0019cf0868,648118111cc2ef0019cf0867
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/chart-of-accounts?allowRedirect=true&filter%5BentityIds%5D=648118111cc2ef0019cf0868%2C648118111cc2ef0019cf0867' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects

Array of Chart Of Accounts Data

Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Upload Chart Of Accounts Data

Request

This API endpoint takes chart of accounts data and uploads it to a user’s FloQast tenant. Use this endpoint for operations such as adding, editing, and removing accounts inside of FloQast.

Security
x-api-key
Query
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
Bodyapplication/jsonrequired
dataArray of objects

Array of Chart Of Accounts Data

curl -i -X PUT \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/chart-of-accounts/upload?allowRedirect=true' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "data": [
      {
        "entityId": "5e94d5b63f557b001420bbe3",
        "accounts": [
          {
            "number": "35123",
            "name": "Cash"
          }
        ]
      }
    ]
  }'

Responses

Success

Bodyapplication/json
dataArray of objects

Array of Chart Of Accounts Data

Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Users

Operations

Folders

Operations

Controls

Operations

Programs

Operations

Processes

Operations

Guest Users

Operations