API docs by Redocly

FloQast External API (1.0.0)

Download OpenAPI specification:Download

As a pioneering force within the industry, FloQast consistently strives to discover innovative avenues through which our customers can engage with our cutting-edge application. We empower you to extract comprehensive analytics from FloQast while seamlessly integrating reconciliation balances by introducing these latest endpoints. We are pleased to offer these new services and look forward to their transformative effect on your close process as they are poised to unlock unprecedented time savings for you and your organization.

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

Checklist Analytics

Checklist Analytics operations.

Get Checklist Analytics

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." And also include information about TLCs.

Authorizations:
x-api-key
query Parameters
filter[month]
string
Example: filter[month]=march

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]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[year]
integer
Example: filter[year]=2023

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]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[modifiedBefore]
string <date>
Example: filter[modifiedBefore]=2021-01-01

Sets the cutoff date for retrieving checklists, including only those modified before (but not including) the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedBefore] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[modifiedSince]
string <date>
Example: filter[modifiedSince]=2020-12-31

Sets the cutoff date for retrieving checklists, including only those modified on or after the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedSince] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[entityIds]
string
Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated entity ids for which the checklists should be retrieved.

filter[workflowIds]
string
Example: filter[workflowIds]=5e94d5b63f557b001420baa1,5e94d5b63f557b001420baa2

Comma separated workflow ids for which the checklists should be retrieved

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (ChecklistAnalyticsModel)

Array of Checklists

Array
_id
string

Id of checklist

object
_id
string

Id of entity

name
string

Name of entity

object

Workflow of entity

details
string

User-provided details

object
_id
string

Id of folder

name
string

Name of folder

description
string

Description of checklist item

itemStatus
string
Enum: "On Track" "Ready for Review" "Late (Preparer)" "Late (Reviewer)" "Complete (On Time)" "Complete (Prepared Late)" "Complete (Reviewed Late)" "Complete (Prepared & Reviewed Late)" "Out of Balance"
frequency
any
Enum: "Monthly" "Quarterly" "Annually" "Weekly" "Bi-Weekly" "Non-Recurring" "Custom"
frequencyMonths
Array of strings
Array of objects
Array
object (User)
object (User)
signedDate
string <date-time>

Date when checklist was signed

dueDate
string <date-time>

Date when checklist is due

estimatedTimeMinutes
integer

Estimated completion time (minutes)

group
string
Enum: "preparer" "reviewer" "unassigned"
Array of objects
Array
object (User)
object (User)
message
string

Message of note

created
string <date-time>

Date when comment was created

Array of objects
Array of objects
Array
name
string

Name of tag

updatedAt
string <date-time>

Date when checklist was last updated

object
month
string

Month of period

year
string

Year of period

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

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

Reconciliation Analytics

Reconciliation Analytics operations.

Get Reconciliation Analytics

This API endpoint enables fetching a collection of reconciliations 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 reconciliation efforts." And also include information about TLCs.

Authorizations:
x-api-key
query Parameters
filter[month]
string
Example: filter[month]=march

Specifies the month for which the reconciliations should be retrieved. Valid values are the names of the months. Must be used in conjunction with filter[year]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[year]
integer
Example: filter[year]=2023

Specifies the year for which the reconciliations should be retrieved. It should be a four-digit numerical value. Must be used in conjunction with filter[month]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[modifiedBefore]
string <date>
Example: filter[modifiedBefore]=2021-01-01

Sets the cutoff date for retrieving reconciliations, including only those modified before (but not including) the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedBefore] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[modifiedSince]
string <date>
Example: filter[modifiedSince]=2020-12-31

Sets the cutoff date for retrieving reconciliations, including only those modified on or after the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedSince] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[entityIds]
string
Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated entity ids for which the reconciliations should be retrieved.

filter[journalSource]
string
Example: filter[journalSource]=SUB_LEDGER

journalSource for which the reconciliations should be retrieved.

filter[internalIds]
string
Example: filter[internalIds]=123456, 78910

Comma seperated gl internalIds for which the reconciliations should be retrieved.

