Paso a Paso

Pre-requisito: Deberás automatizar la generación del o los archivos de tu sistema con el formato adecuado al modelo de cruce generado y acordado con Increase.

Autenticación#

Recuerda autenticarte con la cuenta de Increase en la que se haya generado el modelo de cruce que precisas usar.

Ver request

Subir archivos#

Recurso para subir los archivos a conciliar a Increase. Deberás subir y notificar cada archivo que desees conciliar. Por ejemplo, en el caso de conciliar un archivo vs IncreaseCard, solamente lo harás una vez. Si vas a comparar un archivo contra otro (A vs B), lo harás 2 veces, y si conciliaras N archivos vs M archivos, deberás realizar este request N+M veces en total.

GET https://gateway.increase.app/conciliation/api/v1/files/upload_link?file_type=reconciliation

Headers#

Content-Type: application/json
Accept: application/json
Authorization: <access_token>
curl --include \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Basic: <tu_access_token>" \
'https://gateway.increase.app/conciliation/api/v1/files/upload_link?file_type=reconciliation'

Success response

{
"base_url": "https://scrapper-production.s3.amazonaws.com",
"key": "reconciliations/1/2018-08-17T15-16-56-03-00",
"Expires": "Fri, 09 Nov 2018 20:27:31 GMT",
"Content-Type": "multipart/form-data",
"policy": "eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xMFQyMToyNzozMVoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJzY3JhcHBlci1wcm9kdWN0aW9uIn0seyJrZXkiOiJyZWNvbmNpbGlhdGlvbnMvMS8yMDE4LTA4LTE3VDE1LTE2LTU2LTAzLTAwIn0seyJFeHBpcmVzIjoiRnJpLCAwOSBOb3YgMjAxOCAyMDoyNzozMSBHTVQifSx7IkNvbnRlbnQtVHlwZSI6Im11bHRpcGFydC9mb3JtLWRhdGEifSx7IngtYW16LWNyZWRlbnRpYWwiOiJBS0lBSVBKNFBWUlVZNzVFSjJXUS8yMDE4MDkxMC91cy1lYXN0LTEvczMvYXdzNF9yZXF1ZXN0In0seyJ4LWFtei1hbGdvcml0aG0iOiJBV1M0LUhNQUMtU0hBMjU2In0seyJ4LWFtei1kYXRlIjoiMjAxODA5MTBUMjAyNzMxWiJ9XX0=",
"x-amz-credential": "AKIAIPJ4PVRUY75EJ2WQ/20180910/us-east-1/s3/aws4_request",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-date": "20180910T202731Z",
"x-amz-signature": "15615da6ac1805f1de2ed9eece2b9bd3b5dc3de825900b6a8073be15798a9764"
}

Notificar archivos subidos#

Notificar a Increase para que concilie los archivos enviando todos los parámetros en el body del request.

POST https://gateway.increase.app/conciliation/api/v1/reconciliations/notify

Headers#

Content-Type: application/json
Accept: application/json
Authorization: <access_token>

Parámetros obligatorios

ParámetroTipoDescripción
reconciliation_profile_nameStringnombre del modelo de cruce a utilizar. Deberás solicitarlo a Increase
reconciliation_profile_idStringid del modelo de cruce a utilizar. Deberás solicitarlo a Increase
simulateBooleanIndica si la conciliación es simulada o no. [Ver más][../conciliation_start/]
a_input_filesArrayArray con información del o los archivos que conformen el banco de datos "A" a conciliar.
       filenameStringNombre del archivo subido.Por ejemplo reconciliation_file_name.csv
       s3_keyStringKey de s3 obtenido al hacer el upload link.
       structure_idStringId de la estructura del archivo. Solicitar a Increase.
b_input_filesArrayArray con información del o los archivos que conformen el banco de datos "B" a conciliar.
       filenameStringNombre del archivo subido.Por ejemplo reconciliation_file_name.csv
       s3_keyStringKey de s3 obtenido al hacer el upload link.
       structure_idStringId de la estructura del archivo. Solicitar a Increase.
curl --include \
--header "Accept: application/json" \
--header "Tenant: argentina" \
--header "_SESSION:<tu_access_token>" \
--header 'Content-Type: application/json' \
-data-binary
{
"reconciliation_profile_id": 1536,
"reconciliation_profile_name": "QA Demo NvsM - cloned",
"simulate": true,
"a_input_files": [
{
"filename": "nvsm A full.csv",
"s3_key": "reconciliations/1/2019-11-15T15-35-47Z",
"structure_id": 3339
},
{
"filename": "nvsm B full.csv",
"s3_key": "reconciliations/1/2019-11-15T15-35-47Z",
"structure_id": 3338
}
],
"b_input_files": [
{
"filename": "nvsm C full.csv",
"s3_key": "reconciliations/1/2019-11-15T15-35-47Z",
"structure_id": 3337
}
]
}
'https://gateway.increase.app/conciliation/staging/api/v1/reconciliations/notify'

Buscar reporte#

Consultar en nuestra API el estado de tu reporte. Podrás descargarlo cuando pase de estado Pendiente a Finalizado.

GET https://gateway.increase.app/conciliation/api/v1/reports

Headers#

Content-Type: application/json
Accept: application/json
Authorization: Basic <access_token>
ParámetroTipoDescripción
pageintegerNúmero de página de resultados.
nameStringNombre del reporte buscado.
profile_idStringId del modelo de cruce utilizado
data_typeStringTipo de cruce realizado. Valores posibles: ["payments","movements","file"]
{
"reports": [
{
"id": "e77a1270-ac61-441e-a8a9-ea69596b01da",
"name": "Conciliación del '28-11-2019 21:14:59'[e77a1270-ac61-441e-a8a9-ea69596b01da]",
"creation_date": "2019-11-28T21:14:59.069Z",
"status": 2,
"results": null,
"data_type": "Structure::File",
"conciliation_type": "reconciliation",
"simulated": true,
"masqueraded": true,
"deleted_at": null,
"a_report_details": [],
"b_report_details": [],
"a_files_errors": [
{
"id": "a6b15414-6412-4289-81cf-ed4d7a237306",
"name": "Archivo B - Formato 2.csv",
"structure_name": "Libro Mayor",
"structure_id": 4154,
"error": {
"type": "structure",
"code": 3,
"location": "2",
"value": "Fecha de la operación",
"line": 2
}
}
],
"b_files_errors": []
}
],
"pages": 1
}

Descargar reporte#

Descargar el reporte de resultado deseado.

POST https://gateway.increase.app/conciliation/api/v1/reports/download_link,

Headers#

Content-Type: application/json
Accept: application/json
Authorization: Basic <access_token>
ParámetroTipoDescripción
report_idUUIDId de la conciliación de Increase.
report_detail_idStringId del reporte específico.