POST
/
v0
/
ledgers
/
{ledger_id}
/
transactions

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

The Teal instance ID

modified-by
string | null

An optional identifier for audit logging.

Path Parameters

ledger_id
string
required

The ledger ID

Body

application/json · object[]
id
string
required

The unique ID of the object. This is used as an idempotency key to prevent duplicates. This is manually set as part of the create transactions request. If the transaction is created via a data integration, Plaid for example, it will be set to the transaction_id to enforce idempotency with the data source.

Minimum length: 1
amount
required

The value of the transaction in decimal dollar cents.

datetime
string
required

The UTC datetime that the Transaction was created. This will never be before an Instance's entries_start date. When importing transactions, transactions whose datetime is before the Instance’s entries_start date will be skipped. Other transactions will be processed as normal.

description
string
required

An arbitrary string on the object, useful for displaying information to the user.

metadata
object | null

Arbitrary structured information about the transaction. This could be location of the transaction to display to the user or vendor information to use as part of a Platform or Instance categorization rule. Teal does not use metadata for any accounting purposes.

tag_ids
string[] | null

An array of IDs of the Tag objects associated with the Transaction.

Note that Tags are not transitive and the tags on a Transaction can be different than those on its line entry or entires.

opposing_ledger_id
string | null

The ledger id of the opposing ledger.

Response

202 - application/json
id
string
required
status
enum<string>
required

Indicates the status of the task.

Available options:
pending,
failed,
complete
created_datetime
string
required

Indicates the datetime in UTC when the task was created.

updated_datetime
string | null
required

Indicates the datetime in UTC when the task was last updated.

error
object | null
required

The Error object if any errors were encountered in the processing. If the processing task was created by a Plaid import, the Plaid errors will be passed through there. See Plaid's documentation for more information on their error messages.

source_account_id
string
required

The source account containing the transactions

ledger_id
string | null
required

The ID of the ledger that the transactions are being created for.

created_transaction_ids
string[] | null

The IDs of Transactions successfully processed by this task.

removed_transaction_ids
string[] | null

The IDs of Transactions that were removed by this task.

modified_transaction_ids
string[] | null

The IDs of Transactions that were modified by this task.

skipped_transaction_ids
string[] | null

The IDs of Transactions that were skipped by this task.

List a Ledger's TransactionsDelete a Ledger Transaction