filter[workflowIds]
string
Example: filter[workflowIds]=5e94d5b63f557b001420baa1,5e94d5b63f557b001420baa2

Comma separated workflow ids for which the reconciliations should be retrieved.

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (Reconciliation_AnalyticsModel)

Array of Reconciliation Analytics

Array
_id
string

Id of reconciliation

object
_id
string

Id of entity

name
string

Name of entity

object

Workflow of entity

details
string

User-provided details

object
_id
string

Id of folder

name
string

Name of folder

object
link
string

Link to supporting document

object
Array of objects

Rules for threshold

operator
string

Operator for threshold

isDefault
boolean

Indicates if threshold is default

frequency
any
Enum: "Monthly" "Quarterly" "Annually" "Non-Recurring" "Custom"
frequencyMonths
Array of strings
type
any
Enum: "SINGLE" "GROUPED"
name
string

Name of reconciliation

sourceBalance
string

Trial balance or reconciled balance

glBalance
string

Balance per general ledger provider

object
internalId
string

Internal id of general ledger

internalPeriod
string

Internal period of general ledger

provider
any
Enum: "TB" "NETSUITE" "INTACCT" "QBO" "MSDYNAMICS" "SAP" "XERO"

Provider of general ledger

object

Populated if provider is TB

object

Populated if provider is NETSUITE

object

Populated if provider is INTACCT

object

Populated if provider is QBO

object

Populated if provider is MSDYNAMICS

object

Populated if provider is SAP

object

Populated if provider is XERO

object
balance
string
journalSource
string
Enum: "GENERAL_LEDGER" "SUB_LEDGER"

Indicates whether the reconciliation uses general ledger or subledger balance to reconcile

object (ReconcilingItems)
sumTotal
integer
Array of objects
difference
string

gl balance - source balance - reconciling items

object
code
string

Currency code

symbol
string

Currency symbol

name
string

Currency name

decimalDigits
integer

Number of decimal digits

updatedAt
string <date-time>

Date when reconciliation was last updated

object
month
string

Month of period

year
string

Year of period

itemStatus
string
Enum: "On Track" "Ready for Review" "Late (Preparer)" "Late (Reviewer)" "Complete (On Time)" "Complete (Prepared Late)" "Complete (Reviewed Late)" "Complete (Prepared & Reviewed Late)" "Out of Balance" "Redo"
lastBalanceChange
string <date-time>

Date when reconciliation balance was last changed

Array of objects
Array
name
string

Name of tag

Array of objects
Array
object (User)
object (User)
signedDate
string <date-time>

Date when reconciliation was signed

dueDate
string <date-time>

Date when reconciliation is due

estimatedTimeMinutes
integer

Estimated completion time (minutes)

group
string
Enum: "preparer" "reviewer" "unassigned"
Array of objects

Accounts is only used if the type is GROUPED. Otherwise, it is an empty array

Array
name
string

Name of reconciliation

sourceBalance
string

Trial balance or reconciled balance

glBalance
string

Balance per general ledger provider

object (ReconcilingItems)
difference
string

gl balance - source balance - reconciling items

Array of objects
Array
object (User)
object (User)
message
string

Message of note

created
string <date-time>

Date when comment was created

Array of objects
object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/analytics/reconciliations?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/analytics/reconciliations?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Audit Trail

Audit trail operations.

Get Audit Trail logs

This API endpoint retrieves audit logs for all API keys within a top-level client, providing a comprehensive overview of usage. It supports querying logs for a specific user's API key ID to facilitate focused analysis.

Authorizations:
x-api-key
query Parameters
filter[startDate]
string
Example: filter[startDate]=2023-11-01

Specifies the start date (inclusive) for logs to be retrieved. The date must be in the ISO 8601 format like YYYY-MM-DD.

filter[endDate]
string
Example: filter[endDate]=2023-12-01

Specifies the end date (inclusive) for logs to be retrieved. The date must be in the ISO 8601 format like YYYY-MM-DD.

