Criar fatura
Cria uma nova fatura.
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.
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.
Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.
Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Body
Criar uma fatura
Responsável pelo pagamento. Pode ser um customer ou company.
Fundo que vai receber o pagamento.
Tipo do item da fatura.
pay_off, customer_recurring, company_recurring A data de vencimento da fatura.
Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.
Quando definido como true, executa o processo para finalizar a fatura no ato de criação, alterando o status para open ao final do processo. Se não informado ou definido como false, a fatura permanecerá com o status draft.
Sobrescrever configuração de desconto e multa no momento da criação dos itens da fatura. Este campo determina se, no momento da criação dos itens da fatura, descontos ou multas serão aplicados automaticamente aos itens de fatura enviados na requisição. Quando este campo é informado, o valor nele especificado substituirá o valor contido em settings.invoices[type].updateInvoiceItemOnInsert. É importante destacar que essa configuração apenas se aplica à requisição atual e não afetará as configurações existentes. Esse recurso foi desenvolvido com o propósito de substituir o parâmetro settings.invoices[type].updateInvoiceItemOnInsert pelo valor enviado na requisição.
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.
Response
Este objeto representa uma fatura.
Identificador exclusivo para o objeto.
Status da fatura
draft, open, paid, void, uncollectible 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 do item da fatura.
pay_off, customer_recurring, company_recurring 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.
Esta estrutura de dados descreve a auditoria das operações de criação de faturas (invoices).
Esta estrutura de dados descreve a auditoria das operações de alteração de faturas (invoices).