openapi: 3.1.0
servers:
  - url: //api-v3.cob.cloud/
    description: Endpoint
info:
  description: >
    # Introdução

    **API RESTful** - Todas as nossas APIs são organizadas em torno da
    arquitetura REST e são acessadas via HTTP.

    Então, se você já interagiu com uma API RESTful, muitos dos conceitos serão
    familiares.


    **Domínio base** - Todas as chamadas de API para o CRM CobCloud devem ser
    feitas para o domínio base <https://api-v3.cob.cloud>.


    **Respostas da API** - Um JSON será retornado em todas as respostas da API,
    incluindo casos de erro.


    **Ferramentas para testes de API** - Indicamos as ferramentas Postman ou
    Insomnia para você mapear todas as rotas e fazer os devidos testes antes de
    implementar em seu sistema.


    # Autenticação


    A API utiliza o conceito de API Key para realizar a autenticação.


    Dois tokens deverão ser inseridos no **HEADER** de todas as requisições.

      - `token_company` - Identificador único da assessoria
      - `token_client` - Identificador único do credor

    Para obter os tokens e começar a consumir a API, solicite a assessoria.


    # Limite de Requisições


    Todas as rotas possuem um limite (rate limit) afim de garantir a integridade
    e confiabilidade da plataforma.

    - Limite para métodos post: 10 p/ minuto

    - Limite para método get/put/delete: 25 p/ minuto
  version: 3.3.0
  title: CobCloud API / Credor
  summary: >-
    Esta API tem a finalidade de integrar o CRM CobCloud aos sistemas ERPs/CRMs
    de credores. Com ela é possível consultar e cadastrar devedores e títulos na
    base da assessoria, bem como a consulta de ocorrência/contatos, pagamentos e
    devoluções.
  termsOfService: http://swagger.io/terms/
  contact:
    name: Suporte
    email: desenvolvimento@cobcloud.com.br
    url: https://dev.cob.cloud/
  x-logo:
    url: http://www.cobcloud.com.br/logo-cobcloud2.png
    altText: CobCloud logo
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
    identifier: Apache 2.0
externalDocs:
  description: null
  url: null
tags:
  - name: Devedor
    description: API responsável por listar e cadastrar devedores e títulos
  - name: Títulos
    description: API responsável por listar os títulos / débitos dos devedores
  - name: Ocorrências
    description: >-
      API responsável por listar as ocorrências / contatos realizados com
      devedores
  - name: Prestações de Contas
    description: API responsável por listar as prestações de contas / pagamentos / repasses
  - name: Devoluções / Baixas
    description: API responsável por listar os títulos que foram devolvidos sem pagamento
x-tagGroups:
  - name: APIS
    tags:
      - Devedor
      - Títulos
      - Ocorrências
      - Prestações de Contas
      - Devoluções / Baixas