filter[userApiKey._id]
string
Example: filter[userApiKey._id]=5e94d5b63f557b001420bbe3

Specifies the user API key ID to filter logs by.

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (AuditTrailModel)

Array of Audit Trail items

Array
_id
string

Id of Audit Trail

uri
string

URI of request

method
string

Http method of request

sourceIp
string

Client Ip address of request

object

query parameters and status associated with the audit log

status
string

Status of request

service
string

Service of request

queryParameters
object

Query parameters of request

error
string

Error message of request

object
_id
string

Id of token

name
string

Name of token

createdAt
string <date-time>

Date when audit log was created

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/audit-trail?filter[startDate]=2023-11-01&filter[endDate]=2023-12-01&page[size]=12000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/audit-trail?filter[startDate]=2023-11-01&filter[endDate]=2023-12-01&page[size]=12000&page[cursor]=5e94d5b63f557b001420bbe6"
    }
}

Amortizations

Amortization operations.

Get Amortizations

This API endpoint retrieves amortization entries for a designated month and year, providing a concise overview of amortization activities within the specified period. It facilitates access to detailed records of amortization transactions, which include the systematic allocation of costs for intangible assets over their useful life, enabling thorough analysis and financial tracking.

Authorizations:
x-api-key
query Parameters
filter[month]
required
string
Example: filter[month]=march

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

filter[year]
required
integer
Example: filter[year]=2023

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

filter[entityIds]
string
Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated entity ids for which the amortizations should be retrieved.

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (AmortizationModel)

Array of Amortization Items

Array
id
string

Id of Amortization

entityId
string

Id of company

reconciliationId
string

Id of reconciliation

object

Period of Amortization

month
string

Month of Amortization

year
number

Year of Amortization

object

account

name
string

Name of account

number
string

Number of account

object

Expense account

name
string

Name of expense account

number
string

Number of expense account

vendor
string

Name of vendor

description
string

Description of amortization

invoiceNumber
string

Invoice number

department
string

Department

object

Current expense

amount
number

Amount of current expense

object

Custom Fields

CustomKey1
string

1st custom field. Key is whatever the user has set in the custom field settings

CustomKey2
string

2nd custom field. Key is whatever the user has set in the custom field settings

object

Journal Entry

id
string

Id of journal entry

status
string

Status of journal entry

timestamp
string

Timestamp of journal entry status change

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/amortization/items?filter[month]=january&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/amortization/items?filter[month]=january&filter[year]=2023&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Update Amortization Reconciliations

This API endpoint takes a reconciliationId and journal entry status information, and updates amortization reconciliation entries.

Authorizations:
x-api-key
path Parameters
reconciliationId
required
string
Example: 5e94d5b63f557b001420bbe3

Id of reconciliation

query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Request Body schema: application/json
object
journalEntryStatus
required
string

Status of journal entry

journalEntryId
string

Id of journal entry

journalEntryTimestamp
string <date-time>

Timestamp of journal entry status change

Responses

Response Schema: application/json
success
boolean

Request samples

