Credit-bureau reports
Listing a debtor with a credit bureau (Serasa, SPC, Boa Vista) over a charge. remove requests the removal of an active report, with a reason.
| Command | HTTP | Description |
|---|---|---|
negativations list | GET /v1/negativations | List bureau reports |
negativations create | POST /v1/negativations | Create bureau report |
negativations get | GET /v1/negativations/{id} | Get bureau report |
negativations update | PUT /v1/negativations/{id} | Update bureau report |
negativations delete | DELETE /v1/negativations/{id} | Delete bureau report |
negativations remove | POST /v1/negativations/{id}/remove | Request bureau report removal |
Examples​
--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.
# Active reports
kobana dunning negativations list \
--params '{"status": "active"}' \
--fields "id,person_id,charge_id,bureau,amount,registered_at"
# Report to Serasa
kobana dunning negativations create \
--json '{"person_id": "PERSON_ID", "charge_id": "CHARGE_ID", "bureau": "serasa", "amount": 150}'
# Request removal
kobana dunning negativations remove \
--params '{"id": "NEGATIVATION_ID"}' \
--json '{"removal_reason": "DÃvida quitada"}' --dry-run
Next steps​
- Protests
- Schema introspection — every parameter this resource accepts.