Acuerdos de compensación

La base de una compensación: partes, compensación bilateral o tripartita, número y fecha del contrato, vigencia y calendario de la compensación periódica.

Cargando el índice de búsqueda…

Acuerdos de compensación

Objetos

SettlementAgreement

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • kindstringobligatorio

    bilateral: compensación bilateral, el proveedor y el cliente son la misma persona; tripartite: compensación tripartita, la deuda del cliente se compensa con la deuda de la tienda con otra persona, el proveedor, con el acuerdo de las tres partes.

    Valores:
    bilateraltripartite
  • legal_entity_idintegerobligatorio

    Razón social de la tienda que es parte del acuerdo (/v1/legal-entities).

  • supplier_idintegerobligatorio

    ID del proveedor acreedor (/v1/suppliers).

  • customer_idinteger o null

    ID del cliente deudor (/v1/customers); null si el cliente fue borrado. Solo con acceso a clientes.

  • customer_namestring

    Nombre del cliente al crear el acuerdo. Solo con acceso a clientes.

  • referencestring o nullobligatorio

    Número del acuerdo firmado; null si no se cargó.

  • signed_onstring (date) o nullobligatorio

    Fecha de firma, AAAA-MM-DD; null si no se cargó.

  • valid_fromstringobligatorio

    Inicio de la vigencia, AAAA-MM-DD.

  • valid_untilstring o nullobligatorio

    Fin de la vigencia, AAAA-MM-DD inclusive; null: sin vencimiento.

  • schedulestringobligatorio

    Compensación periódica: manual, solo a mano; weekly, una vez por semana; monthly, una vez por mes.

    Valores:
    manualweeklymonthly
  • schedule_dayinteger o nullobligatorio

    Día de la corrida: en weekly, el día de la semana ISO (1, lunes); en monthly, el día del mes 1–31 (en un mes más corto, el último); null en manual.

  • next_run_onstring (date) o nullobligatorio

    Fecha de la próxima compensación periódica, AAAA-MM-DD en la zona horaria de la tienda; null: no habrá más corridas.

  • notestring o nullobligatorio

    Nota del personal; null si no hay.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuándo cambió el registro por última vez.

Endpoints

Acuerdos de compensación: partes, tipo, datos del contrato, vigencia y calendario

get/settlement-agreements

Scope: procurement:read

Parámetros

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.

    Largo máximo:
    4096
  • updated_sincestring (date-time)

    Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.

    Patrón:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.

  • supplier_idinteger

    Solo documentos de este proveedor.

    Mínimo:
    1

Respuestas

200Éxito

application/json

  • dataarray de SettlementAgreementobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.

    Campos · 2
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/settlement-agreements" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "kind": "bilateral",
      "legal_entity_id": 0,
      "supplier_id": 0,
      "customer_id": 0,
      "customer_name": "string",
      "reference": "string",
      "signed_on": "2026-01-15",
      "valid_from": "string",
      "valid_until": "string",
      "schedule": "manual",
      "schedule_day": 0,
      "next_run_on": "2026-01-15",
      "note": "string",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Acuerdo de compensación

get/settlement-agreements/{settlement_agreement}

Scope: procurement:read

Parámetros

Ruta

  • settlement_agreementintegerobligatorio

    ID del acuerdo de compensación.

Respuestas

200Éxito

application/json

Devuelve SettlementAgreement

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/settlement-agreements/{settlement_agreement}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "kind": "bilateral",
  "legal_entity_id": 0,
  "supplier_id": 0,
  "customer_id": 0,
  "customer_name": "string",
  "reference": "string",
  "signed_on": "2026-01-15",
  "valid_from": "string",
  "valid_until": "string",
  "schedule": "manual",
  "schedule_day": 0,
  "next_run_on": "2026-01-15",
  "note": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}