Content type
application/json
{
  • "data": {
    • "journalEntryStatus": "POSTED",
    • "journalEntryId": "615bcdc00000000000000302",
    • "journalEntryTimestamp": "2024-03-29T21:36:43.309+00:00"
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

Get Amortizing Reconciliations

This API endpoint can take reconciliationIds and journal entry status, and gets amortization reconciliations entries.

Authorizations:
x-api-key
query Parameters
filter[reconciliationIds]
string
Example: filter[reconciliationIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated reconciliation ids for which the reconciliations should be retrieved

filter[journalEntryStatus]
string
Example: filter[journalEntryStatus]=PROCESSING

Status of journal entry for which the reconciliations should be retrieved

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (AmortizingReconciliationModel)

Array of Reconciliation Items

Array
id
string

The unique identifier for the reconciliation.

entityId
string

The unique identifier for the entity.

journalEntryId
string

The unique identifier for the journal entry.

journalEntryStatus
string
Enum: "NOT_POSTED" "PROCESSING" "POSTED" "FAILED"

The status of the journal entry.

journalEntryTimestamp
string <date-time>

The timestamp of the journal entry.

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/amortization/reconciliations?filter[reconciliationIds]=615bcdc00000000000020000,615bcdc00000000000020001&filter[journalEntryStatus]=PROCESSING&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/amortization/reconciliations?filter[reconciliationIds]=615bcdc00000000000020000,615bcdc00000000000020001&filter[journalEntryStatus]=PROCESSING&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Depreciations

Depreciation operations.

Get Depreciations

This API endpoint retrieves depreciation entries for a designated month and year, providing a concise overview of depreciation activities within the specified period. It enables access to detailed records associated with the depreciation of tangible assets, facilitating thorough financial tracking and analysis.

Authorizations:
x-api-key
query Parameters
filter[month]
required
string
Example: filter[month]=march

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

filter[year]
required
integer
Example: filter[year]=2023

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

filter[entityIds]
string
Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated entity ids for which the depreciations should be retrieved.

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (DepreciationModel)

Array of Depreciation Items

Array
id
string

Id of depreciation

entityId
string

Id of company

reconciliationId
string

Id of reconciliation

object

Period of depreciation

month
string

Month of depreciation

year
number

Year of depreciation

object

Asset account

name
string

Name of asset account

number
string

Number of asset account

vendor
string

Name of vendor

description
string

Description of depreciation

invoiceNumber
string

Invoice number

department
string

Department

assetId
string

Id of asset

object

Accumulated depreciation account

name
string

Name of accumulated depreciation account

number
string

Number of accumulated depreciation account

object

Expense account

name
string

Name of expense account

number
string

Number of expense account

object

Custom Fields

CustomKey1
string

1st custom field. Key is whatever the user has set in the custom field settings

CustomKey2
string

2nd custom field. Key is whatever the user has set in the custom field settings

object

Journal Entry

id
string

Id of journal entry

status
string

Status of journal entry

timestamp
string

Timestamp of journal entry status change

object

Current expense

amount
number

Amount of current expense

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/depreciation/items?filter[month]=january&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/depreciation/items?filter[month]=january&filter[year]=2023&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Update Depreciation Reconciliations

This API endpoint takes a reconciliationId and journal entry status information, and updates depreciation reconciliations entries.

Authorizations:
x-api-key
path Parameters
reconciliationId
required
string
Example: 5e94d5b63f557b001420bbe3

Id of reconciliation

query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Request Body schema: application/json
object
journalEntryStatus
required
string

Status of journal entry

journalEntryId
string

Id of journal entry

journalEntryTimestamp
string <date-time>

Timestamp of journal entry status change

Responses

Response Schema: application/json
success
boolean

Request samples

Content type
application/json
{
  • "data": {
    • "journalEntryStatus": "POSTED",
    • "journalEntryId": "615bcdc00000000000000302",
    • "journalEntryTimestamp": "2024-03-29T21:36:43.309+00:00"
    }
}

Response samples

Content type
application/json
{
  • "success": true
}

Get Depreciation Reconciliations

This API endpoint can take reconciliationIds and journal entry status, and gets depreciation reconciliations entries.

Authorizations:
x-api-key
query Parameters
filter[reconciliationIds]
string
Example: filter[reconciliationIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated reconciliation ids for which the reconciliations should be retrieved

filter[journalEntryStatus]
string
Example: filter[journalEntryStatus]=PROCESSING

Status of journal entry for which the reconciliations should be retrieved

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (DepreciatingReconciliationModel)

Array of Reconciliation Items

Array
id
string

The unique identifier for the reconciliation.

entityId
string

The unique identifier for the entity.

journalEntryId
string

The unique identifier for the journal entry.

journalEntryStatus
string
Enum: "NOT_POSTED" "PROCESSING" "POSTED" "FAILED"

The status of the journal entry.

journalEntryTimestamp
string <date-time>

The timestamp of the journal entry.

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/depreciation/reconciliations?filter[reconciliationIds]=615bcdc00000000000020000,615bcdc00000000000020001&filter[journalEntryStatus]=PROCESSING&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/depreciation/reconciliations?filter[reconciliationIds]=615bcdc00000000000020000,615bcdc00000000000020001&filter[journalEntryStatus]=PROCESSING&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Chart Of Accounts

Chart Of Accounts operations.

Get Chart Of Accounts Data

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

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

filter[entityIds]
string
Example: filter[entityIds]=648118111cc2ef0019cf0868,648118111cc2ef0019cf0867

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

Responses

Response Schema: application/json
Array of objects

Array of Chart Of Accounts Data

Array
entityId
string

Id of entity

Array of objects

Accounts data

Array
number
string
name
string
error
string

Error message, populated when the data could not be retrieved

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Upload Chart Of Accounts Data

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.

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Request Body schema: application/json
Array of objects

Array of Chart Of Accounts Data

Array
entityId
required
string

Id of entity

required
Array of objects (Account)

Accounts data

Array
number
required
string

Id of account

name
required
string

Name of account

Responses

Response Schema: application/json
Array of objects

Array of Chart Of Accounts Data

Array
entityId
string

Id of entity

Array of objects

Accounts data

Array
number
string
name
string
success
boolean
error
string

Error message, populated if success field is false

Request samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Entities

Operations related to entities

Get Entities

This API endpoint enables fetching a collection of entities within a given FloQast tenant. Optional query parameters can either narrow the API response or provide pagination functionality.

Authorizations:
x-api-key
query Parameters
filter[name]
string
Example: filter[name]=Entity Name

Specifies the name of the entity. Cannot be used with page[number].

page[size]
integer
Example: page[size]=12000

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

page[number]
integer
Example: page[number]=5

Indicates the page number of the results to retrieve. This parameter is used to paginate through lists of items. Cannot be used with filter[name].

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (Entity)
Array
id
string
name
string
details
string

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Get Entity by ID

This API endpoint enables fetching a single specific entity with its unique identifier.

Authorizations:
x-api-key
path Parameters
id
required
string

The ID of the entity

query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (Entity)
Array
id
string
name
string
details
string

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Checklists

Checklists operations.

Get Checklists

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.

Authorizations:
x-api-key
query Parameters
filter[month]
required
string
Example: filter[month]=march

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].

filter[year]
required
integer
Example: filter[year]=2023

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].

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

templateId for which the checklists should be retrieved.

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

Specifies a description for which checklists should be retrieved.

filter[entityId]
string
Example: filter[entityId]=656abc949ec04a00096b56d7

Specifies the entity for which the checklists should be retrieved

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (ChecklistModel)

Array of Checklists

Array
id
string

Id of checklist

templateId
string

Template Id of checklist

description
string
entityId
string
object
month
string

Month of period

year
string

Year of period

Array of objects
Array
id
string

Id of signature

group
string
Enum: "preparer" "reviewer" "unassigned"
signedDate
string <date-time>

Date when checklist was signed

signedBy
string

Signed by user ID

assignedTo
string

Assigned user ID

dueDate
string <date-time>

Date when checklist is due

object
Array of objects
Array
name
string

Name of tag

object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
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"
    }
}

