Skip to main content

Operation Query by Filters

This endpoint allows querying commercial paper operations using optional filters.


Request

ENDPOINT
/commercial_paper/operation
METHOD
GET

Query Params

FieldTypeDescriptionRequired
issuer_document_numberstringIssuer document number (CNPJ).No
investor_document_numberstringInvestor document number (CPF/CNPJ).No
operation_statusstringOperation status.operation_status enumerators
metadata_keyarrayMetadata key.No
metadata_valuearrayMetadata value.No

Response

STATUS
200
Response 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

FieldTypeDescriptionMax Characters
tenant_key *stringUnique tenant key (UUID v4).36
operation_key *stringUnique operation key (UUID v4).36
operation_type *stringOperation type. Will always be commercial_paper.50
operation_status *stringCurrent operation status.operation_status enumerators
backoffice_analysis_statusstringBackoffice analysis status.50
issuer_key *stringUnique key of the issuer associated with the operation (UUID v4).36
issuer_name *stringName of the issuer associated with the operation.255
issuer_document_number *stringIssuer document number (CNPJ).14
issue_number *integerIssue number associated with the operation.-
contract_number *stringContract number associated with the operation.20

Pagination Object

FieldTypeDescription
current_page *integerCurrent page of the query.
next_pageintegerNext page, if it exists.
rows_per_page *integerNumber of records per page.
total_pages *integerTotal pages available.
total_rows *integerTotal records found for the applied filters.

operation_status enumerators

EnumDescription
in_fillingOperation in filling phase.
in_analysisOperation under analysis.
waiting_onboarding_approvalWaiting for issuer onboarding approval.
pending_signature_submissionWaiting to be sent for signature.
waiting_signatureWaiting for signatures from involved parties.
issuedOperation issued.
finishedOperation completed.
signature_rejectedSignature rejected.
onboarding_reprovedIssuer onboarding rejected.
compliance_reprovedRejected by compliance.
canceledOperation canceled.