Integra tus datos
de arrendamiento.

Envía clientes, inmuebles, contratos y pagos a Artu. Consulta el avance de cada envío y resuelve los registros que requieren atención.

Configura el acceso a tu fuente

Durante la implementación, el equipo de Artu configura la fuente de integración y entrega los datos de conexión. Una fuente identifica el sistema de origen y el mapping que interpreta su información.

Esta guía describe el formato de ingesta de datos de arrendamiento para ARI.

Autentica cada solicitud

Incluye la API key en la cabecera Authorization. La credencial pertenece a la integración.

Authorization: Bearer <API_KEY>

• Utiliza HTTPS y conserva la clave en tu sistema servidor.
• No incluyas la clave en URLs, código de navegador ni registros de diagnóstico.
• El backend comprueba la organización, la fuente y la operación autorizada en cada solicitud.
• Las claves pueden revocarse o reemplazarse independientemente de otras integraciones.

Cuatro recursos relacionados

Cada pago tiene su propio externalId. Puedes enviar pagos posteriores sin repetir el contrato, cliente o inmueble ya identificados. Una referencia que no pueda resolverse requiere atención antes de que los cambios afectados puedan continuar.

leasePayment identifica un pago de arrendamiento en esta API. El mapping del reporte reúne los datos y pagos pertinentes para ARI; un contrato, un pago y una operación reportada tienen identidades distintas.

Envía un lote de datos

Genera una submissionReference antes del primer intento y consérvala para reintentar el mismo envío. La referencia es única dentro de la fuente de tu organización.

Ejecuta la solicitud

Asigna las variables de entorno con los valores entregados durante la configuración y guarda el archivo descargable como ejemplo-envio.json. Los identificadores y datos siguientes son ficticios.

curl --request POST \
  "$ARTU_BASE_URL/v1/sources/$ARTU_SOURCE_ID/submissions" \
  --header "Authorization: Bearer $ARTU_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @ejemplo-envio.json

{
  "submissionReference": "RENTALS-202609-001",
  "inputContractVersion": "1",
  "data": {
    "clients": [
      {
        "externalId": "CLI-100",
        "type": "company",
        "legalName": "INMOBILIARIA EJEMPLO SA DE CV",
        "rfc": "IEJ800101AA0",
        "nationality": "MX",
        "lineOfBusiness": "educationalServices",
        "legalRepresentative": {
          "firstName": "CARLOS",
          "lastNamePaternal": "RODRIGUEZ",
          "lastNameMaternal": "VEGA",
          "birthDate": "1980-05-22"
        },
        "address": {
          "street": "AV INSURGENTES SUR",
          "exteriorNumber": "800",
          "neighborhood": "DEL VALLE",
          "postalCode": "03100",
          "city": "CIUDAD DE MEXICO",
          "state": "CDMX",
          "country": "MX"
        },
        "phone": "+525555551234",
        "email": "cliente@example.com"
      }
    ],
    "properties": [
      {
        "externalId": "PROP-200",
        "type": "commercialWarehouse",
        "propertyFolio": "Lote 12a-Folio 001",
        "referenceValue": "25000.00",
        "address": {
          "neighborhood": "VALLEJO",
          "street": "CALLE FERROCARRIL HIDALGO",
          "exteriorNumber": "250",
          "postalCode": "07700"
        }
      }
    ],
    "leases": [
      {
        "externalId": "LEASE-300",
        "clientExternalId": "CLI-100",
        "propertyExternalId": "PROP-200",
        "startDate": "2026-01-01",
        "endDate": "2026-12-31"
      }
    ],
    "transactions": [
      {
        "externalId": "TX-900",
        "type": "leasePayment",
        "leaseExternalId": "LEASE-300",
        "paymentDate": "2026-09-01",
        "paymentForm": "immediatePayment",
        "monetaryInstrument": "interbankTransfer",
        "currency": "MXN",
        "amount": "10000.00"
      },
      {
        "externalId": "TX-901",
        "type": "leasePayment",
        "leaseExternalId": "LEASE-300",
        "paymentDate": "2026-09-05",
        "paymentForm": "immediatePayment",
        "monetaryInstrument": "interbankTransfer",
        "currency": "MXN",
        "amount": "15000.00"
      }
    ]
  }
}

