---
title: SCR
slug: scr
createdAt: 2023-04-24T13:20:56.000Z
---

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://sandbox.partner.graphql.gyramais.com.br/",
  "name": "Consulta mensal SCR",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "kind": "required",
        "name": "cpf",
        "type": "string",
        "children": [],
        "description": "CPF"
      },
      {
        "kind": "required",
        "name": "referenceMonth",
        "type": "string",
        "children": [],
        "description": "Mês de rerência para consulta"
      },
      {
        "kind": "required",
        "name": "referenceYear",
        "type": "string",
        "children": [],
        "description": "Ano de referência para consulta"
      }
    ],
    "headerParameters": [
      {
        "kind": "required",
        "name": "Authorization",
        "type": "string",
        "children": [],
        "description": "sessionToken"
      }
    ],
    "bodyDataParameters": [
      {
        "kind": "optional",
        "name": "id",
        "type": "string",
        "description": "Identificador único do objeto."
      },
      {
        "kind": "optional",
        "name": "cpf",
        "type": "string",
        "children": [],
        "description": "CPF"
      },
      {
        "kind": "optional",
        "name": "referenceMonth",
        "type": "string",
        "children": [],
        "description": "Mês de rerência para consulta"
      },
      {
        "kind": "optional",
        "name": "referenceYear",
        "type": "string",
        "children": [],
        "description": "Ano de referência para consulta"
      },
      {
        "kind": "optional",
        "name": "summary",
        "type": "Object",
        "children": [
          {
            "kind": "optional",
            "name": "amount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "totalResponsabilityAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "vendorIndirectRiskAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "institutionQuantity",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "transactionsQuantity",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "judicialTransactionsAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "judicialTransactionsQuantity",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "discordanceTransactionsAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "discordanceTransactionsQuantity",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount30Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount31to60Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount61to90Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount91to180Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmount181to360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmountMoreThan360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "toExpireAmountIndefinite",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount30Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount31to60Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount61to90Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount91to180Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmount181to360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "expiredAmountMoreThan360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "lossAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "lossAmountTo12Months",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "lossAmountMoreThan12Months",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "creditLimitAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "creditLimitAmount360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "creditLimitAmountMoreThan360Days",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "creditToReleaseAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "documentsProcessedPercertage",
            "type": "String",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "coObligationsAmount",
            "type": "Number",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "onLendingAmount",
            "type": "Number",
            "description": ""
          }
        ],
        "description": "Resumo das informações do cliente"
      },
      {
        "kind": "optional",
        "name": "transaction",
        "type": "Object",
        "description": "Resumo do Cliente por modalidades",
        "children": [
          {
            "kind": "optional",
            "name": "creditTypes",
            "type": "Object",
            "children": [
              {
                "kind": "optional",
                "name": "domain",
                "type": "string",
                "description": "Classificação do crédito"
              },
              {
                "kind": "optional",
                "name": "subdomain",
                "type": "string",
                "description": "Subclassificação do crédito"
              },
              {
                "kind": "optional",
                "name": "amount",
                "type": "Number",
                "description": "Valor"
              },
              {
                "kind": "optional",
                "name": "code",
                "type": "string",
                "description": "Código da classificação"
              },
              {
                "kind": "optional",
                "name": "type",
                "type": "string",
                "description": "Situação"
              }
            ],
            "description": ""
          },
          {
            "name": "overdues",
            "kind": "required",
            "type": "object",
            "description": "classificação por faixas",
            "children": [
              {
                "name": "domain",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "subdomain",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "amount ",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "tyoe",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ]
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "name": "creditTypes",
            "type": "Object",
            "children": [
              {
                "kind": "optional",
                "name": "domain",
                "type": "string",
                "description": "Classificação do crédito"
              },
              {
                "kind": "optional",
                "name": "subdomain",
                "type": "string",
                "description": "Subclassificação do crédito"
              },
              {
                "kind": "optional",
                "name": "amount",
                "type": "Number",
                "description": "Valor"
              },
              {
                "kind": "optional",
                "name": "code",
                "type": "string",
                "description": "Código da classificação"
              },
              {
                "kind": "optional",
                "name": "type",
                "type": "string",
                "description": "Situação"
              }
            ],
            "description": ""
          },
          {
            "name": "overdues",
            "kind": "required",
            "type": "object",
            "description": "classificação por faixas",
            "children": [
              {
                "name": "domain",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "subdomain",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "amount ",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "tyoe",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ]
          }
        ]
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "LEOgXngIreY6_v2dV-tbc",
        "code": "{\n\t\"data\": {\n\t\t\"integrationSCR\": {\n\t\t\t\"cpf\": \"26690709000150\",\n\t\t\t\"referenceMonth\": \"1\",\n\t\t\t\"referenceYear\": \"2025\",\n\t\t\t\"summary\": {\n\t\t\t\t\"amount\": 180582.3,\n\t\t\t\t\"totalResponsabilityAmount\": 180582.3,\n\t\t\t\t\"vendorIndirectRiskAmount\": 0,\n\t\t\t\t\"institutionQuantity\": 1,\n\t\t\t\t\"transactionsQuantity\": 1,\n\t\t\t\t\"judicialTransactionsAmount\": 0,\n\t\t\t\t\"judicialTransactionsQuantity\": 0,\n\t\t\t\t\"discordanceTransactionsAmount\": 0,\n\t\t\t\t\"discordanceTransactionsQuantity\": 0,\n\t\t\t\t\"toExpireAmount\": 88523.3,\n\t\t\t\t\"toExpireAmount30Days\": 8711.92,\n\t\t\t\t\"toExpireAmount31to60Days\": 8438.02,\n\t\t\t\t\"toExpireAmount61to90Days\": 8172.74,\n\t\t\t\t\"toExpireAmount91to180Days\": 23087.51,\n\t\t\t\t\"toExpireAmount181to360Days\": 40113.11,\n\t\t\t\t\"toExpireAmountMoreThan360Days\": 0,\n\t\t\t\t\"toExpireAmountIndefinite\": 0,\n\t\t\t\t\"expiredAmount\": 92059,\n\t\t\t\t\"expiredAmount30Days\": 8985.44,\n\t\t\t\t\"expiredAmount31to60Days\": 9277.11,\n\t\t\t\t\"expiredAmount61to90Days\": 9568.37,\n\t\t\t\t\"expiredAmount91to180Days\": 20078.59,\n\t\t\t\t\"expiredAmount181to360Days\": 44149.49,\n\t\t\t\t\"expiredAmountMoreThan360Days\": 0,\n\t\t\t\t\"lossAmount\": 0,\n\t\t\t\t\"lossAmountTo12Months\": 0,\n\t\t\t\t\"lossAmountMoreThan12Months\": 0,\n\t\t\t\t\"creditLimitAmount\": 0,\n\t\t\t\t\"creditLimitAmount360Days\": 0,\n\t\t\t\t\"creditLimitAmountMoreThan360Days\": 0,\n\t\t\t\t\"creditToReleaseAmount\": 0,\n\t\t\t\t\"documentsProcessedPercertage\": \"99.59\",\n\t\t\t\t\"coObligationsAmount\": 0,\n\t\t\t\t\"onLendingAmount\": 0,\n\t\t\t\t\"startRelationship\": \"2023-10-26\"\n\t\t\t},\n\t\t\t\"transactions\": [\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"Outros empréstimos\",\n\t\t\t\t\t\"amount\": 88523.3,\n\t\t\t\t\t\"code\": \"0299\",\n\t\t\t\t\t\"type\": \"A VENCER\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"Outros empréstimos\",\n\t\t\t\t\t\"amount\": 92059,\n\t\t\t\t\t\"code\": \"0299\",\n\t\t\t\t\t\"type\": \"VENCIDO\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"overdues\": [\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 8172.74,\n\t\t\t\t\t\"code\": \"v130\",\n\t\t\t\t\t\"type\": \"Créditos a vencer de 61 a 90 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 22768.3,\n\t\t\t\t\t\"code\": \"v260\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 241 a 300 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 9568.37,\n\t\t\t\t\t\"code\": \"v230\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 61 a 90 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 21381.19,\n\t\t\t\t\t\"code\": \"v255\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 181 a 240 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 40113.11,\n\t\t\t\t\t\"code\": \"v150\",\n\t\t\t\t\t\"type\": \"Créditos a vencer de 181 a 360 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 8438.02,\n\t\t\t\t\t\"code\": \"v120\",\n\t\t\t\t\t\"type\": \"Créditos a vencer de 31 a 60 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 10199.63,\n\t\t\t\t\t\"code\": \"v250\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 151 a 180 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 9277.11,\n\t\t\t\t\t\"code\": \"v220\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 31 a 60 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 9878.96,\n\t\t\t\t\t\"code\": \"v245\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 121 a 150 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 23087.51,\n\t\t\t\t\t\"code\": \"v140\",\n\t\t\t\t\t\"type\": \"Créditos a vencer de 91 a 180 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 8711.92,\n\t\t\t\t\t\"code\": \"v110\",\n\t\t\t\t\t\"type\": \"Créditos a vencer até 30 dias\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"domain\": \"Empréstimos\",\n\t\t\t\t\t\"subdomain\": \"outros empréstimos\",\n\t\t\t\t\t\"amount\": 8985.44,\n\t\t\t\t\t\"code\": \"v210\",\n\t\t\t\t\t\"type\": \"Créditos vencidos de 15 a 30 dias\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}\n}",
        "language": "200",
        "customLabel": ""
      },
      {
        "id": "I28daNCdTBDRGylQgcArT",
        "code": "{\n      \"message\": \"Ain't no cake like that.\"\n    }",
        "language": "404",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "LEOgXngIreY6_v2dV-tbc"
  },
  "examples": {
    "languages": [
      {
        "id": "6Un7QVG9WFVC1GMlgq-KQ",
        "code": "mutation integrationSCR {\n  integrationSCR (\n    cpf: \"26690709000150\"\n    referenceMonth: \"01\"\n    referenceYear: \"2025\"\n    ){\n    cpf\n    referenceMonth\n    referenceYear\n    summary{\n      amount\n      totalResponsabilityAmount\n      vendorIndirectRiskAmount\n      institutionQuantity\n      transactionsQuantity\n      judicialTransactionsAmount\n      judicialTransactionsQuantity\n      discordanceTransactionsAmount\n      discordanceTransactionsQuantity\n      toExpireAmount\n      toExpireAmount30Days\n      toExpireAmount31to60Days\n      toExpireAmount61to90Days\n      toExpireAmount91to180Days\n      toExpireAmount181to360Days\n      toExpireAmountMoreThan360Days\n      toExpireAmountIndefinite\n      expiredAmount\n      expiredAmount30Days\n      expiredAmount31to60Days\n      expiredAmount61to90Days\n      expiredAmount91to180Days\n      expiredAmount181to360Days\n      expiredAmountMoreThan360Days\n      lossAmount\n      lossAmountTo12Months\n      lossAmountMoreThan12Months\n      creditLimitAmount\n      creditLimitAmount360Days\n      creditLimitAmountMoreThan360Days\n      creditToReleaseAmount\n      documentsProcessedPercertage\n      coObligationsAmount\n      onLendingAmount\n      startRelationship\n    }\n    transactions{\n          domain\n          subdomain\n          amount\n          code\n          type\n      }\n\t\toverdues{\n          domain\n          subdomain\n          amount\n          code\n          type\n\t\t}\n\t}\n}",
        "language": "graphql",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "6Un7QVG9WFVC1GMlgq-KQ"
  },
  "description": "",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  }
}
```
:::