v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
invoices

Retorna uma nota fiscal específica através do ID.

get/v1/invoices/{id}

Path parameters

idinteger required

ID da nota fiscal que deverá ser retornada.

Response

Ok. Nota fiscal encontrada.

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