GET Api/Documentos

Obtiene la lista de documentos

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Pagina

Pagina solicitada

integer

None.

Renglones

Renglones por página. Max. 20

integer

None.

Inicio

Solo lectura. Punto de inicio

integer

None.

AnioImportante

Año de la fecha relevante, entiéndase la fecha en que se realiza el pago (diferente de la fecha del comprobante), o la fecha en que se hace el pago de nómina

string

None.

MesImportante

Mes de la fecha relevante, entiéndase la fecha en que se realiza el pago (diferente de la fecha del comprobante), o la fecha en que se hace el pago de nómina

string

None.

Anio

Año solicitado

string

None.

ClienteId

Identificador del customer. se utiliza para consultar los documentos de la pantalla de resumen de los clientes

integer

None.

Emisor

Nombre del emisor

string

None.

EmisorRfc

RFC del emisor

string

None.

EstadosExcluidos

Estados del comprobante que se desea excluir. Valores de EstadosComprobante

Collection of integer

None.

FechaFin

Fecha final de la búsqueda

string

None.

FechaInicio

Fecha inicio de la búsqueda

string

None.

Folio

Folio que se esta buscando

string

None.

IdsSolicitados

Lista de identificadores solicitados

Collection of string

None.

Mes

Mes solicitado. Se recomienda utilizar junto con el año

string

None.

OfficeId

Sucursal

string

None.

Pagados

Buscar solo comprobantes pagados. Descarta también comprobantes que están en borrador o cancelados

boolean

None.

Receptor

Nombre del receptor

string

None.

ReceptorRfc

RFC del receptor

string

None.

Serie

Serie que se esta buscando

string

None.

StatusId

Estado que se esta buscando. Valor de EstadosComprobante

string

None.

TipoDocumento

Tipo de documento que se esta buscando. Valor de TiposDocumento

integer

None.

TipoDocumentoExcluidos

Tipos de documento que se excluyen de la búsqueda. Valor de TiposDocumento

Collection of integer

None.

UUID

Identificador fiscal buscado

string

None.

Version

Version del CFDI (3.2, 3.3)

string

None.

PUE_Pagados

Obtiene los comprobantes de ingreso PUE que fueron pagados al momento de ser creados

boolean

None.

TodosLosIngresos

Obtiene los documentos de pago, así como los documentos PUE que fueron pagados al ser creados (sin modo de compatibilidad) Los primeros documentos PUE no se marcaron así y puede que tengan relacionado un CFDI con complemento de pago

boolean

None.

EnProcesoCancelacion

Obtiene los documentos que están en proceso de cancelación y necesitan ser autorizados por el receptor

boolean

None.

PacId

EL Id del pac por el cual fue timbrado

integer

None.

FechaExacta

Se utiliza para filtrar por la fecha exactamente

string

None.

Body Parameters

None.

Response Information

Resource Description

Obtiene la lista de documentos

Collection of DocumentoBasicoRow
NameDescriptionTypeAdditional information
BancoId

Identificador de la cuenta de banco del comprobante

integer

None.

FechaImportante

Fecha relevante para el documento (fecha del pago, fecha del comprobante, etc)

date

None.

Borrador

Indica si el documento es borrador

boolean

None.

UserId

Id FG del usuario que crea el documento (propietario del documento)

integer

None.

CreatedOn

Fecha de creación del documento

date

None.

ClienteId

Identificador del cliente a quien se hace el documento

integer

None.

ReceptorId

Identificador del receptor del documento (puede ser cliente o empleado)

integer

None.

DocumentoId

Id FG del documento

string

None.

Emisor

Nombre del emisor

string

None.

EmpleadoId

Identificador del empleado

integer

None.

Estado

Cadena del estado

string

None.

EstadoId

Estado del documento

integer

None.

Fecha

Fecha del documento

date

None.

Folio

Folio del documento

string

None.

FolioCompleto

Folio y serie

string

None.

Moneda

Moneda del comprobante

string

None.

Receptor

Nombre del receptor

