### GET /cli/devolucoes/listar

Source: https://dev.cob.cloud/api/index

Retrieves a list of devedor returns and title cancellations based on provided query parameters.

```APIDOC
## GET /cli/devolucoes/listar

### Description
Retrieves a list of devedor returns and title cancellations based on provided query parameters.

### Method
GET

### Endpoint
/cli/devolucoes/listar

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Código do devedor no sistema do credor
- **nome** (string) - Optional - Razão social do devedor
- **documento** (string) - Optional - CPF/CNPJ do devedor
- **processo** (string) - Optional - Número de controle da assessoria. Cada devedor possui um número único.
- **data_devolucao** (string) - Optional - Filtro de data
- **limit** (int) - Optional - Quantidade de registros por página
- **page** (int) - Optional - Página atual

### Response
#### Success Response (200)
- **message** (string) - optional
- **status** (int) - optional
- **value** (object) - optional - Devoluções / Baixas de Títulos do devedor

#### Response Example
```json
{
  "message": "OK",
  "status": 200
}
```
```

--------------------------------

### GET /cli/titulos/listar

Source: https://dev.cob.cloud/api/index

Retrieves a list of titles/debts associated with debtors. Supports filtering by various parameters.

```APIDOC
## GET /cli/titulos/listar

### Description
Retorna uma lista de títulos / débitos.

### Method
GET

### Endpoint
/cli/titulos/listar

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Debtor's code in the creditor's system.
- **nome** (string) - Optional - Debtor's full name or company name.
- **documento** (string) - Optional - Debtor's CPF/CNPJ.
- **processo** (string) - Optional - Control number for the consultancy. Each debtor has a unique number.
- **status** (string) - Optional - Title status.
- **date_type** (string) - Optional - Type of date filter.
- **date_value** (string) - Optional - Date value for filtering.
- **limit** (integer) - Optional - Number of records per page.
- **page** (integer) - Optional - Current page number.

### Responses
#### Success Response (200)
- **message** (string) - Optional - Success message.
- **status** (integer) - Optional - Status code.
- **value** (object) - Optional - Contains the list of titles/debts.
```

--------------------------------

### Listar Devoluções - cURL

Source: https://dev.cob.cloud/api/index

Exemplo de requisição GET para listar devoluções utilizando cURL. Não requer parâmetros adicionais na URL para a requisição básica.

```curl
curl --request GET \
  --url https://api-v3.cob.cloud/cli/devolucoes/listar
```

--------------------------------

### GET /cli/prestacoes/listar

Source: https://dev.cob.cloud/api/index

Retrieves a list of account statements, payments, or remittances made by debtors. Supports filtering by various parameters.

```APIDOC
## GET /cli/prestacoes/listar

### Description
Retorna os pagamentos realizados.

### Method
GET

### Endpoint
/cli/prestacoes/listar

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Debtor's code in the creditor's system.
- **nome** (string) - Optional - Debtor's full name or company name.
- **documento** (string) - Optional - Debtor's CPF/CNPJ.
- **processo** (string) - Optional - Control number for the consultancy. Each debtor has a unique number.
- **numero_repasse** (integer) - Optional - Filter by remittance number. Sequential number of the account statement.
- **data_repasse** (string) - Optional - Date filter for remittances.
- **local_pagamento** (string) - Optional - Location where the debtor made the payment.
- **limit** (integer) - Optional - Number of records per page.
- **page** (integer) - Optional - Current page number.

### Responses
#### Success Response (200)
- **message** (string) - Optional - Success message.
- **status** (integer) - Optional - Status code.
- **value** (object) - Optional - Contains the list of account statements/payments.
```

--------------------------------

### GET /cli/ocorrencias/listar

Source: https://dev.cob.cloud/api/index

Fetches a list of occurrences or contacts made with debtors. Supports filtering by various parameters.

