Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
bills

Gera notas fiscais de uma fatura através do ID.

Utilize esta operação para gerar notas fiscais a partir de uma fatura existente. Para isso é necessário que exista uma integração do tipo nota fiscal ativada e a fatura ainda não possua nenhuma nota fiscal gerada.

Múltiplas notas fiscais poderão ser geradas caso você esteja usando configurações com esta finalidade, como por exemplo, a nota fiscal fracionada.

Caso seja necessário emitir notas fiscais avulsas com configurações específicas, utilize o método POST /invoices.

post/v1/bills/{id}/invoice

Path parameters

idinteger required

ID da fatura que irá gerar as notas fiscais.

Response

Notas fiscais geradas com sucesso.

idinteger required

ID da nota fiscal

amountnumber required

Valor da nota fiscal

status'processing' | 'success' | 'failure' | 'canceled' | 'waiting' | 'processing_cancel' | 'cancel_failure' | 'scheduled' required

Status da nota fiscal

integration_invoice_idstring required

Código externo da integração

integration_referencestring required

Número ou referência da nota fiscal na instituição governamental

print_urlstring

URL para impressão da nota fiscal

descriptionstring

Descrição usada para a geração nota fiscal. Se não informada, a configuração padrão da integração será usada

settingsstring

Configurações adicionais usadas na integração

issued_atstring

Data e hora da emissão da nota fiscal

accrued_onstring

Data de competência da nota fiscal

scheduled_atstring

Data e hora do agendamento da nota fiscal

created_atstring required

Data e hora da geração da nota fiscal

updated_atstring required

Data e hora da última atualização da nota fiscal