paths:
  /cli/devedores/cadastrar:
    post:
      tags:
        - Devedor
      summary: Cadastrar Devedor e/ou Título
      description: >
        ### Adiciona um ou mais devedores e seus respectivos títulos/débitos


        *Importante: O cadastro do devedor é único por documento (CPF/CNPJ ou
        Código Externo), baseado do type_check.*


        *Ou seja, o sistema faz uma validação se o devedor já existe na base, e
        não cadastra em duplicidade.*


        *Quando a flag atualizar não é enviada ou enviada como false, a chave
        primária do título será devedor + nº do título + parcela + especie +
        vencimento + valor.

        Quando é enviada como true, a chave primária do título é devedor + nº do
        título + parcela + especie.*


        *Caso seja enviado as mesmas informações, o sistema irá ignorar ou
        atualizar os dados, evitando assim a duplicidade de informações e
        possíveis cobranças indevidas.*
      operationId: addDevedor
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: string
              examples:
                response:
                  value:
                    status: 200
                    message: OK
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
      x-codeSamples:
        - lang: PHP
          source: |
            $form = new \Devedor\Entities\Devedor();
            $form->setRazaoSocial("Chuck Norris");
            $form->setFantasia("O Mito");
            // set other fields
            try {
                $pet = $client->devedor()->create($form);
            } catch (UnprocessableEntityException $e) {
                var_dump($e->getErrors());
            }
      requestBody:
        $ref: '#/components/requestBodies/Devedor'
  /cli/devedores/listar:
    get:
      tags:
        - Devedor
      summary: Consultar / Listar Devedores
      description: |
        ### Retorna os dados de um ou mais devedores
      operationId: getDevedor
      parameters:
        - name: codigo_externo
          in: query
          description: Código do devedor no sistema do credor
          required: false
          schema:
            type: string
          example: '0001'
        - name: nome
          in: query
          description: Razão social do devedor
          required: false
          schema:
            type: string
          example: Chuck Norris
        - name: documento
          in: query
          description: CPF/CNPJ do devedor
          required: false
          schema:
            type: string
          example: 000.000.000-00
        - name: processo
          in: query
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          required: false
          schema:
            type: string
          example: 1/00001
        - name: situacao_processo
          in: query
          description: Define se quer localizar somente processos ativos ou encerrados.
          required: false
          schema:
            type: string
            enum:
              - ativo
              - encerrado
          example: ativo
        - name: limit
          in: query
          description: Quantidade de registros por página
          required: false
          schema:
            type: int
            format: int32
            minimum: 1
            maximum: 500
          example: 100
        - name: page
          in: query
          description: Página atual
          required: false
          schema:
            type: int
            format: int32
          example: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultaDevedor'
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
  /cli/titulos/listar:
    get:
      tags:
        - Títulos
      summary: Listar Títulos / Débitos
      description: |
        ### Retorna uma lista de títulos / débitos
      operationId: getTitulo
      parameters:
        - name: codigo_externo
          in: query
          description: Código do devedor no sistema do credor
          required: false
          schema:
            type: string
          example: '0001'
        - name: nome
          in: query
          description: Razão social do devedor
          required: false
          schema:
            type: string
          example: Chuck Norris
        - name: documento
          in: query
          description: CPF/CNPJ do devedor
          required: false
          schema:
            type: string
          example: 000.000.000-00
        - name: processo
          in: query
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          required: false
          schema:
            type: string
          example: 1/00001
        - name: status
          in: query
          description: Status do título
          required: false
          schema:
            type: string
            enum:
              - aberto
              - quitado
              - devolvio
              - baixado
          example: ativo
        - name: date_type
          in: query
          description: Filtro de tipo de data
          required: false
          schema:
            type: string
            enum:
              - cadastro
              - vencimento
              - quitacao
              - devolucao
              - baixa
              - documento
          example: cadastro
        - name: date_value
          in: query
          description: Filtro de data
          required: false
          schema:
            type: string
            format: date
          example: 2023-01-01,2023-12-31
        - name: limit
          in: query
          description: Quantidade de registros por página
          required: false
          schema:
            type: int
            format: int32
            minimum: 1
            maximum: 500
          example: 100
        - name: page
          in: query
          description: Página atual
          required: false
          schema:
            type: int
            format: int32
          example: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultaTitulos'
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
  /cli/titulos/baixar:
    put:
      tags:
        - Títulos
      summary: Baixar / Retirar Título
      description: >
        ### Baixa um ou mais títulos de devedores


        *Importante: 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.*
      operationId: baixaTitulo
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: string
              examples:
                response:
                  value:
                    status: 200
                    message: OK
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
      requestBody:
        $ref: '#/components/requestBodies/BaixaTitulo'
  /cli/ocorrencias/listar:
    get:
      tags:
        - Ocorrências
      summary: Listar Ocorrências
      description: |
        ### Retorna uma lista de ocorrências / contatos realizados
      operationId: getOcorrencias
      parameters:
        - name: codigo_externo
          in: query
          description: Código do devedor no sistema do credor
          required: false
          schema:
            type: string
          example: '0001'
        - name: nome
          in: query
          description: Razão social do devedor
          required: false
          schema:
            type: string
          example: Chuck Norris
        - name: documento
          in: query
          description: CPF/CNPJ do devedor
          required: false
          schema:
            type: string
          example: 000.000.000-00
        - name: processo
          in: query
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          required: false
          schema:
            type: string
          example: 1/00001
        - name: data_ocorrencia
          in: query
          description: Filtro de data
          required: false
          schema:
            type: string
            format: date
          example: 2023-01-01,2023-01-31
        - name: limit
          in: query
          description: Quantidade de registros por página
          required: false
          schema:
            type: int
            format: int32
            minimum: 1
            maximum: 500
          example: 100
        - name: page
          in: query
          description: Página atual
          required: false
          schema:
            type: int
            format: int32
          example: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultaOcorrencias'
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
  /cli/prestacoes/listar:
    get:
      tags:
        - Prestações de Contas
      summary: Listar Prestações
      description: |
        ### Retorna os pagamentos realizados
      operationId: getPrestacoes
      parameters:
        - name: codigo_externo
          in: query
          description: Código do devedor no sistema do credor
          required: false
          schema:
            type: string
          example: '0001'
        - name: nome
          in: query
          description: Razão social do devedor
          required: false
          schema:
            type: string
          example: Chuck Norris
        - name: documento
          in: query
          description: CPF/CNPJ do devedor
          required: false
          schema:
            type: string
          example: 000.000.000-00
        - name: processo
          in: query
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          required: false
          schema:
            type: string
          example: 1/00001
        - name: numero_repasse
          in: query
          description: >-
            Filtro de número do repasse. Número sequencial da prestação de
            contas.
          required: false
          schema:
            type: int
          example: 1
        - name: data_repasse
          in: query
          description: Filtro de data
          required: false
          schema:
            type: string
            format: date
          example: '2023-01-31'
        - name: local_pagamento
          in: query
          description: Local onde o devedor realizou o pagamento
          required: false
          schema:
            type: string
            enum:
              - COBRADORA
              - CREDORA
          example: COBRADORA
        - name: limit
          in: query
          description: Quantidade de registros por página
          required: false
          schema:
            type: int
            format: int32
            minimum: 1
            maximum: 500
          example: 100
        - name: page
          in: query
          description: Página atual
          required: false
          schema:
            type: int
            format: int32
          example: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultaPrestacoes'
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
  /cli/devolucoes/listar:
    get:
      tags:
        - Devoluções / Baixas
      summary: Listar Devoluções
      description: |
        ### Retorna uma lista de devoluções e títulos devolvidos
      operationId: getDevolucoes
      parameters:
        - name: codigo_externo
          in: query
          description: Código do devedor no sistema do credor
          required: false
          schema:
            type: string
          example: '0001'
        - name: nome
          in: query
          description: Razão social do devedor
          required: false
          schema:
            type: string
          example: Chuck Norris
        - name: documento
          in: query
          description: CPF/CNPJ do devedor
          required: false
          schema:
            type: string
          example: 000.000.000-00
        - name: processo
          in: query
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          required: false
          schema:
            type: string
          example: 1/00001
        - name: data_devolucao
          in: query
          description: Filtro de data
          required: false
          schema:
            type: string
            format: date
          example: 2023-01-01,2023-01-31
        - name: limit
          in: query
          description: Quantidade de registros por página
          required: false
          schema:
            type: int
            format: int32
            minimum: 1
            maximum: 500
          example: 100
        - name: page
          in: query
          description: Página atual
          required: false
          schema:
            type: int
            format: int32
          example: 1
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsultaDevolucoes'
        '401':
          description: Sem autorização. Tokens faltando ou incorretos.
        '429':
          description: >-
            Atingiu o limite de requisições por minuto. Aguarde e tente
            novamente.
      security:
        - token_company: ''
        - token_client: ''
