# Balance

Este método se conecta a la cuenta especificada por el usuario en  y retorna su "Saldo en cuenta".

El uso del campo  desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir  con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo  pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

Endpoint: POST /v1/cl/services/afc.cl/balance
Version: v1.0
Security: JWT, Api-Key

## Request fields (application/json):

  - `RequestData` (object, required)
    Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos. Los campos obligatorios indican los valores necesarios para identificar la cuenta deseada.

  - `RequestData.AccountCredential` (any)
    Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key.

  - `CallbackUrl` (string)
    URL para enviar el mensaje de respuesta utilizando un método POST.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación.  significa que el servicio se ha ejecutado correctamente aunque no devuelva datos.  indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.
    Enum: "OK", "ERROR"

  - `Data` (object,null, required)
    Contenedor para el saldo de las contribuciones.

  - `Data.ContributionsBalance` (object, required)
    Contenedor para el saldo de las contribuciones.

  - `Data.ContributionsBalance.CreationDate` (string, required)
    Fecha de creación del recurso.
    Example: "2017-07-22"

  - `Data.ContributionsBalance.Details` (array, required)
    Contenedor para los detalles del saldo. El arreglo puede estar vacío.

  - `Data.ContributionsBalance.Details.Amount` (integer, required)
    Número de unidades monetarias especificadas en pesos chilenos (CLP) que representa la cantidad aportada.
    Example: "10000"

  - `Data.ContributionsBalance.Details.AmountCuota` (number, required)
    Número de unidades monetarias especificado en cuotas AFC que representa la cantidad aportada.
    Example: "223.45"

  - `Data.ContributionsBalance.Details.EmployerId` (string, required)
    Un identificador único e inmutable utilizado para identificar la empresa empleadora (también conocido como 'RUT').
    Example: "11.222.333-4"

  - `Data.ContributionsBalance.Details.EmployerName` (string, required)
    Information that identifies an employer business, such as the business name, that is presented in free format text.
    Example: "KHIPU SPA"

  - `Data.ContributionsBalance.TotalBalance` (integer, required)
    Número de unidades monetarias especificadas en pesos chilenos (CLP) que representa el importe total de las cotizaciones.
    Example: "10000"

  - `Data.ContributionsBalance.TotalBalanceCuota` (number, required)
    Número de cuotas que representa el importe total de las contribuciones.
    Example: "223.45"

  - `AdditionalInformation` (string,null, required)
    Este campo puede utilizarse para mostrar información relevante específica de la respuesta, por ejemplo indicando que el campo  está incompleto.

  - `Error` (object,null, required)
    Objeto con los detalles del error, utilizado cuando . Si  este campo será nulo. Puede leer una explicación completa de este objeto visitando [este enlace](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Código interno del sistema que identifica el error.
    Example: "E201"

  - `Error.Type` (string)
    Indica cómo tratar este código de error específico, en función del tipo de error.
    Enum: "RETRY_IMMEDIATELY", "DO_NOT_RETRY", "WAIT_4_HOURS_BEFORE_RETRY", "RETRY_AFTER_NOTIFICATION"

  - `Error.Description` (string)
    Descripción asociada al código de error.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string,null, required)
    en peticiones sincrónicas.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Identificador único de la operación.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Estado de la operación. Al realizar solicitudes asíncronas, siempre devolverá .
    Example: "OK"

  - `Data` (object, required)
    en solicitudes asíncronas.

  - `AdditionalInformation` (string, required)
    Mensaje de la operación, puede usarse para mostrar información adicional.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    en solicitudes asíncronas.

  - `LifeSpan` (string, required)
    Fecha máxima estimada de entrega para solicitudes asíncronas, en formato de fecha y hora ISO 8601, zona horaria UTC.
    Example: "2017-07-22T00:00:00-0400"