string

None.

RfcEmisor

RFC del receptor

string

None.

RfcReceptor

RFC del receptor

string

None.

Serie

Serie del documento

string

None.

TipoDocumentoId

Tipo de documento

integer

None.

TipoFuente

Fuente de los datos

string

None.

Total

Total del documento

decimal number

None.

TotalCadena

Total del documento, cantidad y moneda

string

None.

UUID

Identificador fiscal del documento

string

None.

Version

Versión del CFDI

string

None.

NombrePac

Nombre del pac por el cual fue timbrado

string

None.

TipoCambio

Tipo de cambio del documento

decimal number

None.

Adeudo

Adeudo del comprobante

decimal number

None.

C_MetodoPago

Método de pago del comprobante (de acuerdo al catálogo del SAT)

string

None.

Cancelado

Indica si el documento ya esta cancelado

boolean

None.

Activa

Calculada. Indica si es un comprobante sobre el que se puede trabajar (no esta cancelado)

boolean

None.

Cancelable

Calculada. Indica si el documento se puede cancelar, es decir, si no esta ya cancelado o es un borrador

boolean

None.

EnProcesoCancelacion

Indica que el documento esta en proceso de ser cancelado

boolean

None.

Pagable

Calculada. Indica si se puede pagar, es decir, que no este cancelada ni sea borrador y que no sea un recibo de nomina o una nota de crédito

boolean

None.

Terminada

Calculada. La factura ya no es borrador

boolean

None.

Pagado

Bandera de pago

boolean

None.

Enviado

El documento ha sido enviado

boolean

None.

MostrarPagado

Solo lectura. Por compatibilidad, indica si se debe mostrar el pagado para facturas 3.2

boolean

None.

MostrarEnviado

Solo lectura. Indica si es prudente mostrar el dato de enviado. Los borradores no pueden ser enviados

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BancoId": 1,
    "FechaImportante": "2019-04-22T13:15:23.7777197-05:00",
    "Borrador": true,
    "UserId": 2,
    "CreatedOn": "2019-04-22T13:15:23.7777197-05:00",
    "ClienteId": 1,
    "ReceptorId": 4,
    "DocumentoId": "sample string 5",
    "Emisor": "sample string 6",
    "EmpleadoId": 1,
    "Estado": "7",
    "EstadoId": 7,
    "Fecha": "2019-04-22T13:15:23.7777197-05:00",
    "Folio": "sample string 9",
    "FolioCompleto": "sample string 14sample string 9",
    "Moneda": "sample string 10",
    "Receptor": "sample string 11",
    "RfcEmisor": "sample string 12",
    "RfcReceptor": "sample string 13",
    "Serie": "sample string 14",
    "TipoDocumentoId": 15,
    "TipoFuente": "sample string 16",
    "Total": 17.0,
    "TotalCadena": "$17.00 sample string 10",
    "UUID": "sample string 18",
    "Version": "sample string 19",
    "NombrePac": "sample string 20",
    "TipoCambio": 21.0,
    "Adeudo": 1.0,
    "C_MetodoPago": "sample string 22",
    "Cancelado": false,
    "Activa": true,
    "Cancelable": false,
    "EnProcesoCancelacion": true,
    "Pagable": false,
    "Terminada": true,
    "Pagado": true,
    "Enviado": true,
    "MostrarPagado": false,
    "MostrarEnviado": false
  },
  {
    "BancoId": 1,
    "FechaImportante": "2019-04-22T13:15:23.7777197-05:00",
    "Borrador": true,
    "UserId": 2,
    "CreatedOn": "2019-04-22T13:15:23.7777197-05:00",
    "ClienteId": 1,
    "ReceptorId": 4,
    "DocumentoId": "sample string 5",
    "Emisor": "sample string 6",
    "EmpleadoId": 1,
    "Estado": "7",
    "EstadoId": 7,
    "Fecha": "2019-04-22T13:15:23.7777197-05:00",
    "Folio": "sample string 9",
    "FolioCompleto": "sample string 14sample string 9",
    "Moneda": "sample string 10",
    "Receptor": "sample string 11",
    "RfcEmisor": "sample string 12",
    "RfcReceptor": "sample string 13",
    "Serie": "sample string 14",
    "TipoDocumentoId": 15,
    "TipoFuente": "sample string 16",
    "Total": 17.0,
    "TotalCadena": "$17.00 sample string 10",
    "UUID": "sample string 18",
    "Version": "sample string 19",
    "NombrePac": "sample string 20",
    "TipoCambio": 21.0,
    "Adeudo": 1.0,
    "C_MetodoPago": "sample string 22",
    "Cancelado": false,
    "Activa": true,
    "Cancelable": false,
    "EnProcesoCancelacion": true,
    "Pagable": false,
    "Terminada": true,
    "Pagado": true,
    "Enviado": true,
    "MostrarPagado": false,
    "MostrarEnviado": false
  }
]

