Permite atualizar informações de um recebimento agendado existente, utilizando o ID do agendamento.
Exemplo do Corpo da Requisição
A requisição deve incluir um JSON no corpo (body) com os seguintes campos:
{
"stakeholderId": "1f4d5c78-7f34-4c9f-91c3-6d53728c35a5",
"description": "Recebimento de Fatura",
"reference": "FAT-20240806-02",
"scheduleDate": "2024-12-31",
"dueDate": "2024-12-31",
"accrualDate": "2024-08-15",
"categories": [
{
"categoryId": "a4c567a1-3b88-4a9f-b68c-e22356b34a6d",
"value": 500.0,
"description": "Serviços de TI"
}
],
"costCenterValueType": 1,
"costCenters": [
{
"costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823",
"percent": 100,
"description": "Centro de Custo Principal"
}
],
"collection": {
"enabled": true,
"daysBeforeScheduleDateToGenerateEntryPromise": 2,
"deliveryType": 0
},
"isFlagged": true
}
Neste exemplo:
-
stakeholderId: identificador do contato(cliente) relacionado ao recebimento.
-
reference: "FAT-20240806-02" referência para o recebimento.
-
scheduleDate: Data prevista para o recebimento.
-
dueDate: Data de vencimento do recebimento.
-
accrualDate: Data de competência.
-
isFlagged: Habilitar como favorito.
-
collection: Automação de boleto
- enabled: Define se a automação do boleto está ativada ou desativada.
- daysBeforeScheduleDateToGenerateEntryPromise: Quantidade de dias antes da data de vencimento (dueDate) para gerar o boleto.
Exemplo: 2 indica que o boleto será gerado 2 dias antes da data de vencimento. Se o valor for 0, o boleto será enviado imediatamente. - deliveryType: Define o tipo de envio do boleto.
0: Envio por e-mail do contato(cliente)
1: Envio para a integração do contador.
-
categories: Lista de categorias relacionada ao recebimento, com categoryId, valor e descrição. Se o rateio estiver habilitado, poderá ser passado mais de uma categoria na lista de categories. Neste caso, cada item na lista representará uma parte do valor total, com a soma dos valores correspondendo ao valor total a receber. Se o rateio não estiver habilitado, você deve passar apenas uma categoria na lista de categories.
-
costCenterValueType: Tipo de valor do centro de custo (0 por valor, 1 para porcentagem).
-
Observações sobre o uso de Centros de Custo:
A lista de costCenters funciona da mesma forma que a de categories. Se o rateio estiver habilitado na empresa, você poderá passar uma lista com vários centros de custo, especificando a porcentagem ou o valor para cada um, dependendo do costCenterValueType que foi definido. Se o rateio não estiver habilitado, poderá ser enviado apenas um centro de custo na lista.-
Por porcentagem (costCenterValueType: 1): Cada centro de custo deve ter a porcentagem correspondente atribuída.
{ "costCenterValueType": 1, // por porcentagem "costCenters": [ { "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823", "percent-":100 } ]
-
Por valor (costCenterValueType: 0): Cada centro de custo deve ter o valor correspondente atribuído.
{ "costCenterValueType": 0, // por valor "costCenters": [ { "costCenterId": "3e12a6b9-8f19-4e2b-a2d1-b6a4f895d823", "value": 500 } ] }
Observação: Todos os campos presentes no body de criação são obrigatórios a serem enviados na edição para garantir a integridade dos dados do cliente. Certifique-se de enviar todas as informações, mesmo que não tenham sido alteradas. Se algum campo for omitido, ele será substituído pelo valor padrão.
-