GET api/Dashboard/Outstanding/{GrantorTaxId}?beginDate={beginDate}&endDate={endDate}&groupType={groupType}

Reporte Outstanding

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GrantorTaxId

RFC del grantor

string

Required

beginDate

Fecha de inicio de busqueda

date

Required

endDate

Fecha fin de busqueda

date

Required

groupType

Agrupador ('Year','Month','Day','Week')

string

Default value is Year

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfListOfDashboardOutstandingApiModel
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 DashboardOutstandingApiModel

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": [
    {
      "grantorId": "08dd2e4a-0cf2-d469-522b-6e3108c3f91c",
      "groupType": "sample string 2",
      "groupCount": 1,
      "groupValue": "sample string 3",
      "year": 1,
      "month": 64,
      "day": 64,
      "week": 64,
      "documents": 1,
      "totalAmount": 1.0,
      "totalBalance": 1.0,
      "dueDocuments": 1,
      "dueTotalBalance": 1.0,
      "toDueDocuments": 1,
      "ToDueTotalBalance": 1.0
    },
    {
      "grantorId": "08dd2e4a-0cf2-d469-522b-6e3108c3f91c",
      "groupType": "sample string 2",
      "groupCount": 1,
      "groupValue": "sample string 3",
      "year": 1,
      "month": 64,
      "day": 64,
      "week": 64,
      "documents": 1,
      "totalAmount": 1.0,
      "totalBalance": 1.0,
      "dueDocuments": 1,
      "dueTotalBalance": 1.0,
      "toDueDocuments": 1,
      "ToDueTotalBalance": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseModelApiOfListOfDashboardOutstandingApiModel 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>
    <DashboardOutstandingApiModel>
      <grantorId>08dd2e4a-0cf2-d469-522b-6e3108c3f91c</grantorId>
      <groupType>sample string 2</groupType>
      <groupCount>1</groupCount>
      <groupValue>sample string 3</groupValue>
      <year>1</year>
      <month>64</month>
      <day>64</day>
      <week>64</week>
      <documents>1</documents>
      <totalAmount>1</totalAmount>
      <totalBalance>1</totalBalance>
      <dueDocuments>1</dueDocuments>
      <dueTotalBalance>1</dueTotalBalance>
      <toDueDocuments>1</toDueDocuments>
      <ToDueTotalBalance>1</ToDueTotalBalance>
    </DashboardOutstandingApiModel>
    <DashboardOutstandingApiModel>
      <grantorId>08dd2e4a-0cf2-d469-522b-6e3108c3f91c</grantorId>
      <groupType>sample string 2</groupType>
      <groupCount>1</groupCount>
      <groupValue>sample string 3</groupValue>
      <year>1</year>
      <month>64</month>
      <day>64</day>
      <week>64</week>
      <documents>1</documents>
      <totalAmount>1</totalAmount>
      <totalBalance>1</totalBalance>
      <dueDocuments>1</dueDocuments>
      <dueTotalBalance>1</dueTotalBalance>
      <toDueDocuments>1</toDueDocuments>
      <ToDueTotalBalance>1</ToDueTotalBalance>
    </DashboardOutstandingApiModel>
  </data>
</ResponseModelApiOfListOfDashboardOutstandingApiModel>