```APIDOC
## GET /cli/ocorrencias/listar

### Description
Retorna uma lista de ocorrências / contatos realizados com devedores.

### Method
GET

### Endpoint
/cli/ocorrencias/listar

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Debtor's code in the creditor's system.
- **nome** (string) - Optional - Debtor's full name or company name.
- **documento** (string) - Optional - Debtor's CPF/CNPJ.
- **processo** (string) - Optional - Control number for the consultancy. Each debtor has a unique number.
- **data_ocorrencia** (string) - Optional - Date filter for occurrences.
- **limit** (integer) - Optional - Number of records per page.
- **page** (integer) - Optional - Current page number.

### Responses
#### Success Response (200)
- **message** (string) - Optional - Success message.
- **status** (integer) - Optional - Status code.
- **value** (object) - Optional - Contains the list of occurrences/contacts.
```

--------------------------------

### GET /cli/devedores/listar

Source: https://dev.cob.cloud/api/index

Retrieves a list of debtors based on provided query parameters. Supports filtering by external code, name, document, process status, and pagination.

```APIDOC
## GET /cli/devedores/listar

### Description
Retrieves a list of debtors based on provided query parameters. Supports filtering by external code, name, document, process status, and pagination.

### Method
GET

### Endpoint
`https://api-v3.cob.cloud/cli/devedores/listar`

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Código do devedor no sistema do credor
- **nome** (string) - Optional - Razão social do devedor
- **documento** (string) - Optional - CPF/CNPJ do devedor
- **processo** (string) - Optional - Número de controle da assessoria. Cada devedor possui um número único.
- **situacao_processo** (string) - Optional - Define se quer localizar somente processos ativos ou encerrados.
- **limit** (integer) - Optional - Quantidade de registros por página
- **page** (integer) - Optional - Página atual

### Response
#### Success Response (200)
- **message** (string) - OK
- **status** (integer) - 200
- **value** (object) - Optional - Títulos/Débitos do devedor

#### Response Example
```json
{
  "message": "OK",
  "status": 200
}
```

#### Error Responses
- **401**
- **429**
```

--------------------------------

### List Debtors using cURL

Source: https://dev.cob.cloud/api/index

This cURL command shows how to retrieve a list of debtors from the CobCloud API. It sends a GET request to the /cli/devedores/listar endpoint. Optional query parameters can be appended to filter the results by external code, name, document, process status, and pagination.

```cURL
curl --request GET \
  --url https://api-v3.cob.cloud/cli/devedores/listar

```

--------------------------------

### PUT /cli/titulos/baixar

Source: https://dev.cob.cloud/api/index

Allows the user to download or withdraw one or more titles from debtors. It handles cases where titles are already downloaded or not found.

```APIDOC
## PUT /cli/titulos/baixar

### Description
Baixa um ou mais títulos de devedores. O cadastro do devedor é único por documento (CPF/CNPJ ou Código Externo), baseado do type_check. O cadastro do título/débito também é único, baseado no devedor + nº do título + parcela + especie + vencimento + valor. Caso utilize a informação valida_valor = false, a chave primária para localização ignorará o valor. Se o título já estiver baixado ou não for localizado, o sistema identificará esses casos.

### Method
PUT

### Endpoint
/cli/titulos/baixar

### Parameters
#### Request Body
- **data** (object) - Optional - Contains the list of titles to be downloaded.
  - **titulos** (array) - Required - List of titles to be processed.
    - **codigo_externo_devedor** (string) - Optional - External debtor code.
    - **data_baixa** (string) - Required - Download date (YYYY-MM-DD).
    - **documento_devedor** (string) - Required - Debtor's document (CPF/CNPJ).
    - **especie** (string) - Required - Title species.
    - **motivo_baixa** (string) - Optional - Reason for download.
    - **numero** (string) - Required - Title number.
    - **parcela** (string) - Required - Title installment number.
    - **validar_valor** (boolean) - Optional - Whether to validate the amount (defaults to true).
    - **valor** (number) - Required - Title amount.
    - **valor_pago** (number) - Required - Amount paid.
    - **vencimento** (string) - Required - Due date (YYYY-MM-DD).
  - **type_check** (integer) - Required - Type check indicator.
```

--------------------------------

### Exemplo de Resposta 200 - JSON

Source: https://dev.cob.cloud/api/index

Exemplo de uma resposta bem-sucedida (status 200) da API Cob Cloud ao listar devoluções. Inclui campos opcionais como mensagem e status.

```json
{
  "message": "OK",
  "status": 200
}
```

--------------------------------

### List Returns/Downloads using cURL

Source: https://dev.cob.cloud/api/index

This endpoint is designed to list titles that have been returned without payment. It provides a way to access information about returned financial instruments.

--------------------------------

### Listar Devoluções

Source: https://dev.cob.cloud/api/index

API responsible for listing titles that were returned without payment.

```APIDOC
## Listar Devoluções

