Skip to main content
POST
/
tpa
/
statement
/
attach
Attach Statement to Document
curl --request POST \
  --url https://api.stax.ai/tpa/statement/attach \
  --header 'Content-Type: application/json' \
  --cookie authToken= \
  --data '
{
  "docId": "<string>",
  "planId": "<string>",
  "accountNumber": "<string>"
}
'
{
  "success": true,
  "statement": {
    "_id": "<string>",
    "team": "<string>",
    "plan": "<string>",
    "account": "<string>",
    "planId": "<string>",
    "accountNumber": "<string>",
    "document": "<string>",
    "pageCount": 123,
    "duplicates": [
      "<string>"
    ],
    "creator": "<string>",
    "planYear": 123,
    "periodStart": "2023-11-07T05:31:56Z",
    "periodEnd": "2023-11-07T05:31:56Z",
    "months": [
      "<string>"
    ],
    "beginningBalance": 123,
    "endingBalance": 123,
    "reconciles": true,
    "tx": {
      "deposits": 123,
      "withdrawals": 123,
      "income": 123,
      "fees": 123,
      "transfers": 123,
      "purchases": 123,
      "sales": 123,
      "reinvestments": 123,
      "other": 123,
      "accrued": 123,
      "gain_loss": 123,
      "rollovers": 123,
      "forfeiture": 123,
      "loanPayments": 123,
      "newLoans": 123,
      "loanInterest": 123
    },
    "diff": {
      "deposits": 123,
      "withdrawals": 123,
      "income": 123,
      "fees": 123,
      "loanPayments": 123,
      "transfers": 123,
      "rollovers": 123,
      "reinvestments": 123,
      "other": 123,
      "gain_loss": 123,
      "accrued": 123,
      "purchases": 123,
      "sales": 123
    },
    "errors": [
      "<string>"
    ],
    "confidence": {},
    "ref": {},
    "participant": "<string>",
    "moneyType": "<string>",
    "confirmed": true,
    "clientConfirmed": true,
    "accepted": {},
    "history": [
      {
        "user": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "changes": [
          {
            "field": "<string>",
            "from": "<string>",
            "to": "<string>"
          }
        ]
      }
    ],
    "createdOn": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "classifying": true
  }
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Body

application/json
docId
string
required

MongoDB ObjectId

planId
string
accountNumber
string

Response

200 - application/json

Statement attached

success
boolean
statement
object