> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 31 - Incluir Campo Extra

Por meio deste endpoint o parceiro insere campos extras, ilimitados para uso na impressão de CCB.

Estes campos não devem sem utilizados pelos nossos analistas a fim de interpretação de regras de negócio.

A cada envio os valores anteriores são excluídos, o processo para utilização é:

* Definição de nomes dos campos juntamente com a nossa equipe técnica de integraçã
* Definição do local de uso de cada um dos campos extras.
* Envio da proposta por um dos métodos possíveis.
* Envio dos campos extras, o método permite receber uma lista contendo “NomeCampo” e “ValorCampo”.
* Quando necessitar  de atualização de um dos campos extras, todo o lote de campos deve ser enviado novamente.
* NomeCampo é limitado a 30 posições alfanuméricas.
* ValorCampo é de tamanho ilimitado.


## OpenAPI

````yaml post /Proposta/IncluirCampoExtra
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.Proposta.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br
security:
  - Bearer: []
paths:
  /Proposta/IncluirCampoExtra:
    post:
      tags:
        - Proposta
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropostaIncluirCampoExtraCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/PropostaIncluirCampoExtraCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PropostaIncluirCampoExtraCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
components:
  schemas:
    PropostaIncluirCampoExtraCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FindPropostaDTO'
        camposExtras:
          type: array
          items:
            $ref: '#/components/schemas/CampoExtraAddEditDTO'
          nullable: true
      additionalProperties: false
    ActionResponse:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
        parametros:
          type: array
          items:
            $ref: '#/components/schemas/ParametroDTO'
          nullable: true
      additionalProperties: false
    ResponseBase:
      type: object
      properties:
        msg:
          type: string
          nullable: true
        result:
          type: boolean
          writeOnly: true
        hasError:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
      additionalProperties: false
    FindPropostaDTO:
      type: object
      properties:
        codigoProposta:
          type: string
          description: Código identificador da proposta
          format: uuid
          nullable: true
        codigoOperacao:
          type: string
          description: Código da operação do parceiro
          nullable: true
        numeroProposta:
          type: integer
          description: Número sequencial da proposta
          format: int64
          nullable: true
      additionalProperties: false
    CampoExtraAddEditDTO:
      type: object
      properties:
        nomeCampo:
          type: string
          description: Nome do campo
          nullable: true
        valorCampo:
          type: string
          description: Valor do campo
          nullable: true
      additionalProperties: false
    Message:
      type: object
      properties:
        messageType:
          $ref: '#/components/schemas/ErrorType'
        code:
          type: string
          nullable: true
        context:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        field:
          type: string
          nullable: true
      additionalProperties: false
    ParametroDTO:
      type: object
      properties:
        nome:
          type: string
          description: Refere-se ao nome do parâmetro.
          nullable: true
        valor:
          type: string
          description: Refere-se ao valor do parâmetro.
          nullable: true
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````