Excluir item da fatura

DELETE 
/v1/invoice-items/:invoice_item

Exclui um item da fatura. Não pode ser desfeito.

Request

Path Parameters

invoice_item stringrequired
ID do item da fatura
Example: item_5f92f01728e009f403d8502e

Query Parameters

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan
fields string

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.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Responses

200

Retorna um objeto com deleted em caso de sucesso; retorna erro se o ID do InvoiceItem não existir.

application/json

Schema

Schema

id string
ID do objeto removido
Example: obj_5f92f01728e009f403d8502e
deleted boolean
Identifica se o objeto foi removido
Example: true

Example (from schema)

{
  "id": "obj_5f92f01728e009f403d8502e",
  "deleted": true
}

Loading...