List an entity's RUG guarantees

curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/datasources/rug/garantias \
  --header 'X-API-Key: <api-key>'

{
  "@context": "/contexts/RugGarantia",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/rug/garantias",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/datasources/rug/garantias/99c13810-868f-482e-a6f1-878254248d27",
      "@type": "RugGarantia",
      "id": "99c13810-868f-482e-a6f1-878254248d27",
      "numeroDeGarantia": 123456,
      "fechaDeInscripcion": "2021-10-12T19:58:11.000Z",
      "fechaDeCancelacion": "2023-03-12T00:00:00.000Z",
      "otorgantes": [
        {
          "nombre": "El Otorgante de Garantías Mobiliarias, S.A. de C.V.",
          "folioElectronico": "34011*7"
        }
      ],
      "acreedor": "Grupo Financiero Acreedor, S.A.P.I. de C.V., SOFOM E.N.R.",
      "tipoDeGarantia": "factoraje_financiero",
      "monto": 12345.67,
      "moneda": "peso_mexicano",
      "tipoDeLosBienes": [
        "derechos_incluyendo_derechos_de_cobro"
      ],
      "descripcionDeLosBienes": "Factura con el folio fiscal 99c13810-868f-482e-a6f1-878254248d27",
      "fechaDeCelebracionDelActoOContrato": "2021-03-08T00:00:00.000Z",
      "fechaDeTerminacionDelActoOContrato": "2022-03-08T00:00:00.000Z",
      "operaciones": [
        {
          "@id": "/datasources/rug/operaciones/99c13810-868f-482e-a6f1-878254248d27",
          "@type": "RugOperacion",
          "id": "99c13810-868f-482e-a6f1-878254248d27",
          "numeroDeAsiento": 12345678,
          "tipo": "inscripcion",
          "fecha": "2021-10-12T00:00:00.000Z",
          "file": "/files/99c13810-868f-482e-a6f1-878254248d27",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

GET

entities

{entityId}

datasources

rug

garantias

List an entity's RUG guarantees

curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/datasources/rug/garantias \
  --header 'X-API-Key: <api-key>'

{
  "@context": "/contexts/RugGarantia",
  "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/rug/garantias",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/datasources/rug/garantias/99c13810-868f-482e-a6f1-878254248d27",
      "@type": "RugGarantia",
      "id": "99c13810-868f-482e-a6f1-878254248d27",
      "numeroDeGarantia": 123456,
      "fechaDeInscripcion": "2021-10-12T19:58:11.000Z",
      "fechaDeCancelacion": "2023-03-12T00:00:00.000Z",
      "otorgantes": [
        {
          "nombre": "El Otorgante de Garantías Mobiliarias, S.A. de C.V.",
          "folioElectronico": "34011*7"
        }
      ],
      "acreedor": "Grupo Financiero Acreedor, S.A.P.I. de C.V., SOFOM E.N.R.",
      "tipoDeGarantia": "factoraje_financiero",
      "monto": 12345.67,
      "moneda": "peso_mexicano",
      "tipoDeLosBienes": [
        "derechos_incluyendo_derechos_de_cobro"
      ],
      "descripcionDeLosBienes": "Factura con el folio fiscal 99c13810-868f-482e-a6f1-878254248d27",
      "fechaDeCelebracionDelActoOContrato": "2021-03-08T00:00:00.000Z",
      "fechaDeTerminacionDelActoOContrato": "2022-03-08T00:00:00.000Z",
      "operaciones": [
        {
          "@id": "/datasources/rug/operaciones/99c13810-868f-482e-a6f1-878254248d27",
          "@type": "RugOperacion",
          "id": "99c13810-868f-482e-a6f1-878254248d27",
          "numeroDeAsiento": 12345678,
          "tipo": "inscripcion",
          "fecha": "2021-10-12T00:00:00.000Z",
          "file": "/files/99c13810-868f-482e-a6f1-878254248d27",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Authorizations

X-API-Key

string

header

required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId

string<uuid>

required

Query Parameters

id[lt]

string

Collection cursor pointer to the next page

id[gt]

string

Collection cursor pointer to the previous page

itemsPerPage

integer

default:20

Number of items per page

Required range: 1 <= x <= 1000

numeroDeGarantia

number

RUG guarantee number

Example:

123456

acreedor

string

Creditor name reported for the guarantee

Example:

"Grupo Financiero Acreedor, S.A.P.I. de C.V., SOFOM E.N.R."

tipoDeGarantia

enum<string>

Type of movable collateral guarantee

Available options:

cesion_de_creditos,

clausulas_rescisoria_y_de_reserva_de_dominio_en_compraventas_mercantiles,

constituida_sobre_aeronave,

constituida_sobre_embarcacion,

derechos_de_retencion,

derivada_de_un_arrendamiento_financiero,

derivada_de_un_credito_de_habilitacion_o_avio,

derivada_de_un_credito_refaccionario,

derivada_de_un_fideicomiso_de_garantia,

derivada_de_una_hipoteca_industrial,

factoraje_financiero,

otros_actos_gravamenes_o_afectaciones_sobre_bienes_muebles_en_los_que_el_acreedor_no_mantenga_la_posesion_sobre_los_mismos

prenda_ordinaria_mercantil_cuando_el_acreedor_prendario_no_mantenga_la_posesion_sobre_los_bienes,

prenda_sin_transmision_de_posesion,

privilegios_especiales

Example:

"factoraje_financiero"

moneda

string | null

Currency reported for the guaranteed amount

Example:

"peso_mexicano"

descripcionDeLosBienes

string

Description of the collateral goods covered by the guarantee

Example:

"Factura con el folio fiscal 99c13810-868f-482e-a6f1-878254248d27"

fechaDeInscripcion[before]

string<date-time>

Date and time the guarantee was registered

Example:

"2021-10-12T19:58:11.000Z"

fechaDeInscripcion[strictly_before]

string<date-time>

Date and time the guarantee was registered

Example:

"2021-10-12T19:58:11.000Z"

fechaDeInscripcion[after]

string<date-time>

Date and time the guarantee was registered

Example:

"2021-10-12T19:58:11.000Z"

fechaDeInscripcion[strictly_after]

string<date-time>

Date and time the guarantee was registered

Example:

"2021-10-12T19:58:11.000Z"

fechaDeCancelacion[before]

string<date-time> | null

Date and time the guarantee was cancelled

Example:

"2023-03-12T00:00:00.000Z"

fechaDeCancelacion[strictly_before]

string<date-time> | null

Date and time the guarantee was cancelled

Example:

"2023-03-12T00:00:00.000Z"

fechaDeCancelacion[after]

string<date-time> | null

Date and time the guarantee was cancelled

Example:

"2023-03-12T00:00:00.000Z"

fechaDeCancelacion[strictly_after]

string<date-time> | null

Date and time the guarantee was cancelled

Example:

"2023-03-12T00:00:00.000Z"

fechaDeCelebracionDelActoOContrato[before]

string<date-time> | null

Date the act or contract was executed

Example:

"2021-03-08T00:00:00.000Z"

fechaDeCelebracionDelActoOContrato[strictly_before]

string<date-time> | null

Date the act or contract was executed

Example:

"2021-03-08T00:00:00.000Z"

fechaDeCelebracionDelActoOContrato[after]

string<date-time> | null

Date the act or contract was executed

Example:

"2021-03-08T00:00:00.000Z"

fechaDeCelebracionDelActoOContrato[strictly_after]

string<date-time> | null

Date the act or contract was executed

Example:

"2021-03-08T00:00:00.000Z"

fechaDeTerminacionDelActoOContrato[before]

string<date-time> | null

Date the act or contract ends

Example:

"2022-03-08T00:00:00.000Z"

fechaDeTerminacionDelActoOContrato[strictly_before]

string<date-time> | null

Date the act or contract ends

Example:

"2022-03-08T00:00:00.000Z"

fechaDeTerminacionDelActoOContrato[after]

string<date-time> | null

Date the act or contract ends

Example:

"2022-03-08T00:00:00.000Z"

fechaDeTerminacionDelActoOContrato[strictly_after]

string<date-time> | null

Date the act or contract ends

Example:

"2022-03-08T00:00:00.000Z"

monto[between]

number<float> | null

Guaranteed amount

Example:

12345.67

monto[gt]

number<float> | null

Guaranteed amount

Example:

12345.67

monto[gte]

number<float> | null

Guaranteed amount

Example:

12345.67

monto[lt]

number<float> | null

Guaranteed amount

Example:

12345.67

monto[lte]

number<float> | null

Guaranteed amount

Example:

12345.67

createdAt[after]

string<date-time>

Filter by resource creation date (greater than or equal >=)

createdAt[strictly_after]

string<date-time>

Filter by resource creation date (greater than >)

createdAt[before]

string<date-time>

Filter by resource creation date (less than or equal <=)

createdAt[strictly_before]

string<date-time>

Filter by resource creation date (less than <)

updatedAt[after]

string<date-time>

Filter by the date the resource was last updated (greater than or equal >=)

updatedAt[strictly_after]

string<date-time>

Filter by the date the resource was last updated (greater than >)

updatedAt[before]

string<date-time>

Filter by the date the resource was last updated (less than or equal <=)

updatedAt[strictly_before]

string<date-time>

Filter by the date the resource was last updated (less than <)

order[createdAt]

enum<string>

Order by resource creation date

Available options:

asc,

desc

Example:

"asc"

order[updatedAt]

enum<string>

Order by resource update date

Available options:

asc,

desc

Example:

"asc"

Response

RUG garantia collection response

@context

string

default:/contexts/RugGarantia

@id

string

default:/entities/{entityId}/datasources/rug/garantias

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/rug/garantias"

@type

string

default:hydra:Collection

hydra:member

object[]

Show child attributes

hydra:view

object

Pagination information

Show child attributes

hydra:search

object

Show child attributes

Retrieve RUG guarantee Start Syntage Score calculation

⌘I