Marcar fatura como incobrável
Marca uma fatura como incobrável.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Chave única de idempotência para evitar duplicação de requisições.
Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.
Path Parameters
ID da fatura
Query Parameters
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.
Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.
Body
Erro ao salvar no parceiro
Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
Response
Identificador exclusivo para o objeto.
Status da fatura
draft
, open
, paid
, void
, uncollectible
, refunded
Responsável pelo pagamento. Pode ser um customer
ou company
.
Fundo que vai receber o pagamento.
A data de vencimento da fatura.
Valor devido.
Valor pago.
Valor restante.
Tipo da fatura
pay_off
, customer_recurring
, company_recurring
Propósito da fatura
cancellation
, customer_refinance
, employment_terminated
, external_collector
, no_funds
, regular
, requested_by_company
, requested_by_customer
, requested_by_insurance
Contém grupos de parcelas na fatura tanto para o pagamento, como para antecipação.
Representa um conjunto de intenções de pagamento.
Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.
Data de pagamento da fatura.
Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.
Data de criação do objeto
Data de alteração do objeto
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.