v1

latestOpenAPI 3.0.02026-07-263365159.1 KB

MCA Analysis

post/api/v1/skitty/analytics/account-summary/

Query parameters

allow_partialboolean

If true, allows processing even if some documents are not in valid status

webhookboolean

If true, triggers a webhook notification after processing

Headers

apikeystring required

Request body

doc_idsstring[]

List of document IDs to process.

mca_list_db_tablestring

Database table name for MCA (Merchant Cash Advance) list

non_mca_list_db_tablestring

Database table name for non-MCA list

Response

200

Example response

{
  "account_summaries": [
    [
      {
        "account_info": {
          "account_address": "string",
          "account_name": "string",
          "account_number": "string",
          "account_type": "string",
          "bank_name": "string",
          "end_date": "string (MM/DD/YYYY)",
          "month": "string (YYYY-MM)",
          "start_date": "string (MM/DD/YYYY)"
        },
        "summary": {
          "start_date": "string (MM/DD/YYYY)",
          "end_date": "string (MM/DD/YYYY)",
          "month": "string (YYYY-MM)",
          "average_balance": "number",
          "closing_balance": "number",
          "days_with_negative_balance": "integer",
          "holdback_percentage": "number",
          "mca_debits": "number",
          "mca_deposits": "number",
          "no_od_nsf": "integer",
          "no_of_deposits": "integer",
          "no_of_overdraft_transactions": "integer",
          "no_of_revenue": "integer",
          "no_of_withdrawals": "integer",
          "opening_balance": "number",
          "total_deposits": "number",
          "total_non_revenue": "number",
          "total_revenue": "number",
          "total_withdrawals": "number"
        },
        "transactions": {
          "mca": {
            "debits": [
              {
                "amount": "number",
                "balance": "number",
                "category": "string",
                "check_no": "string",
                "credit": "number",
                "date": "string (MM/DD/YYYY)",
                "debit": "number",
                "description": "string",
                "features": {
                  "description_clean": "string",
                  "duplicate_of_id": "integer | null",
                  "has_matching_transaction": "boolean",
                  "is_potential_duplicate": "boolean",
                  "is_potentially_recurring": "boolean",
                  "is_recurring": "boolean"
                },
                "id": "integer",
                "ignore": "boolean",
                "merchant": {
                  "categories": "array",
                  "is_mca": "boolean",
                  "name": "string"
                },
                "month": "string (YYYY-MM)",
                "subcategory": "string",
                "type": "string",
                "weekday": "string"
              }
            ],
            "deposits": "array"
          },
          "nsf_ods": {
            "nsf": "array",
            "ods": "array"
          },
          "transaction_patterns": {
            "duplicates": "array",
            "matching": "array",
            "recurring": "array"
          }
        }
      }
    ]
  ]
}