Pular para o conteúdo principal

Atualiza uma fatura (por cliente e data)

PUT /api/{userId}/establishment/{establishmentId}/invoices/{clientId}/{invoiceDateTime}

Atualiza campos específicos da fatura (valor, vencimento e/ou fechamento), respeitando validações de negócio e bloqueios quando a fatura já possui pagamento vinculado.

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador do cliente
invoiceDateTimestringIdentificador da fatura (no servidor o parâmetro de rota é date; valor igual ao invoiceDateTime retornado nas listagens)

Requisição

  • Método: PUT
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/invoices/\{clientId\}/\{invoiceDateTime\}
  • Headers: Authorization, Accept: application/json, Content-Type: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Corpo (JSON)

Nenhum campo é obrigatório; os omitidos preservam o valor já salvo na fatura.

CampoTipoDescrição
amountnumberValor da fatura
dueDateTimestringData/hora de vencimento
closingDateTimestringData/hora de fechamento

Restrições

  • Se a fatura possuir transactionId, a atualização é rejeitada (código de erro 06018).
  • Alterações de dueDateTime e closingDateTime estão sujeitas a validações de data (vencimento x fechamento, datas no passado, tipo de cliente, etc.) conforme implementação do servidor.

Formato da resposta (JSON)

  • Sucesso (HTTP 200): { "response": "success", "data": <payload> }
  • Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }
  • Não autorizado / permissão: Autorização

Exemplo de resposta (JSON)

Valores abaixo são ilustrativos; tipos e nomes de campos seguem o retorno real.

{
"response": "success",
"data": {
"establishmentId": 5637,
"clientId": "229420251201144512",
"invoiceDateTime": "20251201144512",
"registerDateTime": "2025-12-01 14:45:12",
"closingDateTime": "0001-01-01 00:00:00",
"dateTimeSequence": "2025-12-10 12:00:00",
"dueDateTime": "2025-12-10 12:00:00",
"paymentDateTime": "0001-01-01 00:00:00",
"amount": "312.75",
"closingAmount": "0.00",
"transactions": null,
"transactionId": null,
"userId": 6024,
"userOutputId": null,
"closingUserId": null,
"serviceContractId": null,
"observations": null,
"situationId": 1,
"lastSync": "2025-12-01 14:46:03",
"status": 1,
"clientName": "Fernando Duarte",
"clientDocument": null,
"clientEmail": "[email protected]",
"toleranceDays": null,
"vacancies": 3,
"penalty": "0.00",
"penaltyType": 1,
"paymentMethodId": null,
"amountReceived": 312.75,
"accountId": null,
"nfseStatus": null,
"rpsSeries": null,
"rpsNumber": null,
"nfseLink": null,
"clientTypeId": 2,
"userOutputName": null,
"closingUserName": null,
"opened": 0
}
}