Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserIntegrations

Upload Ocrolus

Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user

post/api/end_users/{end_user_id_or_heron_id}/ocrolus

Path parameters

end_user_id_or_heron_idstring required

The end_user_id or heron_id of EndUser to upload

Query parameters

skip_num_txns_checkboolean

Skip the check for the number of transactions in the payload

Request body

Example request

{
  "response": {
    "bank_accounts": [
      {
        "alternative_lender_transactions": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "debt_consolidator_txns": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "estimated_expense_txns_list": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "estimated_revenue_txns_list": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "factor_txns": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "insurance_credits": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "insurance_debits": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "interbank_transactions": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "merchant_cash_advance_lender_txns": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "non_estimated_revenue_txns_list": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "nsf_transactions": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "nsf_transactions_paid_or_negative_balance": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "nsf_transactions_returned_or_not_paid": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "outside_source_deposits": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "payroll": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "period_balance_mismatches": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "ppp_loan_txns": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "probable_recurring_txns": [
          [
            {
              "txn_date": "07/08/2025"
            }
          ]
        ],
        "returned_items": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "round_number_txns": [
          {
            "txn_date": "07/08/2025"
          }
        ],
        "withdrawals": [
          {
            "txn_date": "07/08/2025"
          }
        ]
      }
    ]
  }
}

Response

OK