Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Forecasted Transactions

List forecasted transactions

Returns a list of forecasted transactions. For further details on Pagination, see general section above.

get/analytics/v2beta/forecasted-transactions

Query parameters

accountIdstring
Example:31d593d7-fff9-4783-aa1d-92acb7b21a19

Only include forecasted transactions with the given account.

batchIdstring
Example:fc80aa63-d8e7-45cc-a241-1ac76e0e9454

Only include forecasted transactions that belong to the given batch.

string date

Include only forecasted transactions with date equal to the given value.

OR
Example:2022-01-15

Include only forecasted transactions with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of forecasted transactions.

nextTokenstring 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.

tokenstring 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.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "scenarioId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "parent": {
        "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      },
      "amount": {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      },
      "date": "2022-05-07",
      "origin": {
        "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      },
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "counterparty": {
        "partyType": "INDIVIDUAL",
        "name": "Customer #312",
        "nationalIdentifier": {
          "type": "CIVIC",
          "market": "DE",
          "number": "2012121212"
        },
        "address": {
          "country": "DE",
          "countrySubdivision": "US-CA",
          "city": "Stockholm",
          "postalCode": "11111",
          "streetName": "Example street",
          "streetNumber": "47"
        },
        "account": {
          "market": "DE",
          "identifiers": [
            {
              "type": "IBAN",
              "market": "DE",
              "number": "DE75512108001245126199"
            }
          ],
          "routing": [
            {
              "type": "BIC",
              "number": "BUKBGB22"
            }
          ]
        }
      },
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "etag": "version:3"
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}