ContractPlus APIs | Retornar os anexos contratuais
2 min
Criado por Lucas Daniel Natal do Couto em 06/02/2025 15:00
Atualizado por Eduardo Martins Dos Santos em 15/05/2025 11:56

Dúvida

Retornar anexos do contrato
api/DocumentAttachments/{contractType}/{attachmentStatus}/{contractStatus}

Esta api retorna todos os anexos de contratos da base, são utilizados parâmetros para filtrar a pesquisa.

Inserção obrigatória
contractType

1  -  Compras

2  -  Vendas

attachmentStatus

1  -  Aberto

2  -  Enviado

3  -  Assinado

contractStatus

0  -  Não Definido

1  -  Pendente de Aprovação

2  -  Aprovado

3  -  Reprovado

4  -  Ativo

5  -  Cancelado

6  -  Encerrado

7  -  Pagamento Provisionado

8  -  Bloqueado

9  -  Pendente de Correção

10 - Distratado


Para utilizar basta acessar a api abaixo e preencher com os parâmetros desejados, no exemplo abaixo vamos buscar anexos de contratos de vendas pendentes de aprovação e com anexos com status em aberto:

Campos retornados:

Anexos-->

ContractId- Id do contrato
AlternateNumber- Número alternativo do contrato
ContractDocumentId- Id do Documento
Description- Descrição do Documento
AttachmentId- Id do Anexo
Status- Status do anexo

Archive--> Arquivo

ArchiveId- Id do Arquivo

Como consultar meu anexo pelo ArchiveId?
Para realizar a consulta do anexo através do ArchiveId, utilize a API: /api/DocumentAttachments/GetDocumentAttachment/{archiveId} onde deverá ser preenchido o ArchiveId retornado pela API: api/DocumentAttachments/{contractType}/{attachmentStatus}/{contractStatus}

Ao executa-la, será retornado o anexo em formato base64.


Este anexo em questão se refere ao anexo do contrato:

O que fazer caso meu arquivo base64 não for demonstrado? (POSTMAN)
Caso o arquivo em base64 da API: /api/DocumentAttachments/GetDocumentAttachment/{archiveId} não for apresentado ou emitir o erro "Maximum response size reached", será necessário realizar uma configuração adicional ao Postman.
1° Com o Postman aberto, selecione o menú de configurações (Engrenagem).
2° Selecione "Settings"
3° Na aba "General", localize a opção "Max response size" e a preencha para um valor entre 100MB e 150MB.Feito esse passo a passo, seu arquivo base64 será demonstrado.
Este artigo foi útil para você?
Últimos artigos visitados