Syntage DS MX RPC Entidades API

openapi: 3.0.2
info:
  version: '2020-06-28'
  title: Syntage Accounts Payable Insight DS MX RPC Entidades API
  contact:
    name: Email
    email: support@syntage.com
  description: "# Introduction\n\nThe Syntage API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer).\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns [JSON-LD](https://json-ld.org) responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Environments\n\n| Name | Description | Base URL |\n|------|-------------|----------|\n| **Sandbox** | The Sandbox environment is dedicated to development and testing. In this environment, no real taxpayer credentials are required and all interaction with the SAT is simulated generating life-like data, allowing you to pull test data from all endpoints. | https://api.sandbox.syntage.com |\n| **Production** | The Production environment is dedicated to live applications with real connections to the SAT. In this environment, real taxpayer credentials are required, and you will pull real fiscal data directly from the SAT. | https://api.syntage.com |\n\nEach environment has a different API Key for [authentication](#section/Authentication).\n\n# Request IDs\n\nEach API request has an associated request identifier.\nYou can find this value in the response headers, under `X-Request-ID`:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-Request-ID: Root=1-6532dcae-169bf139354cd48959f55c55\n```\n\nIf you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n# Rate Limiting\n\nOur API employs a number of safeguards against bursts of incoming traffic to help maximize its stability.\nThe returned HTTP headers of any API request show your current rate limit status:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 56\nX-RateLimit-Reset: 1606678044\n```\n\n| Header Name           | Description |\n|-----------------------|------------------------------------------------------------------------------|\n| X-RateLimit-Limit     | The maximum number of requests you're permitted to make.                     |\n| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window.           |\n| X-RateLimit-Reset     | The time at which the current rate limit window resets in UTC epoch seconds. |\n\nIf you exceed the rate limit, a [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) response is returned:\n\n```http\nHTTP/1.1 429 Too Many Requests\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1606678044\n```\n\nWe may reduce limits to prevent abuse, or increase limits to enable high-traffic operations.\nYou can check your current limits in the [dashboard](https://app.syntage.com/settings/usage).\nTo request an increased rate limit, please [contact support](https://support.syntage.com/).\n# Pagination\nWhen issuing a GET request on a collection containing more than 1 page (e.g. [/events](#operation/ListEvent)),  a collection is returned. Links to the first, the last, previous and the next page in the collection are displayed as well as the  number of total items in the collection.\nAll endpoints that support this operation have a query parameter defined by:\n  - `itemsPerPage` The number of items per page (default: 20, max: 1000)\n  - `page` The collection page number\n\n```bash\n  \"hydra:totalItems\": 1,\n  \"hydra:view\": {\n    \"@id\": \"/events?page=1\",\n    \"@type\": \"hydra:PartialCollectionView\",\n    \"hydra:first\": \"/events?page=1\",\n    \"hydra:next\": \"/events?page=2\",\n    \"hydra:last\": \"/events?page=3\"\n  },\n```\n## Cursor Pagination\nCursor pagination is a technique used for navigating through large datasets efficiently. It allows you to retrieve a specific subset of results from a collection by using a cursor value that represents the position within the collection. The cursor serves as a reference point for fetching the next or previous set of results.\n### Benefits of Cursor Pagination:\n1. **Efficient Navigation:** Cursor pagination eliminates the need to fetch the entire dataset at once, making it more scalable and faster. You can retrieve data in smaller, manageable chunks based on the cursor values.\n2. **Consistent Results:** Each page of results in cursor pagination is stable and doesn't change even if new items are added or removed from the collection. This ensures that you get consistent and reliable results.\n3. **Flexibility:** Cursors can be used to navigate forwards and backwards in the collection without impacting performance.\n\n### How to Use Cursor Pagination:\nTo use cursor pagination with our API, follow these instructions:\n1. Make a request to retrieve the initial page of results. The response will be a JSON-LD document that includes a `hydra:next` attribute with the URI for the next page. The URI already includes the cursor attribute.\n2. To retrieve the next page of results, make a GET request to the URI provided in the `hydra:next` attribute. This URI will automatically include the cursor value for the next page.\n3. If you want to navigate to the previous page, you can use the `hydra:previous` attribute in the JSON-LD response. It will contain the URI for the previous page, including the cursor value.\n4. You can continue making requests to the `hydra:next` and `hydra:previous` URIs to navigate through the paginated results, based on your requirements.\nMake sure to update your request headers to include the necessary headers for JSON-LD content negotiation, such as `Accept: application/ld+json` or `Content-Type: application/ld+json`.\nBy following these instructions, you can effectively navigate through the paginated results using the cursor values provided in the `hydra:next` and `hydra:previous` attributes, without the need to manually include the cursor in your requests. This simplifies the pagination process and enhances the usability of our API.\n\n### Considerations About Cursor Pagination:\n\n  - By default, the API uses offset-based pagination (except for a few endpoints that we will list below). If you want to switch to cursor pagination, you need to include an additional header in your request. Set the `X-Pagination-Style` header with the value `\"cursor\"` to enable cursor pagination. If not specified, the API will assume offset-based pagination.\n\n  - After enabling cursor pagination, the API response will no longer include the `hydra:totalItems` field by default. Retrieving the total count can be resource intensive and impact response times, especially for large datasets. However, if you need the `hydra:totalItems` information, you can include an additional header in your request. Set the `X-Pagination-Enable-Partial` header with the value `0` to indicate that the response should include extra information, including the `hydra:totalItems` count. Please be aware that enabling this feature may impact API response times, as the backend needs to perform a count operation on the dataset.\n\nIf you require the `hydra:totalItems` count, please consider the potential impact on API response times.\n### Example\n```bash\n  curl -i 'https://api.syntage.com/entities/{entityId}/invoices?itemsPerPage=10' \\\n    --header 'Accept: application/ld+json' \\\n    --header 'X-Api-Key: {apiKey}' \\\n    --header 'X-Pagination-Style: cursor' \\\n    --header 'X-Pagination-Enable-Partial: 0'\n```\n**Note:** We only support cursor pagination for the following endpoints:\n - `GET /entities/{entityId}/invoices`\n - `GET /entities/{entityId}/invoices/line-items`\n - `GET /entities/{entityId}/invoices/{invoiceId}/line-items`\n - `GET /invoices/{invoiceId}/line-items`\n - `GET /entities/{entityId}/invoices/payments`\n\nFeel free to reach out if you have any further questions or need additional assistance!\n\n# Property Filtering\nThe property filter adds the possibility to select the properties for GET operations.\nSyntax: `?properties[]=<property>&properties[<relation>][]=<property>`\nYou can add as many properties as you need. The following example shows how to select `paymentType` and  `issuer.rfc` when fetching a list of invoices.\n```curl\n  curl -i https://api.syntage.com/entities/{entityId}/invoices?properties[]=paymentType&properties[issuer]=rfc\n```\n# Filtering\n**Warning:** Collection endpoints only apply the filter query parameters documented for that endpoint. If you send an unsupported or misspelled filter query parameter, the API ignores it and processes the request as if that parameter was not sent.\n\n# API Versioning Guide\nGuidance on changes between versions.\n## Version: 2020-01-01 to 2020-06-28\n### **Invoice**\n_**Affected Endpoints:** `GET /invoices/{id}` and `GET /entities/{entityId}/invoices`_\n- The `amount` property has been removed from API responses. Use the `total` property instead.\n- Retrieval by invoice's `uuid` at `/invoices/{id}` is now removed. To retrieve an invoice, use the invoice's `id` at the specified endpoint. To find an invoice using its `uuid`, filter the invoice collection at `/entities/{entityId}/invoices?uuid[]={uuid}`.\n- Previously, the `@iri` property for an invoice pointed to the resource using `uuid`, like `/invoices/{uuid}`. Now, it points using its `id`, like `/invoices/{id}`.\n\n### **Entity (Formerly Link)**\n_**Affected Endpoint:** `GET /entities`_\n- Filtering entities by `status` is removed. Use `credential.status` instead. For example, utilize `GET /entities?credential.status[]=active` instead of `GET /entities?status[]=active`.\n\n### **Tax Return**\n_**Affected Endpoints:** `GET /tax-returns/{id}` and `GET /entities/{entityId}/tax-returns`_\n- Retrieval by tax return's `operationNumber` at `/tax-returns/{id}` is removed. To retrieve a tax return, use the tax return's `id` at the mentioned endpoint. To find a tax return using its `operationNumber`, filter the collection at `/entities/{entityId}/tax-returns?operationNumber[]={operationNumber}`.\n- Previously, the `@iri` property for a tax return pointed to the resource using `operationNumber`, like `/tax-returns/{operationNumber}`. Now, it directs to its `id`, like `/tax-returns/{id}`.\n\n### **Event**\n_**Affected Endpoints:** `GET /events` and `GET /events/{id}`_\n- For events associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}` instead of the previous `/tax-returns/{operationNumber}`.\n- For events associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}` instead of the previous `/invoices/{uuid}`.\n\n### **Extraction**\n_**Affected Endpoints:** `GET /extractions` and `GET /extractions/{id}`_\n- The `periodFrom` property has been removed. Use `options.period.from` instead.\n- The `periodTo` property has been removed. Use `options.period.to` instead.\n\n### **File**\n_**Affected Endpoint:** `GET /file/{id}`_\n- For files associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}`, instead of the previous `/tax-returns/{operationNumber}`.\n- For files associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}`, instead of the previous `/invoices/{uuid}`.\n\n### Trying Out This Version\nIf you want to test this version, you can do so by making any request with the `Accept-Version` header pointing to the latest version:\n```curl\n  curl -i 'https://api.syntage.com/entities/{entityId}/invoices' \\\n    --header 'Accept-Version: 2020-06-28' \\\n    --header 'X-Api-Key: {apiKey}'\n```\n"
