HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

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

You can create a batch of journal requests by using this endpoint. This is enabled on JNLC type Journals for now only.

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 receive a journal.

Body Params
string
enum
required

Only supports JNLC for now

Allowed:
uuid
required

The account id that is the originator of the funds being moved. Most likely is your Sweep Firm Account

string

Journal description, gets returned in the response

entries
array of objects
required
length ≄ 1

An array of objects describing to what accounts you want to move funds into and how much to move into for each account

entries*
uuid
required

The ID of the account that you want to journal funds into

string
required

Journal amount in USD

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible