Operação de CCB (Auth : x-api-token)

Operação de CCB (Auth : x-api-token)

application/json

text/json

application/*+json

Request Body

Dados da CCB

batchName string nullable

Nome do evento

controlNumber string nullable

Número de Controle

terms object[] nullable
Termos
Array [
eDocumentType int32
Possible values: [1, 2, 3, 4, 5, 6, 99]
Tipo de Documento 1 = Termo 2 = Contrato Mãe 3 = Duplicata 4 = Promissária 5 = CCB 6 = Contrato 99 = Outros
documentName string nullable
Nome do Documento
path string nullable
Path/Url
identifier string nullable
Identificador
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Número de telefone
name string nullable
Nome do assinante
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
]
bankCreditNotes object[] nullable
Dados de CCBs
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
issuerVatNumber string nullable
Numero de Documento do Emitente
sendToSignature boolean
Se deve ser enviada para fluxo de assinatura/certificação
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
installments object[] nullable
Parcelas de CCB
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
]
]
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Numero de telefone
name string nullable
Nome
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
webhook object

headerName string nullable

Nome da Chave, Exemplo: api-token

headerValue string nullable

Valor da Chave

webhookUrl string nullable

Url do Webhook

Request Body

Dados da CCB

batchName string nullable

Nome do evento

controlNumber string nullable

Número de Controle

terms object[] nullable
Termos
Array [
eDocumentType int32
Possible values: [1, 2, 3, 4, 5, 6, 99]
Tipo de Documento 1 = Termo 2 = Contrato Mãe 3 = Duplicata 4 = Promissária 5 = CCB 6 = Contrato 99 = Outros
documentName string nullable
Nome do Documento
path string nullable
Path/Url
identifier string nullable
Identificador
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Número de telefone
name string nullable
Nome do assinante
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
]
bankCreditNotes object[] nullable
Dados de CCBs
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
issuerVatNumber string nullable
Numero de Documento do Emitente
sendToSignature boolean
Se deve ser enviada para fluxo de assinatura/certificação
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
installments object[] nullable
Parcelas de CCB
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
]
]
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Numero de telefone
name string nullable
Nome
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
webhook object

headerName string nullable

Nome da Chave, Exemplo: api-token

headerValue string nullable

Valor da Chave

webhookUrl string nullable

Url do Webhook

Request Body

Dados da CCB

batchName string nullable

Nome do evento

controlNumber string nullable

Número de Controle

terms object[] nullable
Termos
Array [
eDocumentType int32
Possible values: [1, 2, 3, 4, 5, 6, 99]
Tipo de Documento 1 = Termo 2 = Contrato Mãe 3 = Duplicata 4 = Promissária 5 = CCB 6 = Contrato 99 = Outros
documentName string nullable
Nome do Documento
path string nullable
Path/Url
identifier string nullable
Identificador
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Número de telefone
name string nullable
Nome do assinante
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
]
bankCreditNotes object[] nullable
Dados de CCBs
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
issuerVatNumber string nullable
Numero de Documento do Emitente
sendToSignature boolean
Se deve ser enviada para fluxo de assinatura/certificação
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
installments object[] nullable
Parcelas de CCB
Array [
issueDate date-time
Data de emissão
documentNumber string nullable
Número do documento
takerVatNumber string nullable
Numero de Documento do Tomador
documentBankCreditNoteId uuid
Id do Documento da CCB
value double
Valor da CCB
]
]
signers object[] nullable
Dados de assinantes
Array [
email string nullable
Email
phoneNumber string nullable
Numero de telefone
name string nullable
Nome
vatNumber string nullable
CPF
signType string nullable
Tipo de Assinatura, exemplo: PROCURADOR, EMITENTE, GESTOR, REPRESENTANTE, ETC ...
]
webhook object

headerName string nullable

Nome da Chave, Exemplo: api-token

headerValue string nullable

Valor da Chave

webhookUrl string nullable

Url do Webhook

Responses

• 200
• 400
• 401
• 403
• 404

---

Success

text/plain

application/json

text/json

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]
data object
isOk boolean
batchGroupId uuid
errors object nullable
property name* string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "data": {
    "isOk": true,
    "batchGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "errors": {}
  }
}

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]
data object
isOk boolean
batchGroupId uuid
errors object nullable
property name* string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "data": {
    "isOk": true,
    "batchGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "errors": {}
  }
}

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]
data object
isOk boolean
batchGroupId uuid
errors object nullable
property name* string nullable

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ],
  "data": {
    "isOk": true,
    "batchGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "errors": {}
  }
}

Bad Request

text/plain

application/json

text/json

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Schema

Example (from schema)

---

Schema

success boolean
errors object[] nullable
Array [
propertyName string nullable
errorMessage string nullable
attemptedValue nullable
customState nullable
severity int32
Possible values: [0, 1, 2]
errorCode string nullable
formattedMessagePlaceholderValues object nullable
nullable
]

{
  "success": true,
  "errors": [
    {
      "propertyName": "string",
      "errorMessage": "string",
      "severity": 0,
      "errorCode": "string",
      "formattedMessagePlaceholderValues": {}
    }
  ]
}

Unauthorized

text/plain

application/json

text/json

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Forbidden

text/plain

application/json

text/json

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Not Found

text/plain

application/json

text/json

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Schema

Example (from schema)

---

Schema

type string nullable
title string nullable
status int32 nullable
detail string nullable
instance string nullable

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...