components:
  schemas:
    Devedor:
      type: object
      required:
        - type_check
        - devedores
      properties:
        data:
          type: object
          properties:
            type_check:
              description: >-
                Tipo de validação de duplicidade / 1 = CPF/CNPJ ou 0 = Código
                Externo
              type: int
              format: int32
              enum:
                - 0
                - 1
              example: 1
            devedores:
              description: Dados dos Devedores
              type: array
              exclusiveMaximum: 500
              exclusiveMinimum: 0
              items:
                $ref: '#/components/schemas/DadosDevedor'
    DadosDevedor:
      type: object
      required:
        - razao_social
      properties:
        razao_social:
          description: Razão Social / Nome
          type: string
          example: João da Silva
        fantasia:
          description: Fantasia / Apelido
          type: string
          example: João
        documento:
          description: CPF/CNPJ do devedor
          type: string
          example: 000.000.000-01
        codigo_externo:
          description: Código do devedor no sistema do credor
          type: string
          example: ''
        emails:
          description: E-mails do devedor
          type: array
          exclusiveMaximum: 50
          exclusiveMinimum: 0
          items:
            $ref: '#/components/schemas/EmailsDevedor'
        enderecos:
          description: Endereços do devedor
          type: array
          exclusiveMaximum: 50
          exclusiveMinimum: 0
          items:
            $ref: '#/components/schemas/EnderecosDevedor'
        telefones:
          description: Telefones do devedor
          type: array
          exclusiveMaximum: 50
          exclusiveMinimum: 0
          items:
            $ref: '#/components/schemas/TelefonesDevedor'
        campos_adicionais:
          description: Campos adicionais do devedor
          type: array
          minItems: 0
          maxItems: 10
          items:
            type: string
            example:
              - PERFIL A
              - NEGATIVADO
        titulos:
          description: Títulos/Débitos do devedor
          type: array
          exclusiveMaximum: 100
          exclusiveMinimum: 0
          items:
            $ref: '#/components/schemas/TitulosDevedor'
    EmailsDevedor:
      type: object
      required:
        - email
      properties:
        email:
          description: E-mail do devedor
          type: string
          maxLength: 300
          format: email
          example: joao@email.com.br
        principal:
          description: Marca se o e-mail é principal ou não
          type: boolean
          writeOnly: true
          example: true
          enum:
            - true
            - false
    EnderecosDevedor:
      type: object
      required:
        - logradouro
      properties:
        logradouro:
          description: Endereço
          type: string
          maxLength: 200
          example: Av. Brasil
        numero:
          description: Nº do endereço
          type: string
          maxLength: 20
          example: '123'
        complemento:
          description: Complemento do endereço
          type: string
          maxLength: 100
          example: Apto 100
        bairro:
          description: Bairro do endereço
          type: string
          maxLength: 80
          example: Centro
        cep:
          description: CEP do endereço
          type: string
          maxLength: 10
          example: 00000-000
        cidade:
          description: Cidade do endereço
          type: string
          maxLength: 80
          example: São Paulo
        uf:
          description: UF do endereço
          type: string
          maxLength: 2
          example: SP
        principal:
          description: Marca se o endereço é principal ou não
          type: boolean
          writeOnly: true
          example: true
          enum:
            - true
            - false
    TelefonesDevedor:
      type: object
      required:
        - numero
        - tipo
      properties:
        nome_contato:
          description: Nome do contato
          type: string
          maxLength: 50
          example: ''
        numero:
          description: Telefone do devedor
          type: string
          maxLength: 15
          pattern: (00) 00000-0000
          example: (48) 99999-0000
        tipo:
          description: Tipo do Telefone / FIXO ou MÓVEL
          type: string
          enum:
            - FIXO
            - MÓVEL
          example: MÓVEL
    TitulosDevedor:
      type: object
      required:
        - numero
        - vencimento
        - valor
      properties:
        atualizar:
          description: >-
            Flag se deseja atualizar vencimento e valor do título caso encontre
            na base
          type: boolean
          writeOnly: true
          example: false
          enum:
            - true
            - false
        numero:
          description: Número do débito
          type: string
          maxLength: 50
          example: NF 15000
        parcela:
          description: Nº da parcela do débito
          type: string
          maxLength: 40
          example: '001'
        especie:
          description: Espécie do débito
          type: string
          maxLength: 40
          example: Duplicata
        vencimento:
          description: Vencimento do débito
          type: string
          maxLength: 10
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        valor:
          description: Valor do débito
          type: number
          example: 150.25
        data_doc:
          description: Data de Documento/Emissão do débito
          type: string
          maxLength: 10
          pattern: aaaa-mm-dd
          example: '2023-03-01'
        obs:
          description: Observações do débito
          type: string
          maxLength: 500
          example: ''
        campos_adicionais:
          description: Campos adicionais do débito
          type: array
          minItems: 0
          maxItems: 10
          items:
            type: string
            example:
              - ''
    ConsultaDevedor:
      type: object
      properties:
        value:
          description: Títulos/Débitos do devedor
          properties:
            limit:
              description: Quantidade de registros por página
              type: int
              format: int32
              example: 500
            page:
              description: Página atual
              type: int
              format: int32
              example: 0
            query:
              type: array
              items:
                $ref: '#/components/schemas/ConsultaDevedorQuery'
        status:
          type: int
          example: 200
        message:
          type: string
          example: OK
    ConsultaDevedorQuery:
      type: object
      properties:
        id_devedor:
          description: ID único do devedor do banco de dados
          type: string
          format: uuid
          example: 61cba82a-2190-4d1d-b05e-a9ddcd26s9c1
        processo:
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          type: string
          example: 1/00001
        codigo:
          description: Código sequencial único da assessoria.
          type: int
          example: '00001'
        codigo_externo:
          description: Código do devedor no sistema do credor
          type: string
          example: ''
        razao_social:
          description: Razão Social / Nome
          type: string
          example: Chuck Norris
        fantasia:
          description: Fantasia / Apelido
          type: string
          example: O Mito
        documento:
          description: CPF/CNPJ do devedor
          type: string
          example: 000.000.000-01
        status_processo:
          description: >-
            Status do processo: Acordo / Quitado / Devolvido / Em Cobrança /
            Aguardando Acionamento...
          type: string
          example: ACORDO
        situacao_processo:
          description: 'Situação do processo: ativo ou encerrado'
          type: string
          enum:
            - ativo
            - encerrado
          example: ativo
        end_logradouro:
          description: Endereço principal do devedor
          type: string
          example: Av. Brasil
        end_numero:
          description: Nº do endereço principal do devedor
          type: string
          example: '123'
        end_complemento:
          description: Complemento do endereço principal do devedor
          type: string
          example: Apto 100
        end_bairro:
          description: Bairro do endereço principal do devedor
          type: string
          example: Centro
        end_cep:
          description: CEP do endereço principal do devedor
          type: string
          example: 00000-000
        end_cidade:
          description: Cidade do endereço principal do devedor
          type: string
          example: São Paulo
        end_uf:
          description: UF do endereço principal do devedor
          type: string
          example: SP
        email1:
          description: E-mail principal do devedor
          example: chuck@norris.com.br
        email2:
          description: E-mail principal do devedor
          type: string
          example: ''
        last_update:
          description: Data da ultima modificação do devedor
          type: date-time
          example: 2023-05-03T22:56:57.499Z
        telefones:
          type: array
          items:
            $ref: '#/components/schemas/TelefonesDevedor'
        emails_adicionais:
          type: array
          items:
            $ref: '#/components/schemas/EmailsDevedor'
        enderecos_adicionais:
          type: array
          items:
            $ref: '#/components/schemas/EnderecosDevedor'
    ObjetoDevedor:
      type: object
      properties:
        id_devedor:
          description: ID único do devedor do banco de dados
          type: string
          format: uuid
          example: 61cba82a-2190-4d1d-b05e-a9ddcd26s9c1
        processo:
          description: >-
            Número de controle da assessoria. Cada devedor possui um número
            único.
          type: string
          example: 1/00001
        codigo_externo:
          description: Código do devedor no sistema do credor
          type: string
          example: ''
        razao_social:
          description: Razão Social / Nome
          type: string
          example: Chuck Norris
        documento:
          description: CPF/CNPJ do devedor
          type: string
          example: 000.000.000-01
    ConsultaTitulos:
      type: object
      properties:
        value:
          description: Títulos/Débitos do devedor
          properties:
            limit:
              description: Quantidade de registros por página
              type: int
              format: int32
              example: 500
            page:
              description: Página atual
              type: int
              format: int32
              example: 0
            query:
              type: array
              items:
                $ref: '#/components/schemas/ConsultaTitulosQuery'
        status:
          type: int
          example: 200
        message:
          type: string
          example: OK
    ConsultaTitulosQuery:
      type: object
      properties:
        id_titulo:
          description: ID único do título do banco de dados
          type: string
          format: uuid
          example: 58612103-85fb-ffd3-92e1-5d653a4d4b6f
        data_cadastro:
          description: Data de cadastro
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        numero_titulo:
          description: Número do débito
          type: string
          maxLength: 50
          example: NF 15000
        parcela:
          description: Nº da parcela
          type: string
          maxLength: 40
          example: '001'
        especie:
          description: Espécie
          type: string
          maxLength: 40
          example: Duplicata
        vencimento:
          description: Vencimento
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        valor:
          description: Valor original
          type: number
          example: 150.25
        protesto:
          description: Valor de protesto
          type: number
          example: 0
        saldo_capital:
          description: Saldo do valor original
          type: number
          example: 150.25
        saldo_protesto:
          description: Saldo do valor de protesto
          type: number
          example: 0
        status:
          description: Status atual
          type: string
          example: aberto
          enum:
            - aberto
            - quitado
            - devolvio
            - baixado
        obs:
          description: Observações
          type: string
          maxLength: 500
          example: ''
        moeda:
          description: Moeda
          type: string
          example: R$
        usuario_cad:
          description: Usuário que cadastrou o débito
          type: string
          example: Pedro
        usuario_tipo:
          description: Tipo do usuário que cadastrou
          type: string
          example: Colaborador
          enum:
            - Colaborador
            - Credor
        data_documento:
          description: Data de documento/emissão
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-01'
        data_quitacao:
          description: Data de quitação (quando há pagamento)
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: null
        data_devolução:
          description: Data de devolução (sem pagamento)
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: null
        data_baixa:
          description: Data de baixa (idem devolução,sem pagamento)
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: null
        last_update:
          description: Data da ultima modificação
          type: date-time
          example: 2023-05-03T22:56:57.499Z
        campos_adicionais:
          description: Campos Adicionais
          type: object
          properties:
            campo1:
              type: string
              example: Nome do Aluno
            valor1:
              type: string
              example: Pedro da Silva
            campo2:
              type: string
              example: ''
            valor2:
              type: string
              example: ''
            campo3:
              type: string
              example: ''
            valor3:
              type: string
              example: ''
            campo4:
              type: string
              example: ''
            valor4:
              type: string
              example: ''
            campo5:
              type: string
              example: ''
            valor5:
              type: string
              example: ''
            campo6:
              type: string
              example: ''
            valor6:
              type: string
              example: ''
            campo7:
              type: string
              example: ''
            valor7:
              type: string
              example: ''
            campo8:
              type: string
              example: ''
            valor8:
              type: string
              example: ''
            campo9:
              type: string
              example: ''
            valor9:
              type: string
              example: ''
            campo10:
              type: string
              example: ''
            valor10:
              type: string
              example: ''
        devedor:
          type: object
          $ref: '#/components/schemas/ObjetoDevedor'
    ConsultaOcorrencias:
      type: object
      properties:
        value:
          description: Ocorrências / Contatos com Devedor
          properties:
            limit:
              description: Quantidade de registros por página
              type: int
              format: int32
              example: 500
            page:
              description: Página atual
              type: int
              format: int32
              example: 0
            query:
              type: array
              items:
                $ref: '#/components/schemas/ConsultaOcorrenciasQuery'
        status:
          type: int
          example: 200
        message:
          type: string
          example: OK
    ConsultaOcorrenciasQuery:
      type: object
      properties:
        id_ocorrencia:
          description: ID único da ocorrência do banco de dados
          type: string
          format: uuid
          example: 4a09910c-ec1a-482c-d81f-df7093b7a8d1
        data_ocorrencia:
          description: Data da ocorrência
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        hora_ocorrencia:
          description: Hora da ocorrência
          type: string
          format: time
          pattern: hh:mm:ss
          example: '10:15'
        tabulacao:
          description: Tabulação
          type: string
          example: 06.02 - RECADO
        historico:
          description: Observações / Anotações Diversas
          type: string
          example: Enviado SMS de comunicadao
        devedor:
          type: object
          $ref: '#/components/schemas/ObjetoDevedor'
    ConsultaPrestacoes:
      type: object
      properties:
        value:
          description: Prestações de Contas / Pagamentos do devedor
          properties:
            limit:
              description: Quantidade de registros por página
              type: int
              format: int32
              example: 500
            page:
              description: Página atual
              type: int
              format: int32
              example: 0
            query:
              type: array
              items:
                $ref: '#/components/schemas/ConsultaPrestacoesQuery'
        status:
          type: int
          example: 200
        message:
          type: string
          example: OK
    ConsultaPrestacoesQuery:
      type: object
      properties:
        id_prestacao:
          description: ID único da prestação de contas do banco de dados
          type: string
          format: uuid
          example: a4273f70-2f4e-458c-bcfd-038cs56g0a7a
        data_repasse:
          description: Data de repasse
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        numero_repasse:
          description: Número sequencial da prestação de contas
          type: int
          example: 4
        local_pagamento:
          description: Local onde o devedor realizou o pagamento
          type: string
          example: COBRADORA
          enum:
            - COBRADORA
            - CREDORA
        total_repasse:
          description: Total do repasse
          type: number
          example: 1050.55
        total_outros_debitos_creditos:
          description: Total de outros débitos ou créditos da prestação
          type: number
          example: 0
        obs:
          description: Observações diversas da prestação
          type: string
          example: ''
        last_update:
          description: Data da ultima modificação
          type: date-time
          example: 2023-05-03T22:56:57.499Z
        pagamentos:
          type: array
          items:
            $ref: '#/components/schemas/ConsultaPrestacoesPagamentosQuery'
    ConsultaPrestacoesPagamentosQuery:
      type: object
      properties:
        id_titulo:
          description: ID único do título do banco de dados
          type: string
          format: uuid
          example: 58612103-85fb-ffd3-92e1-5d653a4d4b6f
        numero_titulo:
          description: Número do débito
          type: string
          maxLength: 50
          example: NF 15000
        parcela:
          description: Nº da parcela
          type: string
          maxLength: 40
          example: '001'
        vencimento:
          description: Vencimento
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        valor_capital:
          description: Valor original
          type: number
          example: 150.25
        valor_protesto:
          description: Valor de protesto
          type: number
          example: 0
        capital_pago:
          description: Valor pago de capital
          type: number
          example: 100
        desconto_pago:
          description: Valor de desconto aplicado
          type: number
          example: 0
        protesto_pago:
          description: Valor de protesto pago
          type: number
          example: 0
        juros_pago:
          description: Valor de juros pago
          type: number
          example: 15.52
        multa_pago:
          description: Valor de multa paga
          type: number
          example: 4
        total_pago:
          description: Total pago (capital pago + protesto pago + juros pago + multa paga)
          type: number
          example: 119.52
        taxa_pago:
          description: Remuneração da assessoria
          type: number
          example: 11.95
        status:
          description: Status de pagamento do título
          type: string
          enum:
            - Parcial
            - Quitação
          example: Parcial
        saldo_capital:
          description: Saldo que ficou o título após o pagamento
          type: number
          example: 50
        parcela_acordo:
          description: Número da parcela do acordo
          type: String
          example: 01/02
        codigo_acordo:
          description: Número identificador do acordo
          type: int
          example: 1500
        devedor:
          type: object
          $ref: '#/components/schemas/ObjetoDevedor'
    ConsultaDevolucoes:
      type: object
      properties:
        value:
          description: Devoluções / Baixas de Títulos do devedor
          properties:
            limit:
              description: Quantidade de registros por página
              type: int
              format: int32
              example: 500
            page:
              description: Página atual
              type: int
              format: int32
              example: 0
            query:
              type: array
              items:
                $ref: '#/components/schemas/ConsultaDevolucoesQuery'
        status:
          type: int
          example: 200
        message:
          type: string
          example: OK
    ConsultaDevolucoesQuery:
      type: object
      properties:
        id_devolucao:
          description: ID único da devolução do banco de dados
          type: string
          format: uuid
          example: c365s583-4bb2-4a51-955b-fce26554c4c0
        data_devolucao:
          description: Data da devolução
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        motivo:
          description: Motivo da devolução
          type: string
          example: 03.04 - DEVOLUÇÃO POR NÃO LOCALIZAÇÃO
        observacoes:
          description: Observações / Anotações Diversas
          type: string
          example: NAO FOI ENCONTRADO O DEVEDOR
        last_update:
          description: Data da ultima modificação
          type: date-time
          example: 2023-05-03T22:56:57.499Z
        titulos:
          type: array
          items:
            $ref: '#/components/schemas/ConsultaDevolucoesTitulosQuery'
        devedor:
          type: object
          $ref: '#/components/schemas/ObjetoDevedor'
    ConsultaDevolucoesTitulosQuery:
      type: object
      properties:
        id_titulo:
          description: ID único do título do banco de dados
          type: string
          format: uuid
          example: 58612103-85fb-ffd3-92e1-5d653a4d4b6f
        numero_titulo:
          description: Número do débito
          type: string
          maxLength: 50
          example: NF 15000
        parcela:
          description: Nº da parcela
          type: string
          maxLength: 40
          example: '001'
        especie:
          description: Espécie
          type: string
          maxLength: 40
          example: Duplicata
        vencimento:
          description: Vencimento
          type: string
          format: date
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        valor:
          description: Valor original
          type: number
          example: 150.25
        protesto:
          description: Valor de protesto
          type: number
          example: 0
    BaixaTitulo:
      type: object
      required:
        - type_check
        - titulos
      properties:
        data:
          type: object
          properties:
            type_check:
              description: >-
                Tipo de validação do devedor / 1 = CPF/CNPJ ou 0 = Código
                Externo
              type: int
              format: int32
              enum:
                - 0
                - 1
              example: 1
            titulos:
              description: Dados dos Títulos
              type: array
              exclusiveMaximum: 250
              exclusiveMinimum: 0
              items:
                $ref: '#/components/schemas/DadosTitulosBaixa'
    DadosTitulosBaixa:
      type: object
      required:
        - numero
        - vencimento
        - valor
      properties:
        documento_devedor:
          description: CPF/CNPJ do devedor
          type: string
          example: 000.000.000-01
        codigo_externo_devedor:
          description: Código do devedor no sistema do credor
          type: string
          example: ''
        numero:
          description: Número do débito
          type: string
          maxLength: 50
          example: NF 15000
        parcela:
          description: Nº da parcela do débito
          type: string
          maxLength: 40
          example: '001'
        especie:
          description: Espécie do débito
          type: string
          maxLength: 40
          example: Duplicata
        vencimento:
          description: Vencimento do débito
          type: string
          maxLength: 10
          pattern: aaaa-mm-dd
          example: '2023-03-10'
        valor:
          description: Valor do débito
          type: number
          example: 150.25
        validar_valor:
          description: Valida o valor do título para localizar o mesmo
          type: boolean
          writeOnly: true
          example: true
          enum:
            - true
            - false
        data_baixa:
          description: Data de Baixa do débito
          type: string
          maxLength: 10
          pattern: aaaa-mm-dd
          example: '2023-03-01'
        motivo_baixa:
          description: Motivo de Baixa do débito
          type: string
          maxLength: 500
          example: ''
        valor_pago:
          description: Valor do pagamento
          type: number
          example: 150.25
  requestBodies:
    Devedor:
      content:
        application/json:
          schema:
            description: Devedor
            title: null
            $ref: '#/components/schemas/Devedor'
      description: Crie um JSON conforme Request de exemplo ao lado
      required: true
    BaixaTitulo:
      content:
        application/json:
          schema:
            description: BaixaTitulo
            title: null
            $ref: '#/components/schemas/BaixaTitulo'
      description: Crie um JSON conforme Request de exemplo ao lado
      required: true
  securitySchemes:
    token_company:
      description: null
      type: apiKey
      name: token_company
      in: header
    token_client:
      description: null
      type: apiKey
      name: token_client
      in: header