application/xml, text/xml

Sample:
<ArrayOfDocumentoBasicoRow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Griffin.BL.Activity.Models">
  <DocumentoBasicoRow>
    <Adeudo>1</Adeudo>
    <BancoId>1</BancoId>
    <Borrador>true</Borrador>
    <ClienteId>1</ClienteId>
    <CreatedOn>2019-04-22T13:15:23.7777197-05:00</CreatedOn>
    <DocumentoId>sample string 5</DocumentoId>
    <Emisor>sample string 6</Emisor>
    <EmpleadoId>1</EmpleadoId>
    <EnProcesoCancelacion>true</EnProcesoCancelacion>
    <EstadoId>7</EstadoId>
    <Fecha>2019-04-22T13:15:23.7777197-05:00</Fecha>
    <FechaImportante>2019-04-22T13:15:23.7777197-05:00</FechaImportante>
    <Folio>sample string 9</Folio>
    <Moneda>sample string 10</Moneda>
    <NombrePac>sample string 20</NombrePac>
    <Receptor>sample string 11</Receptor>
    <ReceptorId>4</ReceptorId>
    <RfcEmisor>sample string 12</RfcEmisor>
    <RfcReceptor>sample string 13</RfcReceptor>
    <Serie>sample string 14</Serie>
    <TipoCambio>21</TipoCambio>
    <TipoDocumentoId>15</TipoDocumentoId>
    <Total>17</Total>
    <UUID>sample string 18</UUID>
    <UserId>2</UserId>
    <Version>sample string 19</Version>
  </DocumentoBasicoRow>
  <DocumentoBasicoRow>
    <Adeudo>1</Adeudo>
    <BancoId>1</BancoId>
    <Borrador>true</Borrador>
    <ClienteId>1</ClienteId>
    <CreatedOn>2019-04-22T13:15:23.7777197-05:00</CreatedOn>
    <DocumentoId>sample string 5</DocumentoId>
    <Emisor>sample string 6</Emisor>
    <EmpleadoId>1</EmpleadoId>
    <EnProcesoCancelacion>true</EnProcesoCancelacion>
    <EstadoId>7</EstadoId>
    <Fecha>2019-04-22T13:15:23.7777197-05:00</Fecha>
    <FechaImportante>2019-04-22T13:15:23.7777197-05:00</FechaImportante>
    <Folio>sample string 9</Folio>
    <Moneda>sample string 10</Moneda>
    <NombrePac>sample string 20</NombrePac>
    <Receptor>sample string 11</Receptor>
    <ReceptorId>4</ReceptorId>
    <RfcEmisor>sample string 12</RfcEmisor>
    <RfcReceptor>sample string 13</RfcReceptor>
    <Serie>sample string 14</Serie>
    <TipoCambio>21</TipoCambio>
    <TipoDocumentoId>15</TipoDocumentoId>
    <Total>17</Total>
    <UUID>sample string 18</UUID>
    <UserId>2</UserId>
    <Version>sample string 19</Version>
  </DocumentoBasicoRow>
</ArrayOfDocumentoBasicoRow>