v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

Journals

Create a Reverse Batch Journal Transaction (Many-to-One)

You can also create a batch journal request by using the following endpoint. This is enabled on JNLC for now only.

Note that if there is an invalid account_id the whole batch operation will be canceled. Every single request must be valid for the entire batch operation to succeed.

In the case of a successful request, the response will contain an array of journal objects with an extra attribute error_message in the case when a specific account fails to submit a journal.

post/v1/journals/reverse_batch

Request body

entry_type'JNLC'

Only supports JNLC for now

to_accountstring

The destination of funds. Most likely is your Sweep Firm Account

Response

Example response

[
  {
    "entry_type": "JNLS",
    "from_account": "8fjkjn-4483-4199-840f-6c5fe0b7ca24",
    "id": "h7h5g33f-ef01-4458-9a4b-9598727a406f",
    "price": "128.23",
    "qty": "2",
    "settle_date": "2020-12-24",
    "status": "executed",
    "symbol": "AAPL",
    "to_account": "3gtt65jd-6f2a-433c-8c33-17b66b8941fa"
  }
]