Consulta de Operações por Filtros
Este endpoint permite consultar operações de nota comercial utilizando filtros opcionais.
Request
ENDPOINT
/commercial_paper/operationMÉTODO
GETQuery Params
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
issuer_document_number | string | Número do documento do emissor (CNPJ). | Não |
investor_document_number | string | Número do documento do investidor (CPF/CNPJ). | Não |
operation_status | string | Status da operação. | Enumeradores operation_status |
metadata_key | array | Chave de metadado. | Não |
metadata_value | array | Valor de metadado. | Não |
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
Objeto Data
Campo | Tipo | Descrição | Caracteres Máx. |
---|---|---|---|
tenant_key * | string | Chave única do tenant (UUID v4). | 36 |
operation_key * | string | Chave única da operação (UUID v4). | 36 |
operation_type * | string | Tipo da operação. Sempre será commercial_paper . | 50 |
operation_status * | string | Status atual da operação. | Enumeradores operation_status |
backoffice_analysis_status | string | Status da análise de backoffice. | 50 |
issuer_key * | string | Chave única do emissor associado à operação (UUID v4). | 36 |
issuer_name * | string | Nome do emissor associado à operação. | 255 |
issuer_document_number * | string | Número do documento do emissor (CNPJ). | 14 |
issue_number * | integer | Número da emissão associada à operação. | - |
contract_number * | string | Número do contrato associado à operação. | 20 |
Objeto Pagination
Campo | Tipo | Descrição |
---|---|---|
current_page * | integer | Página atual da consulta. |
next_page | integer | Próxima página, caso exista. |
rows_per_page * | integer | Número de registros por página. |
total_pages * | integer | Total de páginas disponíveis. |
total_rows * | integer | Total de registros encontrados para os filtros aplicados. |
Enumeradores operation_status
Enum | Descrição |
---|---|
in_filling | Operação em fase de preenchimento. |
in_analysis | Operação em análise. |
waiting_onboarding_approval | Aguardando aprovação do onboarding do emissor. |
pending_signature_submission | Aguardando envio para assinatura. |
waiting_signature | Aguardando assinaturas dos envolvidos. |
issued | Operação emitida. |
finished | Operação concluída. |
signature_rejected | Assinatura rejeitada. |
onboarding_reproved | Onboarding do emissor reprovado. |
compliance_reproved | Reprovado por compliance. |
canceled | Operação cancelada. |