{
  "info": {
    "name": "RuralZap — API externa de leitura",
    "description": "Preencha baseUrl com a origem do RuralZap (sem /api/v1) e apiKey com sua chave, em um ambiente privado. Não publique a chave. Guia: /developers.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.finance.meyje.com.br",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string"
    }
  ],
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "item": [
    {
      "name": "Consultar contexto da integração",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/context",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "context"
          ],
          "query": []
        },
        "description": "A credencial determina o Space. x-space-id não seleciona nem amplia acesso."
      }
    },
    {
      "name": "Listar carteiras ativas",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/wallets",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "wallets"
          ],
          "query": []
        },
        "description": "Requer balances:read. Retorna referências financeiras mínimas, sem dados bancários privados."
      }
    },
    {
      "name": "Consultar saldos correntes",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/balances",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "balances"
          ],
          "query": []
        },
        "description": "Requer balances:read. Inclui saldo inicial, ajustes e liquidações; exclui pendentes, compras de cartão não pagas e carteiras arquivadas. Não é projeção nem saldo bancário em tempo real."
      }
    },
    {
      "name": "Consultar lançamentos por período",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/transactions?startDate=2026-01-01&endDate=2026-01-31",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "transactions"
          ],
          "query": [
            {
              "key": "startDate",
              "value": "2026-01-01",
              "disabled": false,
              "description": "Data financeira inicial inclusiva. Período máximo: 366 dias."
            },
            {
              "key": "endDate",
              "value": "2026-01-31",
              "disabled": false,
              "description": "Data financeira final inclusiva."
            },
            {
              "key": "walletId",
              "value": "",
              "disabled": true,
              "description": "Carteira do Space. Inclui transferências de entrada e saída dessa carteira."
            },
            {
              "key": "categoryId",
              "value": "",
              "disabled": true,
              "description": "Categoria do Space ou categoria compartilhada do seu reseller."
            },
            {
              "key": "costCenterId",
              "value": "",
              "disabled": true,
              "description": "Centro(s) de custo por UUID separado por vírgula ou UNCLASSIFIED. Em composições, deve corresponder à mesma parte da categoria e equipamento."
            },
            {
              "key": "assetId",
              "value": "",
              "disabled": true,
              "description": "Equipamento do Space atribuído à mesma parte da categoria e centro."
            },
            {
              "key": "type",
              "value": "",
              "disabled": true,
              "description": ""
            },
            {
              "key": "status",
              "value": "",
              "disabled": true,
              "description": ""
            },
            {
              "key": "limit",
              "value": "50",
              "disabled": true,
              "description": ""
            },
            {
              "key": "cursor",
              "value": "",
              "disabled": true,
              "description": "nextCursor da página anterior, mantendo todos os filtros e limite. Validade: 24 horas. Não representa snapshot nem sincronização incremental."
            }
          ]
        },
        "description": "Requer transactions:read. Ordem createdAt,id crescente. Até 100 itens; período obrigatório de até 366 dias. Inclui pendentes/cancelados, ajustes, transferências e pagamentos de fatura, com flags explícitas; exclui apagados. Não somar todos os lançamentos como receita/despesa: use os relatórios. Paginação não é snapshot; alterações/exclusões durante a travessia podem modificar resultados."
      }
    },
    {
      "name": "Consultar resumo financeiro realizado",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/reports/summary?startDate=2026-01-01&endDate=2026-01-31",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "reports",
            "summary"
          ],
          "query": [
            {
              "key": "startDate",
              "value": "2026-01-01",
              "disabled": false,
              "description": "Data financeira inicial inclusiva. Período máximo: 366 dias."
            },
            {
              "key": "endDate",
              "value": "2026-01-31",
              "disabled": false,
              "description": "Data financeira final inclusiva."
            },
            {
              "key": "walletId",
              "value": "",
              "disabled": true,
              "description": "Carteira do Space. Inclui transferências de entrada e saída dessa carteira."
            },
            {
              "key": "categoryId",
              "value": "",
              "disabled": true,
              "description": "Categoria do Space ou categoria compartilhada do seu reseller."
            },
            {
              "key": "costCenterId",
              "value": "",
              "disabled": true,
              "description": "Centro(s) de custo por UUID separado por vírgula ou UNCLASSIFIED. Em composições, deve corresponder à mesma parte da categoria e equipamento."
            },
            {
              "key": "assetId",
              "value": "",
              "disabled": true,
              "description": "Equipamento do Space atribuído à mesma parte da categoria e centro."
            },
            {
              "key": "groupBy",
              "value": "month",
              "disabled": true,
              "description": ""
            }
          ]
        },
        "description": "Resumo do fluxo de caixa; requer reports:read e CASHFLOW_REPORT. Segue regras do relatório do produto, incluindo abertura, ajustes e transferências externas da carteira selecionada. Moeda suportada: BRL."
      }
    },
    {
      "name": "Consultar fluxo de caixa realizado",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/reports/cashflow?startDate=2026-01-01&endDate=2026-01-31",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "reports",
            "cashflow"
          ],
          "query": [
            {
              "key": "startDate",
              "value": "2026-01-01",
              "disabled": false,
              "description": "Data financeira inicial inclusiva. Período máximo: 366 dias."
            },
            {
              "key": "endDate",
              "value": "2026-01-31",
              "disabled": false,
              "description": "Data financeira final inclusiva."
            },
            {
              "key": "walletId",
              "value": "",
              "disabled": true,
              "description": "Carteira do Space. Inclui transferências de entrada e saída dessa carteira."
            },
            {
              "key": "categoryId",
              "value": "",
              "disabled": true,
              "description": "Categoria do Space ou categoria compartilhada do seu reseller."
            },
            {
              "key": "costCenterId",
              "value": "",
              "disabled": true,
              "description": "Centro(s) de custo por UUID separado por vírgula ou UNCLASSIFIED. Em composições, deve corresponder à mesma parte da categoria e equipamento."
            },
            {
              "key": "assetId",
              "value": "",
              "disabled": true,
              "description": "Equipamento do Space atribuído à mesma parte da categoria e centro."
            },
            {
              "key": "groupBy",
              "value": "month",
              "disabled": true,
              "description": ""
            }
          ]
        },
        "description": "Requer reports:read e CASHFLOW_REPORT. Período máximo 366 dias. Mesmo cálculo do relatório do produto, com valores decimais exatos. groupBy: day, week ou month. Não inclui projeções de pendentes."
      }
    }
  ]
}
