GET api/Document/ReportFailure/{GrantorTaxId}?DateIni={DateIni}&DateEnd={DateEnd}

Obtener reporte de cargas fallidas

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GrantorTaxId

RFC de la empresa

string

Required

DateIni

Fecha de ingreso, rango inicial

date

None.

DateEnd

Fecha de ingreso, rango final

date

None.

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfListOfDataReportModelApi
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

Collection of DataReportModelApi

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": [
    {
      "ModelJSON": "sample string 1",
      "ZipCode": "sample string 2",
      "DocumentId": "08dd2e47-dcdb-3b12-522b-6e3108c3f5b4",
      "CreationDate": "2025-01-06T05:47:13.9389202-06:00",
      "CustomerTaxId": "sample string 4",
      "Errors": [
        {
          "Issuer": "sample string 1",
          "Message": "sample string 2",
          "EntityId": "sample string 3"
        },
        {
          "Issuer": "sample string 1",
          "Message": "sample string 2",
          "EntityId": "sample string 3"
        }
      ]
    },
    {
      "ModelJSON": "sample string 1",
      "ZipCode": "sample string 2",
      "DocumentId": "08dd2e47-dcdb-3b12-522b-6e3108c3f5b4",
      "CreationDate": "2025-01-06T05:47:13.9389202-06:00",
      "CustomerTaxId": "sample string 4",
      "Errors": [
        {
          "Issuer": "sample string 1",
          "Message": "sample string 2",
          "EntityId": "sample string 3"
        },
        {
          "Issuer": "sample string 1",
          "Message": "sample string 2",
          "EntityId": "sample string 3"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseModelApiOfListOfDataReportModelApi 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>
    <DataReportModelApi>
      <ModelJSON>sample string 1</ModelJSON>
      <ZipCode>sample string 2</ZipCode>
      <DocumentId>08dd2e47-dcdb-3b12-522b-6e3108c3f5b4</DocumentId>
      <CreationDate>2025-01-06T05:47:13.9389202-06:00</CreationDate>
      <CustomerTaxId>sample string 4</CustomerTaxId>
      <Errors>
        <ErrorReportModelApi>
          <Issuer>sample string 1</Issuer>
          <Message>sample string 2</Message>
          <EntityId>sample string 3</EntityId>
        </ErrorReportModelApi>
        <ErrorReportModelApi>
          <Issuer>sample string 1</Issuer>
          <Message>sample string 2</Message>
          <EntityId>sample string 3</EntityId>
        </ErrorReportModelApi>
      </Errors>
    </DataReportModelApi>
    <DataReportModelApi>
      <ModelJSON>sample string 1</ModelJSON>
      <ZipCode>sample string 2</ZipCode>
      <DocumentId>08dd2e47-dcdb-3b12-522b-6e3108c3f5b4</DocumentId>
      <CreationDate>2025-01-06T05:47:13.9389202-06:00</CreationDate>
      <CustomerTaxId>sample string 4</CustomerTaxId>
      <Errors>
        <ErrorReportModelApi>
          <Issuer>sample string 1</Issuer>
          <Message>sample string 2</Message>
          <EntityId>sample string 3</EntityId>
        </ErrorReportModelApi>
        <ErrorReportModelApi>
          <Issuer>sample string 1</Issuer>
          <Message>sample string 2</Message>
          <EntityId>sample string 3</EntityId>
        </ErrorReportModelApi>
      </Errors>
    </DataReportModelApi>
  </data>
</ResponseModelApiOfListOfDataReportModelApi>