Post Reconciliation Signatures

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

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

Get Reconciliations

Request

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.

Query

filter[month]string

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.

Example: filter[month]=march

filter[year]integer

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.

Example: filter[year]=2023

filter[modifiedBefore]string(date)

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.

Example: filter[modifiedBefore]=2021-01-01

filter[modifiedSince]string(date)

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.

Example: filter[modifiedSince]=2020-12-31

filter[entityIds]string

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

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

filter[workflowIds]string

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

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

filter[journalSource]string

journalSource for which the reconciliations should be retrieved.

Example: filter[journalSource]=SUB_LEDGER

filter[internalIds]string

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

Example: filter[internalIds]=123456, 78910

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/reconciliations?allowRedirect=true&filter%5BentityIds%5D=5e94d5b63f557b001420bbe1%2C5e94d5b63f557b001420bbe2&filter%5BinternalIds%5D=123456%2C%2078910&filter%5BjournalSource%5D=SUB_LEDGER&filter%5BmodifiedBefore%5D=2021-01-01&filter%5BmodifiedSince%5D=2020-12-31&filter%5Bmonth%5D=march&filter%5BworkflowIds%5D=5e94d5b63f557b001420baa1%2C5e94d5b63f557b001420baa2&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(ReconciliationModel)

Array of Reconciliations

linksobject

Response

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

Post Reconciliation Signatures

Request

This API endpoint updates the signature status of a reconciliation.

Path

reconciliationIdstringrequired

The ID of the reconciliation 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/reconciliations/{reconciliationId}/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 reconciliation

Example: "5e94d5b63f557b001420bbe3"

entityobject

typeany

Enum"SINGLE""GROUPED"

Example: "SINGLE"

namestring

Name of reconciliation

Example: "1200 Accounts Receivable"

updatedAtany

Date when reconciliation was last updated

Example: "2024-01-01T00:00:00.000Z"

glBalancestring

Balance per general ledger provider

Example: "39.8"

globject

currencyobject

accountsArray of objects

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

periodobject

journalSourcestring

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

Enum"GENERAL_LEDGER""SUB_LEDGER"

templateIdstring

Template Id of reconciliation

Example: "5e94d5b63f557b001420bbe3"

tagsArray of objects

signaturesArray of objects

Response

application/json

{
  "_id": "5e94d5b63f557b001420bbe3",
  "entity": {
    "_id": "5e94d5b63f557b001420bbe2",
    "name": "John Smith's company",
    "workflow": { … }
  },
  "type": "SINGLE",
  "name": "1200 Accounts Receivable",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "glBalance": "39.8",
  "gl": {
    "internalId": "1234",
    "internalPeriod": "334",
    "provider": "TB",
    "TB": { … },
    "NETSUITE": { … },
    "INTACCT": { … },
    "QBO": { … },
    "MSDYNAMICS": { … },
    "SAP": { … },
    "XERO": { … }
  },
  "currency": {
    "code": "USD",
    "symbol": "$",
    "name": "US Dollar",
    "decimalDigits": 2
  },
  "accounts": [
    { … }
  ],
  "period": {
    "month": "december",
    "year": "2023"
  },
  "journalSource": "GENERAL_LEDGER",
  "templateId": "5e94d5b63f557b001420bbe3",
  "tags": [
    { … }
  ],
  "signatures": [
    { … }
  ]
}

Checklist Analytics

Operations

Reconciliation Analytics

Operations

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations

FloQast External API (1.0.0)

Authentication

Checklists

Reconciliations

Get Reconciliations

Request

Responses

Was this helpful?

Post Reconciliation Signatures

Request

Responses

Was this helpful?

Checklist Analytics

Reconciliation Analytics

Depreciations

Amortization

Audit Trail

Transactions

Entities

Trial Balance

Tags

Chart Of Accounts

Info

Users