13.12. Inserir Instrumento de Cobrança de um Contrato/Empenho

Serviço que permite incluir um instrumento de cobrança de um contrato/empenho. Este serviço será acionado por qualquer plataforma digital credenciada.

13.12.1. Detalhes da Requisição

Endpoint	Método HTTP
/v1/orgaos/{cnpj}/contratos/{ano}/{sequencialContra-to}/instrumentocobranca	POST

13.12.2. Exemplo de Payload

      {
              "tipoInstrumentoCobrancaId": 1,
              "numeroInstrumentoCobranca": "01",
              "chaveNFe": "string",
              "dataEmissaoDocumento": "2025-01-10",
              "observacao": "Nota fiscal do empenho"
      }

13.12.3. Exemplo Requisição (cURL)

      curl -k -X POST \
        "${BASE_URL}/v1/orgaos/10000000000003/contratos/2025/1/instrumentocobranca" \
        -H "Authorization: Bearer access_token" \
        -H "Accept: */*" \
        -H "Content-Type: application/json" \
        --data "@/home/objeto.json"

13.12.4. Dados de entrada

Id	Campo	Tipo	Obrigatório	Descrição
1	cnpj	Texto (14)	Sim	CNPJ do órgão do contrato/empenho
2	ano	Inteiro	Sim	Ano do contrato/empenho
3	sequencialContrato	Inteiro	Sim	Número sequencial do contrato/empenho (gerado pelo PNCP no momento da inclusão)
4	tipoInstrumentoCobrancaId	Inteiro	Sim	Código da tabela de domínio Tipo de Instrumento de Cobrança
5	numeroInstrumentoCobranca	Texto (50)	Não	Número do instrumento de cobrança do contrato ou empenho
6	chaveNFe	Texto (50)	Não	Chave da Nota Fiscal quando o instrumento de cobrança for do tipo “Nota Fiscal”
7	dataEmissaoDocumento	Data	Não	Data de emissão do instrumento de cobrança
8	observacao	Texto (2048)	Não	Observação opcional sobre o instrumento de cobrança

13.12.5. Dados de retorno

Id	Campo	Tipo	Obrigatório	Descrição
1	location	Texto (255)	Sim	Endereço HTTP do recurso criado

13.12.6. Códigos de Retorno

Código HTTP	Mensagem	Tipo
200	Created	Sucesso
400	BadRequest	Erro
401	Unauthorized	Erro
422	Unprocessable Entity	Erro
500	Internal Server Error	Erro