Skip to content

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
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/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

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

Security
x-api-key
Path
reconciliationIdstringrequired

The reconciliationId specifies all subledger transactions associated with it for deletion

Example: 668ee68e00b661374b4861c6
curl -i -X DELETE \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/transactions/668ee68e00b661374b4861c6 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
statusIdstring
Example: "668ee68e00b661374b4861c6"
Response
application/json
{ "statusId": "668ee68e00b661374b4861c6" }

Request

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

Security
x-api-key
Path
statusIdstringrequired

The status ID returned after making a request

Example: 615bcdc00000000000000302
curl -i -X GET \
  https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/transactions/status/615bcdc00000000000000302 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_idstring

the Status ID

Example: "5e94d5b63f557b001420bbe3"
statusstring

The status of the data being saved to our DB

Enum"PENDING""SUCCESS""FAILED"
errorListArray of objects
Response
application/json
{ "_id": "5e94d5b63f557b001420bbe3", "status": "PENDING", "errorList": [ { … } ] }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations