---
updatedAt: 2026-09-16T12:40:39.000Z
agentTools:
  projectIndex: https://docs.datanomik.com/llms.txt
---

# Cash Flow records by scenario

Retrieve a link information on demand

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "openbanking-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.datanomik.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/cash-flows/records": {
      "post": {
        "summary": "Cash Flow records by scenario",
        "description": "Retrieve a link information on demand",
        "operationId": "scenarios",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {}
          },
          "207": {
            "description": "Multi-Status. Some records were persisted and others failed; see `errors` in the body.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"processed\": 2,\n    \"errors\": [\n        {\n            \"index\": 1,\n            \"externalId\": \"ERP-000123\",\n            \"message\": \"Unsupported currency: XXX\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "processed": {
                      "type": "integer",
                      "example": 2
                    },
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "index": {
                            "type": "integer",
                            "example": 1
                          },
                          "externalId": {
                            "type": "string",
                            "example": "ERP-000123"
                          },
                          "message": {
                            "type": "string",
                            "example": "Unsupported currency: XXX"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"code\": 401,\n    \"type\": \"UNAUTHORIZED\",\n    \"message\": \"Invalid credentials\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    },
                    "type": {
                      "type": "string",
                      "example": "UNAUTHORIZED"
                    },
                    "message": {
                      "type": "string",
                      "example": "Invalid credentials"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Source IP not whitelisted, credentials without the required scope, or trial period expired.",
            "content": {
              "application/json": {
                "examples": {
                  "IP_NOT_ALLOWED": {
                    "value": "{\n    \"code\": 632,\n    \"type\": \"IP_NOT_ALLOWED\",\n    \"message\": \"Source ip address not allowed.\",\n    \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}"
                  },
                  "FORBIDDEN": {
                    "value": "{\n    \"code\": 403,\n    \"type\": \"FORBIDDEN\",\n    \"message\": \"Forbidden\",\n    \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 632
                    },
                    "type": {
                      "type": "string",
                      "example": "IP_NOT_ALLOWED"
                    },
                    "message": {
                      "type": "string",
                      "example": "Source ip address not allowed."
                    },
                    "traceId": {
                      "type": "string",
                      "example": "0af7651916cd43dd8448eb211c80319c"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error. Unexpected error; report the `traceId` to support.",
            "content": {
              "application/json": {
                "examples": {
                  "INTERNAL_ERROR": {
                    "value": "{\n    \"code\": 500,\n    \"type\": \"INTERNAL_ERROR\",\n    \"message\": \"Unexpected error. Please contact support with the traceId.\",\n    \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 500
                    },
                    "type": {
                      "type": "string",
                      "example": "INTERNAL_ERROR"
                    },
                    "message": {
                      "type": "string",
                      "example": "Unexpected error. Please contact support with the traceId."
                    },
                    "traceId": {
                      "type": "string",
                      "example": "0af7651916cd43dd8448eb211c80319c"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "external_id": {
                      "type": "string",
                      "description": "Unique identifier in the source system"
                    },
                    "company": {
                      "type": "object",
                      "properties": {
                        "document_type": {
                          "type": "string",
                          "description": "Document type",
                          "enum": [
                            "CNPJ",
                            "RUC",
                            "CUIT",
                            "EIN"
                          ]
                        },
                        "document_number": {
                          "type": "string",
                          "description": "Document number"
                        },
                        "country": {
                          "type": "string",
                          "description": "Country",
                          "enum": [
                            "AR",
                            "BR",
                            "UY",
                            "US",
                            "PY"
                          ]
                        }
                      },
                      "description": "Company information",
                      "required": [
                        "document_type",
                        "document_number",
                        "country"
                      ]
                    },
                    "scenario": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Scenario name. Ex: FORECAST_APRIL"
                        },
                        "date": {
                          "type": "string",
                          "description": "Scenario date. Ex. 2024-04-01"
                        }
                      },
                      "required": [
                        "name",
                        "date"
                      ]
                    },
                    "category_path": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Category path. \nEx. \n\"FLUXO OPERATIVO\",\n    \"PAGAMENTOS\",\n        \"FORNECEDORES\""
                    },
                    "transaction_date": {
                      "type": "string",
                      "description": "Transaction date. Ex. 2024-04-10"
                    },
                    "cash_impact_date": {
                      "type": "string",
                      "description": "Cash impact date. Ex. 2024-04-10"
                    },
                    "record_period": {
                      "type": "string",
                      "description": "Record period.",
                      "enum": [
                        "DAILY",
                        "WEEKLY",
                        "MONTHLY",
                        "QUARTERLY",
                        "YEARLY"
                      ]
                    },
                    "record_type": {
                      "type": "string",
                      "description": "Record Type.",
                      "enum": [
                        "ACTUAL",
                        "EXPECTED",
                        "PROJECTED"
                      ]
                    },
                    "flow_type": {
                      "type": "string",
                      "enum": [
                        "INFLOW",
                        "OUTFLOW"
                      ],
                      "description": "Flow type (Credit or Debit)"
                    },
                    "amount": {
                      "type": "string",
                      "description": "Amount. If debit amount must be negative"
                    },
                    "currency": {
                      "type": "string",
                      "description": "Currency",
                      "enum": [
                        "BRL",
                        "ARS",
                        "USD",
                        "PYG"
                      ]
                    }
                  },
                  "required": [
                    "external_id",
                    "company",
                    "scenario",
                    "transaction_date",
                    "category_path",
                    "record_period",
                    "record_type",
                    "amount",
                    "flow_type",
                    "currency"
                  ]
                }
              },
              "examples": {
                "Body Example": {
                  "summary": "Body Example",
                  "value": [
                    {
                      "external_id": "ERP-8821",
                      "company": {
                        "document_type": "CNPJ",
                        "document_number": "12345678000199",
                        "country": "BR"
                      },
                      "scenario": {
                        "name": "FORECAST_APRIL",
                        "date": "2024-04-01"
                      },
                      "category_path": [
                        "FLUXO OPERATIVO",
                        "PAGAMENTOS",
                        "FORNECEDORES"
                      ],
                      "transaction_date": "2024-04-10",
                      "cash_impact_date": "2024-04-30",
                      "record_period": "MONTHLY",
                      "record_type": "PROJECTED",
                      "flow_type": "OUTFLOW",
                      "amount": 5000,
                      "currency": "BRL"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```