Post Checklist Signatures

This API endpoint updates the signature status of a checklist.

Authorizations:
x-api-key
path Parameters
checklistId
required
string

The ID of the checklist item

Request Body schema: application/json
signatureId
string

If provided, only signoff on this signature

userId
string

If provided, only signoff on signatures assigned to this user

group
string
Enum: "preparer" "reviewer" "unassigned"

If provided, only signoff on signatures in this group

setSignedOff
boolean

The status of the signature. Defaults to true

Responses

Response Schema: application/json
id
string

Id of checklist

templateId
string

Template Id of checklist

description
string
entityId
string
object
month
string

Month of period

year
string

Year of period

Array of objects
Array
id
string

Id of signature

group
string
Enum: "preparer" "reviewer" "unassigned"
signedDate
string <date-time>

Date when checklist was signed

signedBy
string

Signed by user ID

assignedTo
string

Assigned user ID

dueDate
string <date-time>

Date when checklist is due

object
token
string

API token id if this signature was signed off via API

Array of objects
Array
name
string

Name of tag

Request samples

Content type
application/json
{
  • "signatureId": "5e94d5b63f557b001420bbe5",
  • "userId": "5e94d5b63f557b001420bbe6",
  • "group": "preparer",
  • "setSignedOff": true
}

Response samples

