Transactions
/
Update Transactions

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

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Update Subledgers

Request

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

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 Subledger Data

curl -i -X PUT \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/transactions/subledgers?allowRedirect=true' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "data": [
      {
        "reconciliationId": "5e94d5b63f557b001420bbe3",
        "subledger": {
          "balance": "1001.99",
          "currency": "USD",
          "locale": "en-US"
        }
      }
    ]
  }'

Responses

Success

Bodyapplication/json
statusIdstring
Example: "615bcdc00000000000000302"
Response
application/json
{
  "statusId": "615bcdc00000000000000302"
}

Update Transactions

Request

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

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
One of:
dataobject
curl -i -X PUT \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/transactions?allowRedirect=true' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "reconciliationId": "5e94d5b63f557b001420bbe3",
      "ledgerType": "SUB_LEDGER",
      "upsert": true,
      "transactions": [
        {
          "transactionId": "TX12848472728",
          "transactionDate": "2020-04-13",
          "accountType": "Accounts Receivable",
          "accountingDate": "2020-04-13",
          "amount": "15821.56",
          "currency": "USD",
          "customer": "PepsiCo",
          "vendor": "Salesforce",
          "assetNumber": "FA101",
          "recordType": "Credit memo",
          "leaseId": "LSE1001",
          "dueDate": "2020-05-13",
          "description": "Credit memo for returned items",
          "subsidiary": "PepsiCo North America",
          "referenceNumber": "REF-485769",
          "quantity": "17",
          "unitValue": "930.68",
          "clearingIndicator": "CLEARED",
          "assetType": "Computers",
          "leaseType": "FINANCIAL",
          "tradingPartner": "TP-001",
          "locale": "en-US"
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
statusIdstring
Example: "615bcdc00000000000000302"
Response
application/json
{
  "statusId": "615bcdc00000000000000302"
}

Delete Transactions

Request

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

Query
reconciliationIdstringrequired

The reconciliationId specifies all subledger transactions associated with it for deletion

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

Responses

Success

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

Get Status

Request

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

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": [
    { … }
  ]
}

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations