Get what a document's file needs

Returns the contract: every set the file carries, every field of it, its type, whether it is required and how it is formatted. It is what a client reads to understand what they are mapping, and it is curated — never uploaded.

GET /v1/regulatory/documents/{documentId}/contract

Get what a document's file needs

cURL

curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}/contract \
  --header 'Authorization: Bearer <token>'

200

{
  "calendar": {
    "from": "2025-01-01",
    "nonBusinessDays": [
      {
        "date": "2026-11-02",
        "description": "Finados"
      }
    ],
    "until": "2027-12-31",
    "weekends": true
  },
  "datasets": [
    {
      "consolidation": {
        "columns": {},
        "key": [
          "code"
        ],
        "whenKeyRepeats": "combine"
      },
      "fields": [
        {
          "name": "saldo",
          "required": true,
          "type": "decimal",
          "checkDigit": "cnpj",
          "description": "<string>",
          "domain": [
            "<string>"
          ],
          "expects": "<string>",
          "format": {
            "scaleDeclared": true,
            "scaleIsExact": true,
            "decimalSeparator": "<string>",
            "groupSeparator": "<string>",
            "pattern": "<string>",
            "scale": 123
          },
          "identifiesInstitution": "true",
          "length": 123,
          "means": "<string>",
          "normalize": "<string>",
          "pattern": "<string>",
          "prefixOf": "cnpj"
        }
      ],
      "grain": {
        "singleton": true,
        "keys": [
          "<string>"
        ]
      },
      "name": "cosif_balances",
      "childOf": {
        "dataset": "<string>"
      },
      "description": "<string>",
      "means": "<string>",
      "rowSet": {
        "columns": [
          "<string>"
        ],
        "key": "<string>",
        "rows": [
          {}
        ]
      }
    }
  ],
  "filing": {
    "period": [
      "dataBase"
    ],
    "remittance": {
      "original": "I",
      "parameter": "tipoRemessa",
      "replacement": "S"
    }
  },
  "knownGaps": [
    {
      "id": "<string>",
      "description": "<string>"
    }
  ],
  "metadata": {
    "appliesTo": {
      "institutionTypes": [
        "<string>"
      ]
    },
    "id": "br.bcb.cadoc-4010",
    "country": "BR",
    "document": "4010",
    "family": "cadoc",
    "layout": {
      "mandatoryFrom": "2026-01-01",
      "version": "<string>"
    },
    "output": "xml",
    "periodicity": "monthly",
    "regulator": "BCB",
    "status": "stable",
    "summary": "<string>",
    "title": "Balancete Patrimonial Analítico",
    "version": "1.0.0"
  },
  "parameters": [
    {
      "allowedMonths": [
        "<string>"
      ],
      "businessDay": true,
      "closed": true,
      "default": "<string>",
      "domain": [
        "<string>"
      ],
      "name": "dataBase",
      "required": true,
      "type": "month",
      "description": "<string>"
    }
  ],
  "reportTimezone": "America/Sao_Paulo",
  "rules": [
    {
      "id": "<string>",
      "appliesTo": "<string>",
      "does": {
        "kind": "negateWhen",
        "equals": "debit",
        "field": "saldo",
        "fields": [
          "cosifCode"
        ],
        "key": "cosifCode",
        "rowSet": "contas.yaml",
        "table": "natureza",
        "values": [
          "<string>"
        ]
      },
      "message": "<string>",
      "severity": "error",
      "where": {
        "equals": "<string>",
        "field": "<string>",
        "in": [
          "<string>"
        ],
        "notIn": [
          "<string>"
        ],
        "rowSet": "<string>"
      }
    }
  ],
  "tables": [
    {
      "from": "natureza.yaml",
      "match": "longestPrefix",
      "name": "natureza"
    }
  ],
  "apiVersion": "reporter.lerian.io/v1alpha1",
  "kind": "DocumentContract"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

documentId · string · requerido

Document identifier, as the catalog publishes it.

Respuesta

200

application/json

OK

calendar · object · requerido

Business-day calendar the document is filed by, from the subscription's pinned copy. Null when the contract declares none.

Show child attributes

datasets · object[] | null · requerido

Every set the file carries and every field of it.

Show child attributes

filing · object · requerido

What makes two generations the same filing and which remittance is the original, as the contract declares it. Null when the contract declares no filing block.

Show child attributes

knownGaps · object[] | null · requerido

What this contract knowingly does not yet cover.

Show child attributes

metadata · object · requerido

Which obligation this is, at which version.

Show child attributes

parameters · object[] | null · requerido

What the generation must be told, answered per request.

Show child attributes

reportTimezone · string · requerido

IANA time zone whose calendar decides when a period has closed (REPORT_TIMEZONE).

Ejemplo:

"America/Sao_Paulo"

rules · object[] | null · requerido

Every rule of the document: what the engine transforms and checks.

Show child attributes

tables · object[] | null · requerido

Lookup tables published beside the contract, which its rules read.

Show child attributes

apiVersion · string

Format identifier of the contract document.

Ejemplo:

"reporter.lerian.io/v1alpha1"

kind · string

Document kind; always DocumentContract.

Ejemplo:

"DocumentContract"