GET Api/Documentos/{id}

Obtiene información básica del comprobante

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Identificador FG del comprobante

string

Required

Body Parameters

None.

Response Information

Resource Description

Obtiene información básica del comprobante

DocumentoRow
NameDescriptionTypeAdditional information
Archivo

Nombre del archivo

string

None.

CadenaOriginal

Cadena original

string

None.

CanceladoEn

Fecha de cancelación

date

None.

CertificadoCliente

No de certificado del cliente

string

None.

ExtId

Identificador externo

string

None.

Notas

Notas del comprobante

string

None.

PAC

PAC con el que se genera el comprobante

PacRow

None.

Pagare

Objeto de pagaré

PagareModel

None.

Sucursal

Sucursal del comprobante

string

None.

SucursalId

Identificador de la sucursal

string

None.

TipoDocumento

Tipo de documento

string

None.

TotalAbonos

Total abonos

decimal number

None.

XML

Archivo XML

Binary

None.

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:
{
  "Archivo": "sample string 1",
  "CadenaOriginal": "sample string 2",
  "CanceladoEn": "2019-04-22T14:03:39.2807355-05:00",
  "CertificadoCliente": "sample string 3",
  "ExtId": "sample string 4",
  "Notas": "sample string 5",
  "PAC": null,
  "Pagare": {
    "Requerido": true,
    "Interes": "sample string 2",
    "Dias": "sample string 3",
    "Texto": "sample string 4",
    "DireccionOficina": {
      "Direccion": "sample string 1",
      "Localidad": "sample string 2"
    },
    "DireccionReceptor": {
      "Direccion": "sample string 1",
      "Localidad": "sample string 2"
    }
  },
  "Sucursal": "sample string 6",
  "SucursalId": "sample string 7",
  "TipoDocumento": "sample string 8",
  "TotalAbonos": 9.0,
  "XML": null,
  "BancoId": 1,
  "FechaImportante": "2019-04-22T14:03:39.2807355-05:00",
  "Borrador": true,
  "UserId": 11,
  "CreatedOn": "2019-04-22T14:03:39.2807355-05:00",
  "ClienteId": 1,
  "ReceptorId": 13,
  "DocumentoId": "sample string 14",
  "Emisor": "sample string 15",
  "EmpleadoId": 1,
  "Estado": "16",
  "EstadoId": 16,
  "Fecha": "2019-04-22T14:03:39.2807355-05:00",
  "Folio": "sample string 18",
  "FolioCompleto": "sample string 23sample string 18",
  "Moneda": "sample string 19",
  "Receptor": "sample string 20",
  "RfcEmisor": "sample string 21",
  "RfcReceptor": "sample string 22",
  "Serie": "sample string 23",
  "TipoDocumentoId": 24,
  "TipoFuente": "sample string 25",
  "Total": 26.0,
  "TotalCadena": "$26.00 sample string 19",
  "UUID": "sample string 27",
  "Version": "sample string 28",
  "NombrePac": "sample string 29",
  "TipoCambio": 30.0,
  "Adeudo": 1.0,
  "C_MetodoPago": "sample string 31",
  "Cancelado": false,
  "Activa": true,
  "Cancelable": false,
  "EnProcesoCancelacion": true,
  "Pagable": false,
  "Terminada": true,
  "Pagado": true,
  "Enviado": true,
  "MostrarPagado": false,
  "MostrarEnviado": false
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.