| Evento | Descrição |
|---|
| bill_created | Pagamento programado |
| bill_approved | Pagamento aprovado |
| bill_approval_undone | Aprovação de pagamento desfeita |
| bill_conciliated | Pagamento conciliado com o contexto bancário |
| bill_unconciliated | Conciliação de pagamento desfeita de forma manual |
| bill_deleted | Pagamento deletado |
| bill_payment_receipt_added | Anexo adicionado |
| Evento | Descrição |
|---|
| receivable_created | Recebimento programado |
| receivable_conciliated | Recebimento conciliado com o contexto bancário |
| receivable_unconciliated | Conciliação de recebimento desfeita de forma manual |
| receivable_deleted | Recebimento deletadoo |
Importante: o formato de cada payload pode variar dependendo do contexto do evento e entidade.
{
"id": "outgoing_event_adt3o5d4p5cjzo",
"object": "outgoing_event",
"event": "bill_conciliated",
"payload": {
"account_id": "account_rbd3ig4qkbwzoxd4q",
"amount": 1000,
"approval_type": "any",
"assignees": [
{
"email": "[email protected]",
"id": "user_ff3mwexhuvhiuuqhm",
"name": "User name",
"object": "user",
"status": "active"
}
],
"attachments": [
{
"id": "attachment_2uirlgz6orclbpwckxlv3f3gcm",
"name": "relatorio.pdf",
"object": "attachment",
"type": "application/pdf"
}
],
"category_id": "category_vbemmoyfu6mozbr6fu",
"classifications": [
{
"classification_id": "classification_4b76woy74nihoi",
"labels_ids": ["label_6zgsv6yud6a6vb6laea"],
"object": "classification"
},
{
"classification_id": "classification_wfxfkbvb",
"labels_ids": ["label_pzevwnger"],
"object": "classification"
}
],
"contact_id": "contact_itg2divyauvx3sqy5u",
"date": "2023-11-29",
"description": "Descrição",
"external_id": null,
"id": "bill_g6tmyaq3gqbd6av31qle",
"object": "bill",
"observations": null,
"payment_method": {
"detail": {"pix_key": "00000000000", "pix_type": "cpf"},
"type": "pix"
},
"relevant_date": "2024-06-01"
},
"happened_at": "2024-06-12T19:35:54.883381Z"
}
{
"id": "outgoing_event_2jwilphhi5ayhenoy",
"object": "outgoing_event",
"event": "receivable_created",
"payload": {
"account_id": "account_wverbcbks33krvtywljw",
"amount": 10000,
"attachments": [
{
"id": "attachment_2uirlgz6orclbpwckxlv3f3gcm",
"name": "relatorio.pdf",
"object": "attachment",
"type": "application/pdf"
}
],
"category_id": "category_t7eezch5hpsdukcgejjre",
"classifications": [
{
"classification_id": "classification_4a76why7mndcxmihoi",
"labels_ids": ["label_tpgvs3ns2ffsci4lm"],
"object": "classification"
},
{
"classification_id": "classification_4wfxzrfxbvb3jxwj5jq",
"labels_ids": ["label_gbrxwfvjguehabjgyemre"],
"object": "classification"
}
],
"contact_id": "contact_4wem7myjlvbw3f21gqm",
"date": "2024-04-11",
"description": "Descrição",
"external_id": null,
"id": "receivable_hwhbtmzr2cjtn",
"object": "receivable",
"observations": null,
"relevant_date": "2024-03-01"
},
"happened_at": "2024-06-12T19:35:54.883381Z"
}
| Campo | Tipo | Descrição |
|---|
| event | String | Evento que acionou o envio do webhook |
| account_id | String | Identificador único da conta |
| account_number | String | Número da conta |
| branch_number | String | Número da agência |
| routing_number | String | Código identificador do banco (COMPE) |
| amount | Integer | Valor de entrada ou saída |
| category_id | String | Identificador único da categoria |
| classifications | ArrayObjects | Informações sobre classificações e etiquetas |
| contact_id | String | Identificador único do contato |
| date | Date | Data de pagamento ou de recebimento |
| description | String | Descrição |
| external_id | String | Identificador opicional de correlação |
| id | String | Identificador único do pagamento ou recebimento |
| observations | String | Observações |
| payment_method | Object | Informações sobre o método de pamento (pix, boleto) |
| relevant_date | Date | Data relacionada ao mês de competência |
| happened_at | Date | Data que ocorreu o evento |
