Skip to content
/
Update Subledgers

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

Update Subledgers

Request

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

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 field body.data.url will 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. In the case of General Ledger Transactions, it also takes a unique entityId.

Security
x-api-key
Path
versionstringrequired

API version

Default "v2"
Enum"v2""v1"
Example: v2
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
Body
required
One of:
dataobject
curl -i -X PUT \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v2/transactions?allowRedirect=true' \
  -H 'Content-Type: application/json;version=v2' \
  -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.

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

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations

User Groups

Operations

Folders

Operations

Controls

Operations

Programs

Operations

Processes

Operations

Guest Users

Operations