### Description
Retorna uma lista de devoluções e títulos devolvidos.

### Method
GET

### Endpoint
/cli/devolucoes/listar

### Parameters
#### Query Parameters
- **codigo_externo** (string) - Optional - Debtor's code in the creditor's system.
- **nome** (string) - Optional - Debtor's full name or company name.
- **documento** (string) - Optional - Debtor's CPF/CNPJ.
- **processo** (string) - Optional - Control number for the consultancy. Each debtor has a unique number.
- **limit** (integer) - Optional - Number of records per page.
- **page** (integer) - Optional - Current page number.

### Responses
#### Success Response (200)
- **message** (string) - Optional - Success message.
- **status** (integer) - Optional - Status code.
- **value** (object) - Optional - Contains the list of returned titles.
```

--------------------------------

### Register Debtor and Title using cURL

Source: https://dev.cob.cloud/api/index

This cURL command demonstrates how to register a new debtor and their associated title/debt with the CobCloud API. It sends a POST request to the /cli/devedores/cadastrar endpoint with a JSON payload containing debtor and title information. The API handles duplicate checks based on document number and title details.

```cURL
curl --request POST \
  --url https://api-v3.cob.cloud/cli/devedores/cadastrar \
  --data \
'{
  "data": {
    "devedores": [
      {
        "campos_adicionais": [
          [
            "PERFIL A",
            "NEGATIVADO"
          ]
        ],
        "codigo_externo": "",
        "documento": "000.000.000-01",
        "emails": [
          {
            "email": "joao@email.com.br",
            "principal": true
          }
        ],
        "enderecos": [
          {
            "bairro": "Centro",
            "cep": "00000-000",
            "cidade": "São Paulo",
            "complemento": "Apto 100",
            "logradouro": "Av. Brasil",
            "numero": "123",
            "principal": true,
            "uf": "SP"
          }
        ],
        "fantasia": "João",
        "razao_social": "João da Silva",
        "telefones": [
          {
            "nome_contato": "",
            "numero": "(48) 99999-0000",
            "tipo": "MÓVEL"
          }
        ],
        "titulos": [
          {
            "atualizar": false,
            "campos_adicionais": [
              [
                ""
              ]
            ],
            "data_doc": "2023-03-01",
            "especie": "Duplicata",
            "numero": "NF 15000",
            "obs": "",
            "parcela": "001",
            "valor": 150.25,
            "vencimento": "2023-03-10"
          }
        ]
      }
    ],
    "type_check": 1
  }
}'

```

--------------------------------

### Download/Retire Titles using cURL

Source: https://dev.cob.cloud/api/index

This endpoint allows for the download or retirement of one or more debtor titles. It requires a JSON payload containing title details and a type_check indicator. The system handles cases where titles are already downloaded or not found.

```cURL
curl --request PUT \
  --url https://api-v3.cob.cloud/cli/titulos/baixar \
  --data '
{
  "data": {
    "titulos": [
      {
        "codigo_externo_devedor": "",
        "data_baixa": "2023-03-01",
        "documento_devedor": "000.000.000-01",
        "especie": "Duplicata",
        "motivo_baixa": "",
        "numero": "NF 15000",
        "parcela": "001",
        "validar_valor": true,
        "valor": 150.25,
        "valor_pago": 150.25,
        "vencimento": "2023-03-10"
      }
    ],
    "type_check": 1
  }
}'

```

--------------------------------

### List Account Settlements using cURL

Source: https://dev.cob.cloud/api/index

This endpoint retrieves a list of account settlements, which represent payments or remittances. Filtering options include debtor external code, name, document, process number, remittance number, remittance date, and payment location. Pagination is supported via 'limit' and 'page' query parameters.

```cURL
curl --request GET \
  --url https://api-v3.cob.cloud/cli/prestacoes/listar

