Prerequisitos
Antes de realizar la consulta de notas crédito, se debe contar con los siguientes datos:- Token solicitado mediante el API de autenticación
Consultar notas crédito
Request URL: https://{{Ambiente}}/API_FE/api/DocumentosElectronicos/NotasCreditoConsultarTipo: POST
Content Type: application/json
int
Página de consulta, por defecto (1).
int
Cantidad de registros por página de consulta, por defecto (10). El máximo permitido es 30 registros por página.
GUID
Filtro de búsqueda por identificador único de la nota crédito.
GUID
Filtro de búsqueda por identificador único de la factura de venta relacionada.
int
Filtro de búsqueda por consecutivo de la nota crédito.
string
Filtro de búsqueda por prefijo de la nota crédito.
string
Filtro de búsqueda por fecha de creación de la nota crédito, desde la fecha indicada (inclusive). Solo se tiene en cuenta la fecha, no la hora.
string
Filtro de búsqueda por fecha de creación de la nota crédito, hasta la fecha indicada (inclusive). Solo se tiene en cuenta la fecha, no la hora.
string
Filtro de búsqueda por cualquier parte del nombre o razón social del cliente.
string
Filtro de búsqueda por número de identificación exacto del cliente, sin dígito de verificación.
string
Filtro de búsqueda por email del usuario que registró la nota crédito.
string
Campo de consulta múltiple. El criterio de búsqueda depende del valor enviado:
- Numérico: consulta por el consecutivo de la nota crédito, por el consecutivo de la factura relacionada o por el número de identificación del cliente.
- Fecha: consulta por la fecha de creación de la nota crédito.
- Otro texto: consulta por cualquier parte del nombre, email, dirección o celular del cliente.
Respuesta
El servicio retorna el listado de notas crédito ordenado por fecha de creación y consecutivo de forma descendente. Cada registro derows contiene los siguientes campos:
int
Código único de la nota crédito (ID).
string
Prefijo de la nota crédito.
int
Consecutivo de la nota crédito.
datetime
Fecha de creación de la nota crédito.
datetime
Fecha de vencimiento de la nota crédito.
decimal
Valor total de la nota crédito (valor neto + valor de impuestos).
string
Código Único de Documento Electrónico (CUDE) de la nota crédito.
GUID
Identificador único de la nota crédito.
string
Descripción de la causal de la nota crédito.
string
Prefijo de la factura de venta relacionada.
int
Consecutivo de la factura de venta relacionada.
datetime
Fecha de creación de la factura de venta relacionada.
decimal
Valor total de la factura de venta relacionada (valor neto + valor de impuestos).
string
Nombre completo o razón social del cliente.
string
Tipo y número de identificación del cliente con formato (ej. “NIT. 900,123,456-7”). Para NIT incluye el dígito de verificación.
string
Correo electrónico del cliente.
string
Nombre del usuario que registró la nota crédito.
int
Cantidad total de registros que cumplen con los filtros de la consulta.