AnexosVincular Comprovante ou Nota Fiscal

Vincular Comprovante ou Nota Fiscal

Cria um registro de anexo vinculado a uma transação e retorna uma URL pré-assinada para upload direto ao S3.

Fluxo de 2 etapas:

  1. Chame este endpoint com os metadados do arquivo e o ID da transação — retorna o id do anexo e a uploadUrl.
  2. Faça um PUT para a uploadUrl com o binário do arquivo diretamente ao S3 (sem passar pela API).

O id retornado pode ser usado no Download de Anexo após o upload concluir.

Idempotência: este endpoint não suporta o header Idempotency-Key. Cada chamada cria um novo registro de anexo — uma transação pode ter múltiplos anexos vinculados.

curl -X POST "https://api-sandbox.contasimples.com/attachments/v1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "transactionId": "111304",
  "file": {
    "name": "nota-fiscal.pdf",
    "contentType": "PDF"
  },
  "description": "Nota fiscal referente à compra"
}'
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PROCESSING",
  "referenceId": "111304",
  "file": {
    "name": "nota-fiscal.pdf",
    "contentType": "PDF"
  },
  "description": "Nota fiscal referente à compra",
  "createdAt": "2026-06-25T22:54:52.000Z",
  "uploadUrl": "https://s3.amazonaws.com/bucket/key?X-Amz-Signature=..."
}
POST
/attachments/v1
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
Content-Typestring
Required

The media type of the request body

Options: application/json
transactionIdstring
Required

ID da transação à qual o documento será vinculado. Corresponde ao campo id retornado pelo Extrato Bancário (numérico — envie o valor como string) ou pelo Extrato de Cartão (ULID).

descriptionstring

Descrição do documento (opcional).

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Body

application/json
transactionIdstring
Required

ID da transação à qual o documento será vinculado. Corresponde ao campo id retornado pelo Extrato Bancário (numérico — envie o valor como string) ou pelo Extrato de Cartão (ULID).

Example:
111304
fileobject
Required
descriptionstring

Descrição do documento (opcional).

Example:
Nota fiscal referente à compra

Responses