Content type
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

Reconciliation operations.

Get Reconciliations

This API endpoint enables fetching a collection of reconciliations 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 reconciliation efforts." And also include information about TLCs.

Authorizations:
x-api-key
query Parameters
filter[month]
string
Example: filter[month]=march

Specifies the month for which the reconciliations should be retrieved. Valid values are the names of the months. Must be used in conjunction with filter[year]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[year]
integer
Example: filter[year]=2023

Specifies the year for which the reconciliations should be retrieved. It should be a four-digit numerical value. Must be used in conjunction with filter[month]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

filter[modifiedBefore]
string <date>
Example: filter[modifiedBefore]=2021-01-01

Sets the cutoff date for retrieving reconciliations, including only those modified before (but not including) the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedBefore] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[modifiedSince]
string <date>
Example: filter[modifiedSince]=2020-12-31

Sets the cutoff date for retrieving reconciliations, including only those modified on or after the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedSince] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

filter[entityIds]
string
Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2

Comma separated entity ids for which the reconciliations should be retrieved.

filter[workflowIds]
string
Example: filter[workflowIds]=5e94d5b63f557b001420baa1,5e94d5b63f557b001420baa2

Comma separated workflow ids for which the reconciliations should be retrieved.

filter[journalSource]
string
Example: filter[journalSource]=SUB_LEDGER

journalSource for which the reconciliations should be retrieved.

filter[internalIds]
string
Example: filter[internalIds]=123456, 78910

Comma seperated gl internalIds for which the reconciliations should be retrieved.

page[size]
integer
Example: page[size]=12000

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (ReconciliationModel)

Array of Reconciliations

Array
_id
string

Id of reconciliation

object
_id
string

Id of entity

name
string

Name of entity

object

Workflow of entity

type
any
Enum: "SINGLE" "GROUPED"
name
string

Name of reconciliation

updatedAt
any

Date when reconciliation was last updated

glBalance
string

Balance per general ledger provider

object
internalId
string

Internal id of general ledger

internalPeriod
string

Internal period of general ledger

provider
any
Enum: "TB" "NETSUITE" "INTACCT" "QBO" "MSDYNAMICS" "SAP" "XERO"

Provider of general ledger

object

Populated if provider is TB

object

Populated if provider is NETSUITE

object

Populated if provider is INTACCT

object

Populated if provider is QBO

object

Populated if provider is MSDYNAMICS

object

Populated if provider is SAP

object

Populated if provider is XERO

object
code
string

Currency code

symbol
string

Currency symbol

name
string

Currency name

decimalDigits
integer

Number of decimal digits

Array of objects

Accounts is only used if the type is GROUPED. Otherwise, it is an empty array

Array
name
string

Name of reconciliation

glBalance
string

Balance per general ledger provider

object
month
string

Month of period

year
string

Year of period

journalSource
string
Enum: "GENERAL_LEDGER" "SUB_LEDGER"

Indicates whether the reconciliation uses general ledger or subledger balance to reconcile

templateId
string

Template Id of reconciliation

Array of objects
Array
name
string

Name of tag

Array of objects
Array
object (User)
object (User)
signedDate
string <date-time>

Date when reconciliation was signed

dueDate
string <date-time>

Date when reconciliation is due

estimatedTimeMinutes
integer

Estimated completion time (minutes)

group
string
Enum: "preparer" "reviewer" "unassigned"
object
self
string

Link to self

next
string

Pagination link pointing to the next page

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/reconciliations?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/reconciliations?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Info

Current user and token operations.

Current user and token information

Get information about the current user and token

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
object
apiKeyId
string

id of the API token

userId
string

