--- title: "List forecasted transaction batches" method: GET path: "/analytics/v2beta/forecasted-transaction-batches" tags: ["Forecasted Transactions"] --- # List forecasted transaction batches `GET /analytics/v2beta/forecasted-transaction-batches` ## Request - Base URL: `https://api.atlar.com` - URL: `https://api.atlar.com/analytics/v2beta/forecasted-transaction-batches` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a list of forecasted transaction batches. ## Query parameters - `limit` integer - `token` string ## Response `200` A list of forecasted transaction batches. - object - `items` ForecastedTransactionBatch[], required: A list of resources. - `id` string, required: Unique resource identifier. - `organizationId` string, required: Unique resource identifier for an Organization. - `inputContent` BatchInputContent, required: Metadata describing the input contents that was used to create this batch. - `contentType` string, required - `recordCount` integer, required: Total count of input records (resources) in the input batch. - `size` integer, required: The size of the input content in bytes. If the batch was created by uploading a file using `multipart/form-data` the `contentSize` will be the file size. If the batch was created with JSON input this will be the raw JSON size. - `checksum` string, required: A checksum of the batch input contents. The checksum digest value will be prefixed by an identifier of the hash algorithm used, e.g. `sha256`. A colon `:` is used as separator between the algorithm identifier and the digest value. - `filename` string: The name of the file that was used as input to create the batch. Filename will only available if the batch input was provided using `multipart/form-data`. - `inputDetails` ForecastedTransactionBatchDetails, required: Details summarizing the contents of the batch. - `sums` Amount[], required: The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources). - `currency` string, required: Three-letter ISO 4217 currency code. - `stringValue` string, required: A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `resultSummary` BatchResultSummary: Aggregate summary of batch processing results. - `total` integer, required: Number of input records that were attempted to be processed. - `succeeded` integer, required: Number of input records that resulted in a successfully created resource. - `failed` integer, required: Number of failed records. - `skipped` integer, required: Number of input records that were skipped. - `resultDetails` ForecastedTransactionBatchDetails: Details summarizing the contents of the batch. - `sums` Amount[], required: The total amount sum per each currency of resources in this batch. Note that batch amount sums reported on the batch input metadata refer to the total amount sums of the input records (resources) while the batch amount sums reported on the batch result refer to the total amount sums of the successfully processed records (resources). This means that there may be a difference in the total sum for the input vs the result, due to skipped records (resources). - `currency` string, required: Three-letter ISO 4217 currency code. - `stringValue` string, required: A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `status` 'CREATED' | 'PROCESSING_STARTED' | 'COMPLETED', required: The status of this batch. The status only refers to the processing of the input, not the processing or success of the resources themselves. `COMPLETED` is the only end-state. Failure is indicated by a non-empty list of `errors`. - `errors` ErrorDetails[]: A list of error details if the batch failed. Only populated once the batch has reached status `COMPLETED`. Only the first 255 errors (if any) will be present in this list. If there are more errors, the complete list can be retrieved using the results endpoint for the batch. - `code` string: An error code for this error. Not always present. - `error` string: A description of this specific error. - `field` string: The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists. - `metadata` object: Optional machine-readable data about the error. What it contains typically depends on `code`. At most 16 entries and 1 KiB in total (keys and values), keys up to 64 chars and values up to 256. - `externalId` string: External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`. - `metadata` Metadata, nullable: Metadata is a `string-string` key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the [Metadata keys page](https://app.atlar.com/metadata-keys). Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set. - `creatorUserId` string, required: Unique resource identifier. - `creatorRoleId` string, required: Unique resource identifier. - `etag` string, required: [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update. - `version` integer, required: Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `created` string, date-time, required: Time at which the resource was created. - `updated` string, date-time, required: Time at which the resource was last updated. - `nextToken` string, required: Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched. - `token` string, required: The pagination token that was used for this request. The value will be an empty string if no `token` query parameter was provided with the request. - `limit` integer, required: The page limit that was used for this request. ## Other responses - `400`: Bad request. ## Changes - **2026-11-03** `b49df1e4b3e9`: 1 info - endpoint added [Operation history](https://skmtc.dev/atlar/apis/atlar-api-v2/changes/analytics/v2beta/forecasted-transaction-batches/get.md) --- [API](https://skmtc.dev/atlar/apis/atlar-api-v2.md) - [All operations](https://skmtc.dev/atlar/apis/atlar-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/atlar/apis/atlar-api-v2/revisions/b49df1e4b3e9?raw)