--- updatedAt: 2026-09-16T12:40:37.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Cash Flow Category Summary 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/transaction-category-summary": { "post": { "summary": "Cash Flow Category Summary", "description": "Retrieve a link information on demand", "operationId": "cashflow-category-summary", "parameters": [], "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Requested": { "value": [ { "id": "741cded3-4932-48e3-962d-0ca0597490b3", "client_id": "e7e2342c-1928-42fc-80b7-6725366ec62d", "link_id": "a4c21161-9108-42f2-978d-8ce609e623b2", "account_id": "9eda9c1c-d3d0-4f83-8add-b2f60242523e", "account": { "id": "9eda9c1c-d3d0-4f83-8add-b2f60242523e", "description": "Cash Forecasting Account", "branch": "0001", "account_number": "000000001", "type": "Conta Corrente", "category": "CASH_FORECASTING", "up_to_date": false, "created_at": "2025-11-21T13:02:28.667268Z", "updated_at": "2025-11-21T13:02:28.673949Z", "status": "ACTIVE", "country": "BR", "institution_type": "CASH", "institution_logo": "https://resources.datanomik.com/institutions/br/Cashholding.svg", "institution": "CASHHOLDING", "institution_description": "Cashholding", "favourite": false, "ownership": 100, "account_sync_status": "PROCESSED" }, "institution_id": "80c932b5-e329-465b-975c-e269bc476649", "category": { "id": "2b66f3b0-f254-432d-8356-2f20c39b4b44", "name": "test-credito", "color": "#D2FFC7", "type": "INFLOW", "ordering": 0, "parent_id": "3c59bf98-b18c-4ca3-b86e-aa59ccfb115f", "children": [], "impact_cash_flow": true, "multiple_categorize": false, "allow_manual_conf": true, "taxes": [], "investment_return": {} }, "type": "INFLOW", "date": "2025-11-15", "currency": "BRL", "country": "BR", "amount": 250.5, "mode": "AUTOMATIC" }, { "id": "0f177fc7-2c6d-4633-91d0-02cbb7c9f687", "client_id": "e7e2342c-1928-42fc-80b7-6725366ec62d", "link_id": "a4c21161-9108-42f2-978d-8ce609e623b2", "account_id": "9eda9c1c-d3d0-4f83-8add-b2f60242523e", "account": { "id": "9eda9c1c-d3d0-4f83-8add-b2f60242523e", "description": "Cash Forecasting Account", "branch": "0001", "account_number": "000000001", "type": "Conta Corrente", "category": "CASH_FORECASTING", "up_to_date": false, "created_at": "2025-11-21T13:02:28.667268Z", "updated_at": "2025-11-21T13:02:28.673949Z", "status": "ACTIVE", "country": "BR", "institution_type": "CASH", "institution_logo": "https://resources.datanomik.com/institutions/br/Cashholding.svg", "institution": "CASHHOLDING", "institution_description": "Cashholding", "favourite": false, "ownership": 100, "account_sync_status": "PROCESSED" }, "institution_id": "80c932b5-e329-465b-975c-e269bc476649", "category": { "id": "2b66f3b0-f254-432d-8356-2f20c39b4b44", "name": "test-credito", "color": "#D2FFC7", "type": "INFLOW", "ordering": 0, "parent_id": "3c59bf98-b18c-4ca3-b86e-aa59ccfb115f", "children": [], "impact_cash_flow": true, "multiple_categorize": false, "allow_manual_conf": true, "taxes": [], "investment_return": {} }, "type": "INFLOW", "date": "2025-11-30", "currency": "BRL", "country": "BR", "amount": 150, "mode": "MANUAL" } ] } }, "schema": { "type": "object", "properties": { "Account Id": { "type": "string", "description": "account_id" }, "Category Id": { "type": "string", "description": "category_id" }, "Cash Flow Date": { "type": "string", "description": "date" }, "Amount": { "type": "string", "description": "amount" } }, "required": [ "Account Id", "Category Id", "Cash Flow Date", "Amount" ] } } } }, "400": { "description": "Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.", "content": { "application/json": { "examples": { "BEAN_VALIDATION_ERROR": { "value": "{\n \"code\": 402,\n \"type\": \"BEAN_VALIDATION_ERROR\",\n \"message\": \"Invalid arguments for specific request. Please check details to satisfy validations\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\",\n \"details\": [\n \"linkId: must not be blank\"\n ]\n}" }, "TYPE_MISMATCH": { "value": "{\n \"code\": 454,\n \"type\": \"TYPE_MISMATCH\",\n \"message\": \"Type mismatch for parameter\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 402 }, "type": { "type": "string", "example": "BEAN_VALIDATION_ERROR" }, "message": { "type": "string", "example": "Invalid arguments for specific request. Please check details to satisfy validations" }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" }, "details": { "type": "array", "items": { "type": "string" }, "example": [ "linkId: must not be blank" ] } } } } } }, "401": { "description": "401", "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" } } } } } }, "404": { "description": "Not Found. The referenced resource does not exist or does not belong to your workspace.", "content": { "application/json": { "examples": { "ACCOUNT_NOT_FOUND": { "value": "{\n \"code\": 620,\n \"type\": \"ACCOUNT_NOT_FOUND\",\n \"message\": \"Account resource not found.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "CATEGORY_NOT_FOUND": { "value": "{\n \"code\": 690,\n \"type\": \"CATEGORY_NOT_FOUND\",\n \"message\": \"Category resource not found.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 620 }, "type": { "type": "string", "example": "ACCOUNT_NOT_FOUND" }, "message": { "type": "string", "example": "Account resource not found." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "409": { "description": "Conflict. The resource already exists or an equivalent operation is already in progress.", "content": { "application/json": { "examples": { "TRANSACTION_CATEGORY_SUMMARY_ALREADY_EXISTS": { "value": "{\n \"code\": 695,\n \"type\": \"TRANSACTION_CATEGORY_SUMMARY_ALREADY_EXISTS\",\n \"message\": \"Transaction category summary already exists.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 695 }, "type": { "type": "string", "example": "TRANSACTION_CATEGORY_SUMMARY_ALREADY_EXISTS" }, "message": { "type": "string", "example": "Transaction category summary already exists." }, "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 } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```