ID of the user

Response samples

Content type
application/json
{
  • "data": {
    • "apiKeyId": "5e94d5b63f557b001420bbe3",
    • "userId": "5e94d5b63f557b001420bbe4"
    }
}

Users

Users operations.

Get Users

This endpoint returns users who have current or historical shared workspace access with the user who the API key belongs to.

Authorizations:
x-api-key
query Parameters
page[size]
integer
Example: page[size]=100

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

page[cursor]
string
Example: page[cursor]=5e94d5b63f557b001420bbe3

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

allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
Array of objects (GetUsersModel)

Array of Users

Array
id
string^[a-f\d]{24}$

Id of the user

name
string

The full name of the user

email
string

The email address of the user

accountStatus
string
Enum: "pending" "active" "deactivated"

The account status of the user

object

The role of the user across FloQast

id
string

Role Id

name
string

Role Name

object or null

The role of the user in Audit Projects

id
string

Role Id

name
string

Role Name

lastLoginDate
string or null

The date and time the user last logged into the FloQast application

object
self
string

Link to self

next
string or null

Pagination link pointing to the next page. If there are no more items, this field will be null.

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "links": {
    • "self": "/api/v1/users&page[size]=100&page[cursor]=5e94d5b63f557b001420bbe3",
    • "next": "/api/v1/users?page[size]=100&page[cursor]=63b88f2cb1f05200179e7857"
    }
}

Tags

Get Tags

This API endpoint retrieves tags under a TLC

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Responses

Response Schema: application/json
id
string
name
string
type
string
category
string
tlcId
string
deactivationTime
string

Response samples

Content type
application/json
{
  • "id": "5e94d5b63f557b001420bbe3",
  • "name": "journal_entry",
  • "type": "CUSTOM",
  • "category": "GENERAL",
  • "tlcId": "5e94d5b63f557b001420bbe3",
  • "deactivationTime": null
}

Tag Attachments

This endpoint attaches or detaches a tag to/from a reconciliation. When attaching, if the specified tag does not exist, it will be created and then attached automatically.

Authorizations:
x-api-key
Request Body schema: application/json
system
required
string
Value: "RECONCILIATIONS"

The name of the system receiving the tag (e.g., Reconciliations, Checklists). Currently, only Reconciliations is supported.

systemId
required
string

The unique identifier for the system designated to receive the tag (e.g., Reconciliation ID, Checklist ID). Currently, only Reconciliation ID is supported.

action
required
string
Enum: "ATTACH" "DETACH"

Specifies whether to attach or detach a tag from the system.

name
required
string

Name of the tag

Responses

Request samples

Content type
application/json
{
  • "system": "RECONCILIATIONS",
  • "systemId": "5e94d5b63f557b001420bbe3",
  • "action": "ATTACH",
  • "name": "low_risk"
}

Response samples

Content type
application/json
{
  • "message": "Invalid tag name",
  • "name": "BadRequest",
  • "status": 400
}

Transactions

Transactions operations.

Update Subledgers

This endpoint takes a list of FloQast reconciliation IDs and updates the subledger balance for each.

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Request Body schema: application/json
Array of objects

Array of Subledger Data

Array
reconciliationId
required
string

Id of reconciliation

required
object

Subledger data

balance
required
string

Balance of subledger. The amount may include non-numeric symbols, a minus sign for negatives, and a period or comma for decimals.

currency
required
string

Currency of subledger

locale
string

Locale of balance. Defaults to en-US

Responses

Response Schema: application/json
statusId
string

Request samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "statusId": "615bcdc00000000000000302"
}

Update Transactions

This endpoint takes a reconciliationId and a corresponding ledger type and updates each provided transaction.

Authorizations:
x-api-key
query Parameters
allowRedirect
boolean
Example: allowRedirect=true

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.

Request Body schema: application/json
One of
object
reconciliationId
required
string

Id of reconciliation

ledgerType
required
string
Value: "SUB_LEDGER"

Indicates whether every transaction uses general ledger or subledger

upsert
boolean

