Merge pull request #2268 from mercadopago/att-account-balance-attributes

Adição do tipo e exemplo dos atributos configuráveis no Reporte de Dinheiro em conta

guides/additional-content/reports/account-money/api.en.md

@@ -14,23 +14,23 @@ Know the fields you can configure to adjust your preferences before you start:
 >
 > Setting up `frequency` feature does not mean that the report will be generated automatically. The settings will apply only when the automatic scheduling is activated. For more details, please go to the [Schedule your automatic reports](#bookmark_schedule_report_automatically) section.
 
-| Configurable fields | Description |
-| --- | --- |
-| *`coupon_detailed` (optional)* | <br/>Includes a column to show the detail of the discount coupons.<br/><br/> |
-| `columns` | <br/>Field with the details of columns to be included in your report. Find all possible values in the [Glossary section](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/additional-content/reports/account-money/glossary).<br/><br/>|
-| `file_name_prefix` | <br/>Prefix that composes the report name once generated and ready for download.<br/><br/> |
-| `frequency` | <br/>Indicates the daily, weekly or monthly frequency of scheduled reports.<br/><br/> - `frequency` applies type *monthly* to the day of the month or *weekly* to the day of the week.<br/> - `hour` time of day to generate the report. <br/> - `type` indicates the type of frequency *daily*, *weekly* and *monthly*.<br/><br/> |
-| `display_timezone` (optional) | <br/>This field determines the date and time displayed in the reports. If you do not set a time zone in this field, the system will consider GMT-04 as default. If you choose a time zone which adopts daylight saving time, you will need to adjust it manually when the time changes.<br/><br/> |
-| `include_withdraw` | <br/>This parameter allows to ignore (false) or include (true) money withdraw in the report.<br/><br/> |
-| `report_translation` (optional) | <br/>Allows you to change the default language of the column headers in reports that are generated in Excel format (.xlsx). If you have an integration based on this format and configure this feature, we recommend that you verify if it works correctly.<br/><br/> If your integration does not work properly, update it based on the new headers.<br/><br/> |
-| *`refund_detailed` (optional)* | <br/> Displays the reference code (`external_reference`) of the refund instead of the reference code (`external_reference`) of the payment.<br/><br/> |
-| `scheduled` (read_only) | <br/> Informative field that indicates if there are already scheduled reports in the user account. <br/> `True` The automatic generation is activated <br/> `False` The automatic generation is disabled<br/><br/> |
-| *`separator` (optional)* | <br/> Separator that you can use in the .csv file when you don't want the separator to be a comma. <br/><br/> |
-| `notification_email_list` (optional) | <br/>Allows you to add a group of e-mail recipients to be notified when a report is ready and available for download. Make sure to include the email linked to your Mercado Pago account so you can be notified as well. <br/><br/> |
-| *`sftp_info` (optional)* | <br/> Indicates the uploaded data to SFTP when you need it. <br/><br/> |
-| *`shipping_detail` (optional)* | <br/> Includes the detail of the shipments. <br/> <br/>|
-| *`show_chargeback_cancel` (optional)* | <br/> Includes the detail of cancellations of chargebacks. <br/> <br/>|
-| *`show_fee_prevision` (optional)* | <br/> Includes the details of the fees. <br/> <br/>|
+| Configurable fields | Type | Example | Description |
+| --- | --- | --- | --- |
+| *`coupon_detailed` (optional)* | Boolean | true | <br/>Includes a column to show the detail of the discount coupons.<br/><br/> |
+| `columns` | JSON Array | ```[ { "key": "DATE" }, { "key": "SOURCE_ID" } ]``` | <br/>Field with the details of columns to be included in your report. Find all possible values in the [Glossary section](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/additional-content/reports/account-money/glossary).<br/><br/>|
+| `file_name_prefix` | String | "conciliation-settlement-report" | <br/>Prefix that composes the report name once generated and ready for download.<br/><br/> |
+| `frequency` | JSON | ```{ "hour": 0, "type": "monthly", "value": 1 }``` | <br/>Indicates the daily, weekly or monthly frequency of scheduled reports.<br/><br/> - `frequency` applies type *monthly* to the day of the month or *weekly* to the day of the week.<br/> - `hour` time of day to generate the report. <br/> - `type` indicates the type of frequency *daily*, *weekly* and *monthly*.<br/><br/> |
+| `display_timezone` (optional) | String | "GMT-04" | <br/>This field determines the date and time displayed in the reports. If you do not set a time zone in this field, the system will consider GMT-04 as default. If you choose a time zone which adopts daylight saving time, you will need to adjust it manually when the time changes.<br/><br/> |
+| `include_withdraw` | Boolean | true | <br/>This parameter allows to ignore (false) or include (true) money withdraw in the report.<br/><br/> |
+| `report_translation` (optional) | String | "es" | <br/>Allows you to change the default language of the column headers in reports that are generated in Excel format (.xlsx). If you have an integration based on this format and configure this feature, we recommend that you verify if it works correctly.<br/><br/> If your integration does not work properly, update it based on the new headers.<br/><br/> |
+| *`refund_detailed` (optional)* |  Boolean | true | <br/> Displays the reference code (`external_reference`) of the refund instead of the reference code (`external_reference`) of the payment.<br/><br/> |
+| `scheduled` (read_only) | Boolean | true | <br/> Informative field that indicates if there are already scheduled reports in the user account. <br/> `True` The automatic generation is activated <br/> `False` The automatic generation is disabled<br/><br/> |
+| *`separator` (optional)* | String | ";" | <br/> Separator that you can use in the .csv file when you don't want the separator to be a comma. <br/><br/> |
+| `notification_email_list` (optional) |  Array | ```["example@email.com", "john@example.com"]``` | <br/>Allows you to add a group of e-mail recipients to be notified when a report is ready and available for download. Make sure to include the email linked to your Mercado Pago account so you can be notified as well. <br/><br/> |
+| *`sftp_info` (optional)* | JSON | ```{ "server": "sftp.myserver.com", "password": "mypassword", "remote_dir": "/myfolder", "port": 22, "username": "myusername" }``` | <br/> Indicates the uploaded data to SFTP when you need it. <br/><br/> |
+| *`shipping_detail` (optional)* | Boolean | true | <br/> Includes the detail of the shipments. <br/> <br/>|
+| *`show_chargeback_cancel` (optional)* | Boolean | true | <br/> Includes the detail of cancellations of chargebacks. <br/> <br/>|
+| *`show_fee_prevision` (optional)* | Boolean | true | <br/> Includes the details of the fees. <br/> <br/>|
 
 You can configure your reports as needed. Below, we highlight the available API calls so you can manage the configuration of your report and, based on these settings, generate the reports.
 
@@ -678,7 +678,7 @@ In the absence of errors, an `HTTP 200 (Ok)` status code will be issued. The API
 >
 > Note
 >
-> Have the [Glossary of the Account Money report](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/additional-content/reports/account-money/glossary) on hand to review it when needed or want to review a technical term.
+> Have the [Glossary of the Account balance report](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/additional-content/reports/account-money/glossary) on hand to review it when needed or want to review a technical term.
 
 ## Manually create report
 

guides/additional-content/reports/account-money/api.es.md

@@ -14,23 +14,23 @@ Consulta los campos que puedes configurar para ajustar tus preferencias antes de
 >
 > Configurar el atributo `frequency` no implica que el reporte se genere automáticamente. La configuración aplicará solo cuando se active la programación automática. Para mayor detalle puedes dirigirte a la sección [Programa tus reportes](#bookmark_agendar_relatório_automaticamente).
 
-| Campos configurables | Descripción |
-| --- | --- |
-| *`coupon_detailed` (opcional)* | <br/>Incluye una columna para mostrar el detalle de los cupones de descuento.<br/><br/> |
-| `columns` | <br/>Campo con el detalle de columnas a incluir en tu reporte. Encuentra todos los posibles valores en la sección de  [Glosario](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/es/guides/additional-content/reports/account-money/glossary).<br/><br/>|
-| `file_name_prefix` | <br/>Prefijo que compone el nombre del reporte una vez generado y listo para descargar.<br/><br/> |
-| `display_timezone` (opcional) | <br/>Este campo determina la fecha y la hora que se visualiza en los reportes. Si no configuras este campo con una zona horaria, el sistema tomará por defecto el valor GMT-04. Si eliges una zona horaria que utiliza horario de verano, es necesario que hagas el ajuste manual cuando cambie la hora.<br/><br/> |
-| `include_withdraw` | <br/>Este parámetro nos permite ignorar (false) o incluir (true) los retiros de dinero en el reporte.<br/><br/> |
-| `report_translation` (opcional) | <br/>Permite cambiar el idioma predeterminado de los encabezados de las columnas. En caso de habilitarlo, se recomienda verificar que funcionen correctamente las integraciones con archivos de Excel (.xlsx) que permiten conciliar de forma automática.<br/><br/> Si la integración no funciona bien, asegúrate de actualizarla tomando como referencia los nuevos encabezados.<br/><br/> |
-| `frequency` | <br/>Indica la frecuencia diaria, semanal o mensual de los reportes programados.<br/><br/> - `frequency` aplica type *monthly* al día del mes o *weekly* el día de la semana<br/> - `hour` hora del día en la que generar el reporte <br/> - `type` indica el tipo de frecuencia *daily* (diaria), *weekly* (semanal) y *monthly* (mensual).<br/><br/> |
-| *`refund_detailed` (opcional)* | <br/>Muestra el código de referencia (`external_reference`) del reembolso en vez del código de referencia (`external_reference`) del pago.<br/><br/> |
-| `scheduled` (read_only) | <br/>Campo informativo que indica si ya existen reportes programados en la cuenta de usuario.<br/> `True` la generación automática se encuentra activada. <br/> `False` la generación automática se encuentra Desactivada.<br/><br/> |
-| *`separator` (opcional)* | <br/>Separador que puedes usar en el archivo .csv cuando no quieras que el separador sea una coma. <br/><br/> |
-| `notification_email_list` (opcional) | <br/>Permite agregar un grupo de destinatarios de correo electrónico para que reciban una notificación cuando un reporte está listo y disponible para descargar. Asegúrate de incluir el correo asociado a tu cuenta de Mercado Pago para que también recibas las notificaciones.<br/><br/> |
-| *`sftp_info` (opcional)* | <br/>Indica los datos de subida a SFTP cuando lo necesites.<br/><br/> |
-| *`shipping_detail` (opcional)* | <br/> Incluye el detalle de los envíos <br/> <br/>|
-| *`show_chargeback_cancel` (opcional)* | <br/> Incluye el detalle de las cancelaciones de los contracargos <br/> <br/>|
-| *`show_fee_prevision` (opcional)* | <br/> Incluye el detalle de las comisiones <br/> <br/>|
+| Campos configurables | Tipo | Ejemplo | Descripción | 
+| --- | --- | --- | --- |
+| *`coupon_detailed` (opcional)* | Boolean | true | <br/>Incluye una columna para mostrar el detalle de los cupones de descuento.<br/><br/> |
+| `columns` | JSON Array | ```[ { "key": "DATE" }, { "key": "SOURCE_ID" } ]``` | <br/>Campo con el detalle de columnas a incluir en tu reporte. Encuentra todos los posibles valores en la sección de  [Glosario](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/es/guides/additional-content/reports/account-money/glossary).<br/><br/>|
+| `file_name_prefix` | String | "conciliation-settlement-report" | <br/>Prefijo que compone el nombre del reporte una vez generado y listo para descargar.<br/><br/> |
+| `display_timezone` (opcional) | String | "GMT-04" | <br/>Este campo determina la fecha y la hora que se visualiza en los reportes. Si no configuras este campo con una zona horaria, el sistema tomará por defecto el valor GMT-04. Si eliges una zona horaria que utiliza horario de verano, es necesario que hagas el ajuste manual cuando cambie la hora.<br/><br/> |
+| `include_withdraw` | Boolean | true | <br/>Este parámetro nos permite ignorar (false) o incluir (true) los retiros de dinero en el reporte.<br/><br/> |
+| `report_translation` (opcional) | String | "es" | <br/>Permite cambiar el idioma predeterminado de los encabezados de las columnas. En caso de habilitarlo, se recomienda verificar que funcionen correctamente las integraciones con archivos de Excel (.xlsx) que permiten conciliar de forma automática.<br/><br/> Si la integración no funciona bien, asegúrate de actualizarla tomando como referencia los nuevos encabezados.<br/><br/> |
+| `frequency` | JSON | ```{ "hour": 0, "type": "monthly", "value": 1 }``` | <br/>Indica la frecuencia diaria, semanal o mensual de los reportes programados.<br/><br/> - `frequency` aplica type *monthly* al día del mes o *weekly* el día de la semana<br/> - `hour` hora del día en la que generar el reporte <br/> - `type` indica el tipo de frecuencia *daily* (diaria), *weekly* (semanal) y *monthly* (mensual).<br/><br/> |
+| *`refund_detailed` (opcional)* | Boolean | true | <br/>Muestra el código de referencia (`external_reference`) del reembolso en vez del código de referencia (`external_reference`) del pago.<br/><br/> |
+| `scheduled` (read_only) | Boolean | true | <br/>Campo informativo que indica si ya existen reportes programados en la cuenta de usuario.<br/> `True` la generación automática se encuentra activada. <br/> `False` la generación automática se encuentra Desactivada.<br/><br/> |
+| *`separator` (opcional)* | String | ";" | <br/>Separador que puedes usar en el archivo .csv cuando no quieras que el separador sea una coma. <br/><br/> |
+| `notification_email_list` (opcional) | Array | ```["example@email.com", "john@example.com"]``` | <br/>Permite agregar un grupo de destinatarios de correo electrónico para que reciban una notificación cuando un reporte está listo y disponible para descargar. Asegúrate de incluir el correo asociado a tu cuenta de Mercado Pago para que también recibas las notificaciones.<br/><br/> |
+| *`sftp_info` (opcional)* | JSON | ```{ "server": "sftp.myserver.com", "password": "mypassword", "remote_dir": "/myfolder", "port": 22, "username": "myusername" }``` | <br/>Indica los datos de subida a SFTP cuando lo necesites.<br/><br/> |
+| *`shipping_detail` (opcional)* | Boolean | true | <br/> Incluye el detalle de los envíos <br/> <br/>|
+| *`show_chargeback_cancel` (opcional)* | Boolean | true | <br/> Incluye el detalle de las cancelaciones de los contracargos <br/> <br/>|
+| *`show_fee_prevision` (opcional)* | Boolean | true | <br/> Incluye el detalle de las comisiones <br/> <br/>|
 
 Puedes configurar tus reportes según sea necesario. A continuación, destacamos las llamadas de la API disponibles para que puedas gestionar la configuración de tu reporte y, posteriormente, en función de esas configuraciones, generar los reportes.