Los campos y valores de catálogo usan nombres legibles en inglés; las explicaciones se presentan en español. Conserva el idioma original de los nombres, documentos y observaciones de origen.

Recibe el identificador del envío

Después de conservar el envío y su trabajo pendiente, la API devuelve:

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "submissionId": "SUB-500",
  "status": "received",
  "statusUrl": "/v1/sources/SRC-100/submissions/by-reference/RENTALS-202609-001"
}

Consulta avance y resultados

También puedes consultar con el identificador que Artu devuelve en la confirmación de recepción:

Ambas rutas consultan el mismo envío y requieren los mismos permisos.

Consulta con el sourceId y la submissionReference que utilizaste al enviar, usando la credencial de integración. Para la consulta por referencia no necesitas haber recibido la confirmación ni conocer el submissionId. La respuesta contiene el resumen y los problemas por registro.

curl "$ARTU_BASE_URL/v1/sources/SRC-100/submissions/by-reference/RENTALS-202609-001" \
  --header "Authorization: Bearer $ARTU_API_KEY"

Ejemplo: un envío que requiere atención

En este segundo caso, consulta la referencia RENTALS-202609-002 de la fuente SRC-100. El envío, identificado por Artu como SUB-501, contiene un cliente, un contrato y un pago. No incluye el inmueble PROP-200 y la referencia tampoco puede resolverse con datos existentes. La consulta muestra los problemas del contrato y del pago.

{
  "submissionId": "SUB-501",
  "submissionReference": "RENTALS-202609-002",
  "sourceId": "SRC-100",
  "summary": {
    "totalRecords": 3,
    "recordsWithIssues": 2
  },
  "records": [
    {
      "resourceType": "client",
      "externalId": "CLI-100",
      "issues": []
    },
    {
      "resourceType": "lease",
      "externalId": "LEASE-300",
      "issues": [
        {
          "code": "unresolvedReference",
          "field": "propertyExternalId",
          "message": "No se puede identificar el inmueble PROP-200 referido por el contrato.",
          "requiredAction": "Enviar los datos del inmueble o corregir su referencia en un nuevo envío."
        }
      ]
    },
    {
      "resourceType": "transaction",
      "externalId": "TX-900",
      "issues": [
        {
          "code": "unresolvedDependency",
          "field": "leaseExternalId",
          "message": "El pago depende del contrato LEASE-300, cuya preparación está retenida.",
          "requiredAction": "Resolver la referencia al inmueble del contrato; no es necesario reenviar este pago si sus datos son correctos."
        }
      ]
    }
  ]
}

summary resume los registros y las incidencias encontradas. Cada resultado identifica el registro mediante resourceType y externalId. En issues, consulta el campo afectado, el motivo y la acción necesaria.

Una lista de incidencias vacía no acredita por sí sola disponibilidad para ARI.

Reintenta sin duplicar el envío

La comparación incluye los datos y inputContractVersion. Un cambio del mapping de la fuente no convierte un reintento en reprocesamiento histórico. Las solicitudes repetidas siguen sujetas a autorización.

Distingue errores de solicitud y de datos

Los errores inmediatos explican por qué la solicitud no puede aceptarse. Los problemas de registros se consultan en records[].issues; los registros independientes pueden continuar.

Referencia de envío en conflicto

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "error": {
    "code": "submissionReferenceConflict",
    "field": "submissionReference",
    "message": "La referencia de envío ya fue utilizada con un contenido diferente.",
    "requiredAction": "Reutilizar la referencia solo con el contenido original. Para una corrección o un envío nuevo, utilizar otra referencia."
  }
}

Corrige la causa indicada. Un rechazo de la solicitud no revierte envíos anteriores. Una respuesta perdida o un fallo operativo con resultado incierto requiere recuperar el envío original antes de repetir efectos.

Campos por recurso

Consulta los campos del formato de entrada, incluidos los objetos anidados y las condiciones por tipo de cliente.

Fechas como cadenas YYYY-MM-DD; importes como cadenas decimales, sin símbolos ni separadores de miles. Omite campos opcionales sin dato; no sustituyas información desconocida por "", null o valores inventados. Los ejemplos de cada fila son independientes.

No se encontraron campos. Prueba con otro nombre o significado.