servers:
- url: https://api.syntage.com
  description: Production
- url: https://api.sandbox.syntage.com
  description: Sandbox
security:
- ApiKey: []
tags:
- name: DS MX RPC Entidades
  description: 'RPC entidades are company records extracted from the Registro Publico de Comercio. They group registration profile data, related registry acts, and shareholder records found for an entity.

    '
paths:
  /datasources/mx/rpc/entidades/{id}:
    get:
      tags:
      - DS MX RPC Entidades
      operationId: GetRpcEntidades
      summary: Retrieve RPC entidade
      description: Retrieve one RPC entidade by ID, including the company profile, related actos, and related socios extracted from Registro Publico de Comercio.
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          $ref: '#/components/responses/RpcEntidade'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /entities/{entityId}/datasources/mx/rpc/entidades:
    get:
      tags:
      - DS MX RPC Entidades
      operationId: ListRpcEntidades
      summary: List an entity's RPC entidades
      description: List RPC entidades extracted for an entity. Use this endpoint after an `rpc` extraction finishes to review the RPC company records found for the entity.
      parameters:
      - $ref: '#/components/parameters/entityId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - name: lookupBy
        in: query
        description: Filter by RPC lookup type (exact match)
        schema:
          $ref: '#/components/schemas/RpcEntidadeLookupBy'
      responses:
        '200':
          $ref: '#/components/responses/TaxpayerRpcEntidadeCollection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    RpcEntidadeEstatusFme:
      type: string
      description: RPC folio status
      nullable: true
      example: Abierto
    RpcEntidadeRegimenJuridico:
      type: string
      description: Legal regime reported by RPC
      nullable: true
      example: Sociedad Anónima
    RpcEntidadeTipoDePersona:
      type: string
      description: Type of person reported by RPC
      example: Moral
    RpcEntidadeSocio:
      type: object
      description: Shareholder or partner record nested in an RPC entidade response
      properties:
        id:
          type: string
          format: uuid
          description: RPC socio ID
          example: 91106968-1abd-4d64-85c1-4e73d96fb997
        estatus:
          type: string
          description: Shareholder status reported by RPC
          nullable: true
          example: Activo
        nacionalidad:
          type: string
          description: Shareholder nationality reported by RPC
          nullable: true
          example: Mexicana
        nombre:
          type: string
          description: Shareholder given name or company name
          nullable: true
          example: FOO BAR
        apellidoPaterno:
          type: string
          description: Shareholder paternal surname
          nullable: true
        apellidoMaterno:
          type: string
          description: Shareholder maternal surname
          nullable: true
        rfc:
          type: string
          description: Shareholder RFC when reported by RPC
          nullable: true
        curp:
          type: string
          description: Shareholder CURP when reported by RPC
          nullable: true
        serie:
          type: string
          description: Share series reported by RPC
          nullable: true
          example: A
        fechaDeConstitucion:
          type: string
          description: Incorporation date when the shareholder is a company
          nullable: true
          example: 04/05/2016
        fechaDeNacimiento:
          type: string
          description: Birth date when the shareholder is a person
          nullable: true
        acciones:
          type: string
          description: Number of shares reported by RPC
          nullable: true
          example: '999'
        total:
          type: string
          description: Total share amount reported by RPC
          nullable: true
          example: '19000.0'
        valor:
          type: string
          description: Share value reported by RPC
          nullable: true
          example: '19000.0'
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    TaxpayerRpcEntidadeCollection:
      allOf:
      - $ref: '#/components/schemas/CursorCollection'
      - type: object
        properties:
          '@context':
            default: /contexts/RpcEntidade
          '@id':
            default: /entities/{entityId}/datasources/mx/rpc/entidades
            example: /entities/91106968-1abd-4d64-85c1-4e73d96fb997/datasources/mx/rpc/entidades
          hydra:member:
            items:
              $ref: '#/components/schemas/RpcEntidade'
    RpcEntidadeFechaDeInscripcion:
      type: string
      format: date-time
      description: Registration date reported by RPC
      nullable: true
      example: 01/01/2017 12:00:00 T.CENTRO
    RpcEntidadeEntidadFederativa:
      type: string
      description: Mexican state where the registry record is held
      nullable: true
      example: Jalisco
    RpcEntidadeNacionalidad:
      type: string
      description: Company nationality reported by RPC
      nullable: true
      example: Mexicana
    updatedAt:
      type: string
      description: Date and time the resource was last updated
      example: '2020-01-01T12:15:00.000Z'
    RpcEntidadeRfc:
      type: string
      description: RFC reported by RPC
      nullable: true
      example: PEIC211118IS0
    RpcEntidadeFme:
      type: string
      description: Electronic commercial folio assigned by RPC
      nullable: true
      example: N-2000000000
    CollectionLimit:
      type: integer
      default: 20
      minimum: 1
      maximum: 1000
    RpcEntidadeDuracionDeLaSociedad:
      type: string
      description: Company duration reported by RPC
      nullable: true
      example: INDEFINIDA
    RpcEntidadeDomicilioSocial:
      type: string
      description: Registered social domicile
      nullable: true
      example: Zona Metropolitana ...
    RpcEntidadeActo:
      type: object
      description: Registry act nested in an RPC entidade response
      properties:
        id:
          type: string
          format: uuid
          description: RPC acto ID
          example: 91106968-1abd-4d64-85c1-4e73d96fb997
        formaPrecodificada:
          type: string
          description: RPC pre-coded form for the act
          nullable: true
          example: M0 - ...
        acto:
          type: string
          description: Name or type of registry act
          nullable: true
        nci:
          type: string
          description: NCI reported by RPC
          nullable: true
        fechaDeIngreso:
          type: string
          format: date-time
          description: Date and time the act was submitted to RPC
          nullable: true
          example: 01/01/2017 12:00:00 T.CENTRO
        fechaDeInscripcion:
          type: string
          format: date-time
          description: Date and time the act was registered by RPC
          nullable: true
          example: 01/01/2017 12:00:00 T.CENTRO
        numeroDeDocumento:
          type: string
          description: Document number reported by RPC
          nullable: true
        modalidad:
          type: string
          description: Act modality reported by RPC
          nullable: true
        data:
          type: object
          description: Parsed act data from RPC
          nullable: true
          additionalProperties: true
        file:
          $ref: '#/components/schemas/File'
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    RpcEntidadeObjetoSocial:
      type: string
      description: Corporate purpose reported by RPC
      nullable: true
      example: a) La operación, administración, comercialización...
    createdAt:
      type: string
      description: Date and time the resource was created
      example: '2020-01-01T12:15:00.000Z'
    RpcEntidadeLookupBy:
      type: string
      description: Search source that produced the RPC entidade
      enum:
      - entity
      - shareholder
      example: entity
    RpcEntidadeAntecedenteRegistral:
      type: string
      description: Prior registry reference reported by RPC
      nullable: true
    File:
      type: object
      properties:
        '@id':
          type: string
          format: iri-reference
          description: File IRI reference
          example: /files/91106968-1abd-4d64-85c1-4e73d96fb997
        '@type':
          type: string
          description: JSON-LD resource type
          default: File
          example: File
        id:
          type: string
          format: uuid
          description: Unique file ID
          example: 91106968-1abd-4d64-85c1-4e73d96fb997
        type:
          type: string
          description: File category, such as an invoice CFDI XML or PDF
          example: invoice.cfdi.xml
        resource:
          type: string
          description: IRI of the resource that produced or owns the file
          example: /invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9
        mimeType:
          type: string
          description: Media type of the file content
          example: text/xml
        extension:
          type: string
          description: File extension for the stored content
          example: xml
        size:
          type: integer
          description: File size in bytes
          example: 40544
        filename:
          type: string
          description: Suggested filename for the file content
          example: 6f3c5312-2849-4525-86f6-c48a54c64c60.xml
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    RpcEntidadeCurp:
      type: string
      description: CURP reported by RPC when present
      nullable: true
    CursorCollection:
      type: object
      properties:
        '@context':
          type: string
        '@id':
          type: string
        '@type':
          type: string
          default: hydra:Collection
        hydra:member:
          type: array
          items:
            type: object
        hydra:view:
          type: object
          description: Pagination information
          properties:
            '@id':
              type: string
              format: iri-reference
              description: Current page IRI reference
            '@type':
              type: string
              default: hydra:PartialCollectionView
            hydra:next:
              type: string
              example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367
              description: Next page IRI reference; omitted when there is no pagination
            hydra:last:
              type: string
              example: /entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367
              description: Last page IRI reference; omitted when there is no pagination
        hydra:search:
          type: object
          properties:
            '@type':
              type: string
            hydra:template:
              type: string
            hydra:variableRepresentation:
              type: string
            hydra:mapping:
              type: array
              items:
                type: object
                properties:
                  '@type':
                    type: string
                  variable:
                    type: string
                  property:
                    type: string
                  required:
                    type: boolean
    RpcEntidade:
      type: object
      description: Company record extracted from the Registro Publico de Comercio
      properties:
        '@id':
          type: string
          format: iri-reference
          description: RPC entidade IRI reference
          example: /datasources/mx/rpc/entidades/99c13810-868f-482e-a6f1-878254248d27
        '@type':
          type: string
          default: RpcEntidade
        id:
          $ref: '#/components/schemas/RpcEntidadeID'
        fme:
          $ref: '#/components/schemas/RpcEntidadeFme'
        nombreRazonSocial:
          $ref: '#/components/schemas/RpcEntidadeNombreRazonSocial'
        objetoSocial:
          $ref: '#/components/schemas/RpcEntidadeObjetoSocial'
        duracionDeLaSociedad:
          $ref: '#/components/schemas/RpcEntidadeDuracionDeLaSociedad'
        domicilioSocial:
          $ref: '#/components/schemas/RpcEntidadeDomicilioSocial'
        nacionalidad:
          $ref: '#/components/schemas/RpcEntidadeNacionalidad'
        estatusFme:
          $ref: '#/components/schemas/RpcEntidadeEstatusFme'
        rfc:
          $ref: '#/components/schemas/RpcEntidadeRfc'
        tipoDePersona:
          $ref: '#/components/schemas/RpcEntidadeTipoDePersona'
        antecedenteRegistral:
          $ref: '#/components/schemas/RpcEntidadeAntecedenteRegistral'
        regimenJuridico:
          $ref: '#/components/schemas/RpcEntidadeRegimenJuridico'
        giro:
          $ref: '#/components/schemas/RpcEntidadeGiro'
        entidadFederativa:
          $ref: '#/components/schemas/RpcEntidadeEntidadFederativa'
        municipio:
          $ref: '#/components/schemas/RpcEntidadeMunicipio'
        oficinaRegistral:
          $ref: '#/components/schemas/RpcEntidadeOficinaRegistral'
        fechaDeInscripcion:
          $ref: '#/components/schemas/RpcEntidadeFechaDeInscripcion'
        curp:
          $ref: '#/components/schemas/RpcEntidadeCurp'
        lookupBy:
          $ref: '#/components/schemas/RpcEntidadeLookupBy'
        actos:
          type: array
          description: Registry acts found for this RPC entidade
          items:
            $ref: '#/components/schemas/RpcEntidadeActo'
        socios:
          type: array
          description: Shareholder or partner records found for this RPC entidade
          items:
            $ref: '#/components/schemas/RpcEntidadeSocio'
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    RpcEntidadeMunicipio:
      type: string
      description: Municipality where the registry record is held
      nullable: true
      example: Guadalajara
    RpcEntidadeGiro:
      type: string
      description: Business activity reported by RPC
      nullable: true
    RpcEntidadeID:
      type: string
      format: uuid
      description: RPC Entidade ID
      example: 99c13810-868f-482e-a6f1-878254248d27
    RpcEntidadeNombreRazonSocial:
      type: string
      description: Legal name reported by RPC
      nullable: true
      example: FOO BAR, S.A. DE C.V.
    RpcEntidadeOficinaRegistral:
      type: string
      description: Registry office that holds the record
      nullable: true
      example: Guadalajara
  parameters:
    collectionCursorNextPageParam:
      name: id[lt]
      in: query
      required: false
      example: 91106968-1abd-4d64-85c1-4e73d96fb997
      description: Collection cursor pointer to the next page
      schema:
        type: string
    collectionLimit:
      name: itemsPerPage
      in: query
      required: false
      description: Number of items per page
      schema:
        $ref: '#/components/schemas/CollectionLimit'
    collectionCursorPreviousPageParam:
      name: id[gt]
      in: query
      required: false
      example: 91106968-1abd-4d64-85c1-4e73d96fb997
      description: Collection cursor pointer to the previous page
      schema:
        type: string
    resourceId:
      name: id
      in: path
      required: true
      example: 91106968-1abd-4d64-85c1-4e73d96fb997
      schema:
        type: string
        format: uuid
    entityId:
      name: entityId
      in: path
      required: true
      example: 91106968-1abd-4d64-85c1-4e73d96fb997
      schema:
        type: string
        format: uuid
  responses:
    RpcEntidade:
      description: RPC entidade resource response
      content:
        application/ld+json:
          schema:
            allOf:
            - type: object
              properties:
                '@context':
                  type: string
                  default: /contexts/RpcEntidade
            - $ref: '#/components/schemas/RpcEntidade'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    TaxpayerRpcEntidadeCollection:
      description: RPC entidades collection response
      content:
        application/ld+json:
          schema:
            $ref: '#/components/schemas/TaxpayerRpcEntidadeCollection'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.

        '
x-readme:
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true