Pular para o conteúdo principal

Gestão CSC

As APIs aqui documentadas são responsáveis por possibilitar a gestão do CSC - Código de Segurança do Contribuinte. Este código é utilizado para emissão de NFC-e e deve ser cadastrado para cada UF que o emissor está estabelecido. 

Autenticação

Para utiliza as APIs de CSC é necessário realizar autenticação da Solução Autenticação da Solução

Importante

Ao cadastrar um CSC para um emissor cuja UF já tenha CSC cadastrado anteriormente. O CSC anterior será automaticamente inativado para todos emissores com a mesma raiz do CNPJ e UF. Caso o CSC cadastrado estiver incorreto isso irá afetar diretamente a emissão fazendo com que as notas sejam rejeitadas até o cadastro de um CSC correto.


Cadastro de CSC

  • Endpoint: /company/csc/create
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json 
TagDescriçãoObrig.
cnpjCNPJ do EmissorSim
ufUF responsável pelo CSCSim
TokenGovIdID do CSCSim
TokenToken do CSCSim

Exemplo Payload de Envio

{
"cnpj": "99999999999999",
"uf": "RS",
"TokenGovId": 2,
"Token": "19bexxd7-7x66-40xx-8x9x-de475xxbb41c"
}

Exemplo Payload de Retorno

{
"message": "CSC cadastrado com sucesso.",
"id": "df821ad8-7bb9-4afa-b2c6-5d80a516ba2e",
"tokenGovId": 2,
"token": "19bexxd7-7x66-40xx-8x9x-de475xxbb41c"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Atualização de CSC

  • Endpoint:  /company/csc/update
  • Método: POST
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json 
TagDescriçãoObrig.
idID retornado no cadastro do CSCSim
cnpjCNPJ do EmissorSim
ufUF responsável pelo CSCSim
TokenGovIdID do CSCSim
TokenToken do CSCNão

Exemplo Payload de Envio

{
"id": "df821ad8-7bb9-4afa-b2c6-5d80a516ba2e",
"cnpj": "00000001100009",
"uf": "RS",
"TokenGovId": 2,
"Token": "19beyyd7-7x66-40yy-8x9x-de475xxbb41c"
}

Exemplo Payload de Retorno

{
"message": " CSC atualizado com sucesso. ",
"id": "df821ad8-7bb9-4afa-b2c6-5d80a516ba2e",
"tokenGovId": 2,
"token": "19beyyd7-7x66-40yy-8x9x-de475xxbb41c"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Consulta de CSC Ativo

  • Endpoint:  /company/csc/active
  • Método: GET
  • Parâmetros:
    • uf: UF responsável pelo CSC
    • cnpj: CNPJ do emissor
  • Header:
    • Authorization: Token de autorização
    • Content-Type: application/json 

Exemplo Payload de Retorno

{
"message": " CSC atualizado com sucesso. ",
"id": "df821ad8-7bb9-4afa-b2c6-5d80a516ba2e",
"tokenGovId": 2,
"token": "19beyyd7-7x66-40yy-8x9x-de475xxbb41c"
}

Possíveis retornos HTTP

  • 200 - Sucesso
  • 400 – BadRequest
  • 401 - Unauthorized
  • 404 – NotFound
  • 429 - TooManyRequests
  • 500 - InternalServerError
  • 503 - Service Unavailable

Este conteúdo foi útil para você?