Operation Query by Filters
This endpoint allows querying commercial paper operations using optional filters.
Request
ENDPOINT
/commercial_paper/operationMETHOD
GETQuery Params
| Field | Type | Description | Required |
|---|---|---|---|
issuer_document_number | string | Issuer document number (CNPJ). | No |
investor_document_number | string | Investor document number (CPF/CNPJ). | No |
operation_status | string | Operation status. | operation_status enumerators |
metadata_key | array | Metadata key. | No |
metadata_value | array | Metadata value. | No |
Response
STATUS
200Response Body
{
"data": [
{
"tenant_key": "13edaf06-9810-4689-b00b-2367274d1a14",
"operation_key": "34bc5da7-89df-467d-93af-ed25184ab72e",
"operation_type": "commercial_paper",
"operation_status": "in_filling",
"backoffice_analysis_status": "waiting_submission_for_analysis",
"issuer_key": "7fbe9f89-b9ca-4445-85ac-6098da86bb56",
"issuer_name": "Global Networks",
"issuer_document_number": "73364815000123",
"issue_number": 1,
"contract_number": "0000000004"
},
{
"tenant_key": "13edaf06-9810-4689-b00b-2367274d1a14",
"operation_key": "f456ee66-5844-4ebc-b69d-365ce6df7138",
"operation_type": "commercial_paper",
"operation_status": "in_filling",
"backoffice_analysis_status": "waiting_submission_for_analysis",
"issuer_key": "7fbe9f89-b9ca-4445-85ac-6098da86bb56",
"issuer_name": "Global Networks",
"issuer_document_number": "73364815000123",
"issue_number": 2,
"contract_number": "0000000005"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100,
"total_pages": 1,
"total_rows": 2
}
}
Response Body Params
Data Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
tenant_key * | string | Unique tenant key (UUID v4). | 36 |
operation_key * | string | Unique operation key (UUID v4). | 36 |
operation_type * | string | Operation type. Will always be commercial_paper. | 50 |
operation_status * | string | Current operation status. | operation_status enumerators |
backoffice_analysis_status | string | Backoffice analysis status. | 50 |
issuer_key * | string | Unique key of the issuer associated with the operation (UUID v4). | 36 |
issuer_name * | string | Name of the issuer associated with the operation. | 255 |
issuer_document_number * | string | Issuer document number (CNPJ). | 14 |
issue_number * | integer | Issue number associated with the operation. | - |
contract_number * | string | Contract number associated with the operation. | 20 |
Pagination Object
| Field | Type | Description |
|---|---|---|
current_page * | integer | Current page of the query. |
next_page | integer | Next page, if it exists. |
rows_per_page * | integer | Number of records per page. |
total_pages * | integer | Total pages available. |
total_rows * | integer | Total records found for the applied filters. |
operation_status enumerators
| Enum | Description |
|---|---|
in_filling | Operation in filling phase. |
in_analysis | Operation under analysis. |
waiting_onboarding_approval | Waiting for issuer onboarding approval. |
pending_signature_submission | Waiting to be sent for signature. |
waiting_signature | Waiting for signatures from involved parties. |
issued | Operation issued. |
finished | Operation completed. |
signature_rejected | Signature rejected. |
onboarding_reproved | Issuer onboarding rejected. |
compliance_reproved | Rejected by compliance. |
canceled | Operation canceled. |