```

--------------------------------

### POST /cli/devedores/cadastrar

Source: https://dev.cob.cloud/api/index

Adds one or more debtors and their respective titles/debts. The system validates for duplicate debtors based on document number (CPF/CNPJ or External Code). It also handles title updates or ignores duplicates based on the 'atualizar' flag.

```APIDOC
## POST /cli/devedores/cadastrar

### Description
Adds one or more debtors and their respective titles/debts. The system validates for duplicate debtors based on document number (CPF/CNPJ or External Code). It also handles title updates or ignores duplicates based on the 'atualizar' flag.

### Method
POST

### Endpoint
`https://api-v3.cob.cloud/cli/devedores/cadastrar`

### Parameters
#### Request Body
- **data** (object) - Optional
  - **devedores** (array) - Required
    - **campos_adicionais** (array of arrays) - Optional
    - **codigo_externo** (string) - Optional
    - **documento** (string) - Required
    - **emails** (array) - Optional
      - **email** (string) - Required
      - **principal** (boolean) - Required
    - **enderecos** (array) - Optional
      - **bairro** (string) - Optional
      - **cep** (string) - Optional
      - **cidade** (string) - Optional
      - **complemento** (string) - Optional
      - **logradouro** (string) - Optional
      - **numero** (string) - Optional
      - **principal** (boolean) - Optional
      - **uf** (string) - Optional
    - **fantasia** (string) - Optional
    - **razao_social** (string) - Optional
    - **telefones** (array) - Optional
      - **nome_contato** (string) - Optional
      - **numero** (string) - Required
      - **tipo** (string) - Optional
    - **titulos** (array) - Optional
      - **atualizar** (boolean) - Optional
      - **campos_adicionais** (array of arrays) - Optional
      - **data_doc** (string) - Optional
      - **especie** (string) - Optional
      - **numero** (string) - Optional
      - **obs** (string) - Optional
      - **parcela** (string) - Optional
      - **valor** (number) - Optional
      - **vencimento** (string) - Optional
  - **type_check** (integer) - Required

### Request Example
```json
{
  "data": {
    "devedores": [
      {
        "campos_adicionais": [
          [
            "PERFIL A",
            "NEGATIVADO"
          ]
        ],
        "codigo_externo": "",
        "documento": "000.000.000-01",
        "emails": [
          {
            "email": "joao@email.com.br",
            "principal": true
          }
        ],
        "enderecos": [
          {
            "bairro": "Centro",
            "cep": "00000-000",
            "cidade": "São Paulo",
            "complemento": "Apto 100",
            "logradouro": "Av. Brasil",
            "numero": "123",
            "principal": true,
            "uf": "SP"
          }
        ],
        "fantasia": "João",
        "razao_social": "João da Silva",
        "telefones": [
          {
            "nome_contato": "",
            "numero": "(48) 99999-0000",
            "tipo": "MÓVEL"
          }
        ],
        "titulos": [
          {
            "atualizar": false,
            "campos_adicionais": [
              [
                ""
              ]
            ],
            "data_doc": "2023-03-01",
            "especie": "Duplicata",
            "numero": "NF 15000",
            "obs": "",
            "parcela": "001",
            "valor": 150.25,
            "vencimento": "2023-03-10"
          }
        ]
      }
    ],
    "type_check": 1
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - OK
- **status** (integer) - 200

#### Response Example
```json
{
  "message": "OK",
  "status": 200
}
```

#### Error Responses
- **401**
- **429**
```

--------------------------------

### List Titles/Debts using cURL

Source: https://dev.cob.cloud/api/index

This endpoint retrieves a list of titles or debts associated with debtors. It supports filtering by various parameters such as debtor external code, name, document, process number, status, and date ranges. Pagination is available via 'limit' and 'page' query parameters.

```cURL
curl --request GET \
  --url https://api-v3.cob.cloud/cli/titulos/listar

```

--------------------------------

### List Occurrences using cURL

Source: https://dev.cob.cloud/api/index

This endpoint fetches a list of occurrences or contacts made with debtors. It allows filtering by debtor external code, name, document, process number, and occurrence date. Pagination is managed using 'limit' and 'page' query parameters.

```cURL
curl --request GET \
  --url https://api-v3.cob.cloud/cli/ocorrencias/listar

```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.