Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
invoices

Atualiza uma nota fiscal existente.

put/v1/invoices/{id}

Path parameters

idinteger required

ID da nota fiscal que deverá ser atualizada.

Request body

bodystring

JSON com os novos atributos da nota fiscal.

amountnumber

Valor da nota fiscal

scheduled_atstring

Data e hora do agendamento da nota fiscal no formato ISO 8601. Use nulo para emissão imediata

accrued_onstring

Data de competência da nota fiscal. Se não informada, será utilizada a data de agendamento. Caso a data de agendamento não exista, será utilizada a data atual

descriptionstring

Descrição que será exibida na nota fiscal. Se não informada, a configuração padrão da integração será usada

settings'metadata'

Configurações adicionais usadas na integração

Response

Nota fiscal atualizada 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