If true, upserts the provided subledger transactions, only overwriting transactions with a matching transactionId. If false or absent, replaces existing subledger transactions for this reconciliation prior to inserting the provided subledger transactions.

required
Array of objects

Array of transactions

Array
transactionId
required
string

Unique ERP Identification number

transactionDate
required
string <date>

Date of transaction in ISO 8601 format

accountType
required
string
Enum: "Accounts Receivable" "Accounts Payable" "Fixed Assets" "Accumulated Depreciation" "Inventory" "Cash" "Sales" "Purchase" "Payroll" "Intercompany" "Leases" "Other"

Type of account

accountingDate
required
string <date>

Is the posting date - It determines when the transaction will be included in financial statements in ISO 8601 format

amount
required
string

Dollar amount associated with this transaction. The amount may include non-numeric symbols, a minus sign for negatives, and a period or comma for decimals.

currency
required
string

Currency of transaction

customer
string

Debt or credit to or from a customer

vendor
string

Debt or credit to or from a vendor

assetNumber
string

Unique asset identification number

recordType
string

Type of transaction hitting the subledger like: Credit memo, Journal entry, Payment, Invoice, etc.

leaseId
string

Unique lease identification number

dueDate
string <date>

Due date of transaction.

description
string

Description of transaction

subsidiary
string

entity Name

referenceNumber
string

Unique identifier

quantity
string

Numeric value for quantity

unitValue
string

Dollar price per unit

clearingIndicator
string
Enum: "CLEARED" "OPEN"

To show if an amount has cleared the bank or not

assetType
string

Type of asset/category of asset including Computers, Furniture, Software, etc...

leaseType
string
Enum: "FINANCIAL" "OPERATING"
tradingPartner
string

In relation to related partities. Unique identification of those trading parties.

locale
string

Locale of balance. Defaults to en-US

Responses

Response Schema: application/json
statusId
string

Request samples

Content type
application/json
Example
{
  • "data": {
    • "reconciliationId": "5e94d5b63f557b001420bbe3",
    • "ledgerType": "SUB_LEDGER",
    • "upsert": true,
    • "transactions": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "statusId": "615bcdc00000000000000302"
}

Delete Transactions

This endpoint takes a reconciliationId and deletes all subledger transactions tied to it.

Authorizations:
x-api-key
query Parameters
reconciliationId
required
string
Example: reconciliationId=668ee68e00b661374b4861c6

The reconciliationId specifies all subledger transactions associated with it for deletion

Responses

Response Schema: application/json
statusId
string

Response samples

Content type
application/json
{
  • "statusId": "668ee68e00b661374b4861c6"
}

Get Status

This endpoint takes an ID of an endpoint event and returns the status of the event.

Authorizations:
x-api-key
path Parameters
statusId
required
string
Example: 615bcdc00000000000000302

The status ID returned after making a request

Responses

Response Schema: application/json
_id
string

the Status ID

status
string
Enum: "PENDING" "SUCCESS" "FAILED"

The status of the data being saved to our DB

Array of objects
Array
reconciliationId
string

Id of reconciliation

message
string

A message about the error

Response samples

Content type
application/json
{
  • "_id": "5e94d5b63f557b001420bbe3",
  • "status": "PENDING",
  • "errorList": [
    • {
      }
    ]
}

Trial Balance

Trial Balance operations

Upload Trial Balance Data

This API endpoint takes trial balance data and uploads it to a user's FloQast tenant. Use this endpoint to assign or update trial balance values for each account in a given entity and period.

Authorizations:
x-api-key
Request Body schema: application/json
Array of objects
Array
entityId
required
string

Id of company

required
object
month
required
string
Enum: "january" "february" "march" "april" "may" "june" "july" "august" "september" "october" "november" "december"

Month of balance

year
required
string

Year of balance

required
Array of objects
Array
name
string

Name of account

number
required
string

Number of account

balance
required
string

Balance of account

Responses

Response Schema: application/json
Array of objects
Array
entityId
string
object
month
string
year
string
success
boolean

Request samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ]
}