Atualizar definições de um documento da cobrança

Endpoint responsável por atualizar as definições de um documento já anexado a uma cobrança.

Essa chamada permite alterar o tipo do documento e também a regra de disponibilização do arquivo para o pagador, sem necessidade de realizar um novo upload.

Parâmetros principais da requisição

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

  • documentId: Identificador único do documento vinculado à cobrança.

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

    • true: o arquivo só poderá ser acessado após o pagamento
    • false: o arquivo poderá ser acessado independentemente do pagamento
  • type: Novo tipo do documento. Os valores possíveis são:

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

Comportamento da atualização

Essa operação altera apenas as definições do documento já existente. O arquivo em si não é substituído por esta chamada.

Esse endpoint é útil para corrigir classificações incorretas ou ajustar a regra de acesso do pagador após a criação inicial do documento.


Quando utilizar

Utilize este endpoint quando for necessário:

  • corrigir o tipo de um documento já anexado
  • alterar a regra de disponibilização após o pagamento
  • ajustar a configuração de acesso sem reenviar o arquivo

Próximo passo no fluxo

Após a atualização, sua aplicação pode:

  • consultar novamente o documento
  • listar os documentos da cobrança para validar a alteração
  • seguir com o fluxo normal da cobrança
Path Params
string
required
string
required
Body Params
boolean
required
string
enum
required
Allowed:
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json