GET api/Grantor/{GrantorTaxId}

Obtener información del estatus del plan contratado por la empresa por mes actual.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GrantorTaxId

RFC de la empresa

 string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfGrantorModelApi
NameDescriptionTypeAdditional information
success

Indica si la solicitud se procesó de manera satisfactoria

 boolean

None.
message

Mensaje de la solicitud

 string

None.
messageDetail

Lista de mensajes

 Collection of string

None.
failureCode

Código de error en caso de existir

 string

None.
data

Layout de respuesta de la solicitud

 GrantorModelApi

None.

Response Formats

application/json, text/json

Sample: 
{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "GrantorTaxId": "sample string 1",
    "ShortName": "sample string 2",
    "BusinessName": "sample string 3",
    "CreationDate": "2025-11-13T08:54:21.1463205-06:00",
    "FunctionaryName1": "sample string 5",
    "FunctionaryName2": "sample string 6",
    "FunctionarySurname1": "sample string 7",
    "FunctionarySurname2": "sample string 8",
    "PlanStatus": {
      "From": "2025-11-13T08:54:21.1463205-06:00",
      "To": "2025-11-13T08:54:21.1463205-06:00",
      "Detail": {
        "ServiceCode": "sample string 1",
        "ServiceName": "sample string 2",
        "TotalIncluded": 3,
        "TotalConsumed": 4
      }
    }
  }
}

application/xml, text/xml

Sample: 
<ResponseModelApiOfGrantorModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <GrantorTaxId>sample string 1</GrantorTaxId>
    <ShortName>sample string 2</ShortName>
    <BusinessName>sample string 3</BusinessName>
    <CreationDate>2025-11-13T08:54:21.1463205-06:00</CreationDate>
    <FunctionaryName1>sample string 5</FunctionaryName1>
    <FunctionaryName2>sample string 6</FunctionaryName2>
    <FunctionarySurname1>sample string 7</FunctionarySurname1>
    <FunctionarySurname2>sample string 8</FunctionarySurname2>
    <PlanStatus>
      <From>2025-11-13T08:54:21.1463205-06:00</From>
      <To>2025-11-13T08:54:21.1463205-06:00</To>
      <Detail>
        <ServiceCode>sample string 1</ServiceCode>
        <ServiceName>sample string 2</ServiceName>
        <TotalIncluded>3</TotalIncluded>
        <TotalConsumed>4</TotalConsumed>
      </Detail>
    </PlanStatus>
  </data>
</ResponseModelApiOfGrantorModelApi>