POST
/
v0
/
ledgers
/
{ledger_id}
/
transactions
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '[
  {
    "amount": 100,
    "datetime": "2022-01-01T00:00:00Z",
    "description": "Shell Gas Bar 4124",
    "id": "t_9237232",
    "metadata": {
      "location": "TX, USA",
      "vendor_type": "Gas station"
    },
    "tag_ids": [
      "<string>"
    ]
  }
]'
{
  "created_datetime": "2022-01-01T00:00:00Z",
  "error": {
    "causes": [
      {
        "causes": [
          {
            "causes": [
              {
                "causes": [
                  {
                    "causes": [
                      {
                        "causes": [
                          "<any>"
                        ],
                        "display_message": "Something went wrong.",
                        "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                        "error_code": "INTERNAL_SERVER_ERROR",
                        "error_message": "An unexpected error occurred.",
                        "error_type": "API_ERROR",
                        "request_id": "KipL51BWnPIpOmi",
                        "status": 500,
                        "suggested_action": "<string>"
                      }
                    ],
                    "display_message": "Something went wrong.",
                    "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                    "error_code": "INTERNAL_SERVER_ERROR",
                    "error_message": "An unexpected error occurred.",
                    "error_type": "API_ERROR",
                    "request_id": "KipL51BWnPIpOmi",
                    "status": 500,
                    "suggested_action": "<string>"
                  }
                ],
                "display_message": "Something went wrong.",
                "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
                "error_code": "INTERNAL_SERVER_ERROR",
                "error_message": "An unexpected error occurred.",
                "error_type": "API_ERROR",
                "request_id": "KipL51BWnPIpOmi",
                "status": 500,
                "suggested_action": "<string>"
              }
            ],
            "display_message": "Something went wrong.",
            "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
            "error_code": "INTERNAL_SERVER_ERROR",
            "error_message": "An unexpected error occurred.",
            "error_type": "API_ERROR",
            "request_id": "KipL51BWnPIpOmi",
            "status": 500,
            "suggested_action": "<string>"
          }
        ],
        "display_message": "Something went wrong.",
        "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
        "error_code": "INTERNAL_SERVER_ERROR",
        "error_message": "An unexpected error occurred.",
        "error_type": "API_ERROR",
        "request_id": "KipL51BWnPIpOmi",
        "status": 500,
        "suggested_action": "<string>"
      }
    ],
    "display_message": "Something went wrong.",
    "documentation_url": "https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error",
    "error_code": "INTERNAL_SERVER_ERROR",
    "error_message": "An unexpected error occurred.",
    "error_type": "API_ERROR",
    "request_id": "KipL51BWnPIpOmi",
    "status": 500,
    "suggested_action": "<string>"
  },
  "id": "UjL3BQnEaJtecuC7CUeDk",
  "ledger_id": "9jXyj7EpZNizehSd9wJN3G",
  "status": "pending",
  "updated_datetime": "2022-01-01T00:00:00Z"
}

Authorizations

Authorization
string
headerrequired

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

Headers

teal-instance-id
string
required

Path Parameters

ledger_id
string
required

The ledger ID

Body

application/json · object[]
amount
required
datetime
string
required

Datetime of the transaction.

description
string
required
id
string
required

The ID of the transaction. The ID is unique per ledger.

metadata
object | null

Any metadata that you would like to associate with the transaction. This metadata will be available to the auto-categorization pipeline for assistance in properly categorizing the transaction automatically. This metadata is entirely configurable by you; this parameter will accept any key-value pairs you care to submit with the transaction for later use.

tag_ids
string[] | null

The tag ids of the tags that should be applied to associated line entries.

Response

202 - application/json
created_datetime
string
required

The date the transaction processing task object was created.

error
object | null
required

Any error that was encountered while processing transactions.

  • Option 1

  • Option 2

id
string
required
ledger_id
string | null
required

The ledger ID.

status
enum<string>
required
Available options:
pending,
failed,
complete
updated_datetime
string | null
required

The date the transaction processing task task was last updated.