Endpoint responsável por anexar um documento a uma cobrança existente.

O arquivo enviado por esta chamada fica vinculado à cobrança e pode ser disponibilizado ao pagador diretamente na fatura Asaas para download. Esse recurso é útil quando a cobrança precisa incluir materiais complementares, como contrato, nota, planilha, mídia ou outros arquivos relacionados à transação.

Parâmetros principais da requisição

• id: Identificador único da cobrança no Asaas.

• availableAfterPayment: Define quando o documento ficará disponível para o pagador.

  • true: o arquivo só poderá ser acessado após a confirmação do pagamento
  • false: o arquivo poderá ser acessado independentemente do pagamento

• type: Tipo do documento enviado. Os valores possíveis são:

  • INVOICE
  • CONTRACT
  • MEDIA
  • DOCUMENT
  • SPREADSHEET
  • PROGRAM
  • OTHER

• file: Arquivo que será anexado à cobrança.

Comportamento do upload

Ao concluir a chamada com sucesso, o documento passa a ficar vinculado à cobrança informada e poderá ser recuperado posteriormente pela listagem ou pela consulta individual.

A configuração de availableAfterPayment afeta diretamente a experiência do pagador no acesso ao arquivo. Essa definição deve ser feita de acordo com a regra de negócio da integração.

Quando utilizar

Utilize este endpoint quando for necessário:

• anexar documentos complementares a uma cobrança
• disponibilizar contratos, notas, planilhas ou mídias ao pagador
• controlar se o acesso ao documento deve ocorrer antes ou somente após o pagamento

Próximo passo no fluxo

Após o upload do documento, sua aplicação pode:

• listar os documentos vinculados à cobrança
• consultar um documento específico
• atualizar as definições do documento
• excluir o documento, se necessário