API Ventas/Documentos
Descripción: PENDIENTE
Autorización: PENDIENTE
Beneficio: PENDIENTE
Tipos de peticiones: PENDIENTE
¿Cómo funciona? PENDIENTE
| Id | Descripción |
|---|---|
| 0 | NO APLICA |
| 1 | FACTURA |
| 2 | NOTA DEBITO |
| 3 | NOTA CREDITO |
| 4 | DOCUMENTO SOPORTE |
| 5 | NOTE DE AJUSTE DOCUMENTO SOPORTE |
| 6 | FACTURA POS |
| 7 | NOTA CREDITO POR DESCUENTO |
| Abreviatura | Descripción |
|---|---|
| AFS | SALDO INICIAL ACTIVOS FIJOS |
| AFB | ACTIVO FIJO BAJA |
| AFV | ACTIVO FIJO VENTA |
| AFR | ACTIVO FIJO RECONOCIMIENTO |
| AI | AJUSTE DE INVENTARIO |
| AIV | AJUSTE DE INVENTARIO VALORIZADO |
| AMD | AMORTIZACION DIFERIDOS |
| CE | COMPROBANTE DE EGRESO |
| CCO | CAUSACION DE COMPRA |
| COT | COTIZACION |
| ENS | ENSAMBLE DE MATERIALES |
| DNS | DESENSAMBLE DE MATERIALES |
| DAF | DEPRECIACION ACTIVOS FIJOS |
| DSP | DESPERDICIOS |
| DC | DEVOLUCION DE COMPRA |
| DV | DEVOLUCION DE VENTA |
| DEQ | DOCUMENTO EQUIVALENTE |
| FC | FACTURAS COMPRAS |
| FCP | FACTURA COMPRA PROFORMA |
| FCG | FACTURA COMPRA AGRUPADA |
| FV | FACTURAS DE VENTA |
| FRV | PLANTILLA DE FACTURACION RECURRENTE |
| NCF | NOTA DE CONTABILIDAD FIJA |
| NC | NOTA DE CONTABILIDAD |
| NCX | NOTA CIERRE CONTABLE |
| NCY | NOTA CIERRE CUENTAS BALANCE |
| ODC | ORDEN DE COMPRA |
| PDV | PEDIDO DE VENTA |
| RC | RECIBOS DE CAJA |
| RMV | REMISION VENTA |
| RMP | REMISION PLANTILLA |
| RMC | REMISION COMPRA |
| TR | TRANSFERENCIA |
| TRI | TRASLADO DE INVENTARIO |
| TSC | TRASLADO CON SOBRECOSTO |
| NVN | NOVEDAD DE NOMINA |
| NVNP | NOVEDAD DE NOMINA PROYECTADA |
| NVS | NOVEDAD DE AUMENTO DE SALARIO |
| LQN | LIQUIDACIÓN DE NOMINA |
| LQNP | LIQUIDACIÓN DE NOMINA PROYECTADA |
| LCN | LIQUIDACIÓN CESANTIAS DE NOMINA |
| LPN | LIQUIDACIÓN PRIMA DE NOMINA |
| LPV | LIQUIDACIÓN PROVISIONES DE NOMINA |
| LVN | LIQUIDACIÓN VACACIONES DE NOMINA |
| LSS | LIQUIDACIÓN SEGURIDAD SOCIAL |
| LQC | LIQUIDACIÓN DE CONTRATOS |
| PRE | PRESTAMO DE NOMINA |
| PRT | PROGRAMACIÓN DE TURNOS |
| SUC | SUCESOS |
| NVF | NOVEDAD FACTURA |
| NE | NOMINA ELECTRONICA |
| OP | ORDENES DE PRODUCCION |
| NEA | NOMINA ELECTRONICA AJUSTE |
| DDQ | DEVOLUCION DOCUMENTO EQUIVALENTE |
| DCC | DEVOLUCION CAUSACION DE COMPRA |
| POC | PLANEACION ORDENES DE COMPRA |
| POP | PLANEACION ORDENES DE PRODUCCION |
| RQ | REQUISICION DE ARTICULOS |
Métodos
<Tabs> <Tab name = "API Consulta (GET) ">
EndPoint: https://www.apis.serpi.com.co/api/v1/TipoDocumento
EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/TipoDocumento?limite=50&pagina=1
| Header | Descripción |
|---|---|
| secretkey | Secretkey proporcionada al cliente para consumos de las APIs |
Authorization:
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP| Parámetro | Tipo de dato | Requerido | Descripción |
|---|---|---|---|
| Límite | int | No | Este parámetro indica la cantidad de resultados que se deben devolver en una sola página |
| Página | int | No | Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página |
Response
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"id_centro_operacion": 1,
"descripcion_centro_operacion": "DESCRIPCIÓN DEL CENTRO DE OPERACIÓN",
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"descripcion_sub_costo_venta": "ADMINISTRACION",
"sub_ingreso_venta": 4,
"descripcion_sub_ingreso_venta": "VENTAS",
"sub_devolucion_venta": 1,
"descripcion_sub_devolucion_venta": "ADMINISTRACION",
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 1,
"descripcion_tipo_doc_soporte_automatico": "DESCRIPCIÓN DEL TIPO DOCUMENTO",
"seleccione_tipo_devolucion_causacion_compra": 1,
"descripcion_tipo_devolucion_causacion_compra": "DESCRIPCIÓN DEL TIPO DOCUMENTO",
"id_bodega_pos": 2,
"descripcion_bodega_pos": "DESCRIPCIÓN DE LA BODEGA",
"id_tercero_pos": 1234,
"nit_tercero_pos": "1234567",
"descripcion_tercero_pos": "DESCRIPCIÓN DEL TERCERO",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
]
}
{
"success": true
"code": 201,
"message": "No se encontraron registros",
"result": []
}| Campo | Tipo de dato | Descripción |
|---|---|---|
| id | int | Identificador del tipo de documento |
| id_centro_operacion | int | Identificador del centro de operación |
| descripcion_centro_operacion | string | Descripción del centro de operación |
| categoria_doc | string | Categoría del documento (Se especifican en la descripción inicial de esta API) |
| prefijo_tipo_doc | string | Prefijo del tipo de documento |
| descripcion | string | Descripción del tipo de documento |
| numero | int | Número del documento |
| num_digitos_decimal | int | Número de dígitos decimales |
| mensaje_factura1 | string | Mensaje de factura 1 |
| mensaje_factura2 | string | Mensaje de factura 2 |
| numero_resolucion_dian | string | Número de resolución DIAN |
| formato_doc | string | Formato del documento |
| prefijo_factura | string | Prefijo de la factura |
| activo | bool | Indicador de activo |
| sub_costo_venta | int | Subcentro de costo para costo de venta |
| descripcion_sub_costo_venta | string | Descripción del subcentro de costo para costo de venta |
| sub_ingreso_venta | int | Subcentro de costo para ingreso de venta |
| descripcion_sub_ingreso_venta | string | Descripción del subcentro de costo para ingreso de venta |
| sub_devolucion_venta | int | Subcentro de costo para devolución de venta |
| descripcion_sub_devolucion_venta | string | Descripción del subcentro de costo para devolución de venta |
| mensaje_factura3 | string | Mensaje de factura 3 |
| aplica_COLGAAP | bool | Aplica COLGAAP |
| aplica_NIIF | bool | Aplica NIIF |
| predeterminado | bool | Predeterminado (COLGAAP es false, NIIF es true) |
| aplica_restringe_orden_cronologico | bool | Aplica restringe orden cronológico |
| aplica_fecha_primer_documento | bool | Aplica fecha primer documento |
| mensaje_factura4 | string | Mensaje de factura 4 |
| resolucion_desde | int | Resolución desde |
| resolucion_hasta | int | Resolución hasta |
| res_fecha_desde | string | Resolución fecha desde |
| aplica_doc_recurrente | bool | Aplica documento recurrente |
| aplica_intereses_venta | bool | Aplica intereses de venta |
| id_documento_electronico | int | Identificador del documento electrónico (Se especifican en la descripción inicial de esta API) |
| aplica_gestiona_tarea | bool | Aplica gestión de tarea |
| aplica_adjuntar_formato_facturaSerpi | bool | Aplica adjuntar formato factura SERPI |
| res_fecha_hasta | string | Resolución fecha hasta |
| seleccione_tipo_doc_soporte_automatico | int | Identificador de la misma tabla de tipos de documento relacionado para soporte automático |
| descripcion_tipo_doc_soporte_automatico | string | Descripción del tipo de documento soporte automático relacionado |
| seleccione_tipo_devolucion_causacion_compra | int | Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra |
| descripcion_tipo_devolucion_causacion_compra | string | Descripción del tipo de documento para devolución de causación de compra relacionado |
| id_bodega_pos | int | Identificador de la bodega POS |
| descripcion_bodega_pos | string | Descripción de la bodega POS |
| id_tercero_pos | int | Identificador del tercero POS |
| nit_tercero_pos | string | NIT del tercero POS |
| descripcion_tercero_pos | string | Descripción del tercero POS |
| aplica_asignar_recepcion_electronico | bool | Aplica asignar recepción electrónica |
| fecha_recepcion_electronica | string | Fecha de recepción electrónica |
</Tab>
<Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/TipoDocumento
| Header | Descripción |
|---|---|
| secretkey | Secretkey proporcionada al cliente para consumos de las APIs |
Authorization:
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
Request
{
"id_centro_operacion": 1,
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"sub_ingreso_venta": 4,
"sub_devolucion_venta": 1,
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 80,
"seleccione_tipo_devolucion_causacion_compra": 80,
"id_bodega_pos": 2,
"nit_tercero_pos": "1234567",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
| Campo | Tipo de dato | Longitud | Requerido | Descripción |
|---|---|---|---|---|
| id_centro_operacion | int | 11 | Si | Identificador del centro de operación |
| categoria_doc | string | 5 | Si | Categoría del documento (Se especifican en la descripción inicial de esta API) |
| prefijo_tipo_doc | string | 5 | Si | Prefijo del tipo de documento |
| descripcion | string | 100 | Si | Descripción del documento |
| numero | int | 11 | No | Número del documento |
| num_digitos_decimal | int | 11 | No | Número de dígitos decimales |
| mensaje_factura1 | string | 65535 | No | Mensaje de la factura 1 |
| mensaje_factura2 | string | 65535 | No | Mensaje de la factura 2 |
| numero_resolucion_dian | string | 65535 | No | Número de resolución DIAN |
| formato_doc | string | 100 | No | Formato del documento |
| prefijo_factura | string | 5 | No | Prefijo de la factura |
| activo | bool | 1 | No | Indicador de activo |
| sub_costo_venta | int | 11 | No | Identificador de subcentro de costo para costo de venta |
| sub_ingreso_venta | int | 11 | No | Identificador de subcentro de costo para ingreso de venta |
| sub_devolucion_venta | int | 11 | No | Identificador de subcentro de costo para devolución de venta |
| mensaje_factura3 | string | 65535 | No | Mensaje de la factura 3 |
| aplica_COLGAAP | bool | 1 | No | Indicador de aplicación de COLGAAP |
| aplica_NIIF | bool | 1 | No | Indicador de aplicación de NIIF |
| predeterminado | bool | 1 | No | Indicador predeterminado (COLGAAP es false, NIIF es true) |
| aplica_restringe_orden_cronologico | bool | 1 | No | Indicador de aplicación de restricción de orden cronológico |
| aplica_fecha_primer_documento | bool | 1 | No | Indicador de aplicación de fecha de primer documento |
| mensaje_factura4 | string | 65535 | No | Mensaje de la factura 4 |
| resolucion_desde | int | 11 | No | Resolución desde |
| resolucion_hasta | int | 11 | No | Resolución hasta |
| res_fecha_desde | string | 10 | No | Fecha de la resolución desde. Formato YYYY-MM-DD |
| aplica_doc_recurrente | bool | 1 | No | Indicador de aplicación de documento recurrente |
| aplica_intereses_venta | bool | 1 | No | Indicador de aplicación de intereses de venta |
| id_documento_electronico | int | 11 | No | Identificador del documento electrónico (Se especifican en la descripción inicial de esta API) |
| aplica_gestiona_tarea | bool | 1 | No | Indicador de aplicación de gestión de tarea |
| aplica_adjuntar_formato_facturaSerpi | bool | 1 | No | Indicador de aplicación de adjuntar formato de factura SERPI |
| res_fecha_hasta | string | 10 | No | Fecha de la resolución hasta. Formato YYYY-MM-DD |
| seleccione_tipo_doc_soporte_automatico | int | 11 | No | Identificador de la misma tabla de tipos de documento relacionado para soporte automático |
| seleccione_tipo_devolucion_causacion_compra | int | 11 | No | Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra |
| id_bodega_pos | int | 11 | No | Identificador de la bodega POS |
| nit_tercero_pos | string | 15 | No | NIT del tercero POS |
| aplica_asignar_recepcion_electronico | bool | 1 | No | Indicador de aplicación de asignar recepción electrónica |
| fecha_recepcion_electronica | string | 10 | No | Fecha de recepción electrónica. Formato YYYY-MM-DD |
AVISO IMPORTANTE:
Donde los campos no sean obligatorios y no se desea asignar algún valor, pruebe digitando null o 0 en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite null.
Response
{
"success": true,
"code": 201,
"errors": [],
"message": "Validaciones exitosas. Registro creado exitosamente"
}Validaciones
{
"success": false,
"code": 400,
"errors": [
"El centro de operacion 1 no existe",
"El prefijo_tipo_doc RCA ya existe",
"El campo descripcion es obligatorio",
"El campo numero debe ser mínimo 1",
"El id 1 del campo sub_costo_venta no existe",
"El id 4 del campo sub_ingreso_venta no existe",
"El id 1 del campo sub_devolucion_venta no existe",
"El campo res_fecha_hasta es inválido. Formato esperado: yyyy-MM-dd",
"El campo fecha_recepcion_electronica es inválido. Formato esperado: yyyy-MM-dd",
"El id 80 del campo seleccione_tipo_doc_soporte_automatico no existe",
"El id 80 del campo seleccione_tipo_devolucion_causacion_compra no existe",
"El id_bodega_pos 2 no existe",
"El nit_tercero_pos 1234567 no existe",
"El campo categoria_doc con la categoría NC no coincide con alguna de las nomenclaturas especificadas",
"El campo id_documento_electronico debe ser un valor del 0 al 7: 1 (FACTURA), 2 (NOTA DEBITO), 3 (NOTA CREDITO), 4 (DOCUMENTO SOPORTE), 5 (NOTE DE AJUSTE DOCUMENTO SOPORTE), 6 (FACTURA POS), 7 (NOTA CREDITO POR DESCUENTO) o 0 (NO APLICA)"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}</Tab>
<Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/TipoDocumento
| Header | Descripción |
|---|---|
| secretkey | Secretkey proporcionada al cliente para consumos de las APIs |
Authorization:
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
Request
{
"id": 1,
"id_centro_operacion": 1,
"categoria_doc": "NC",
"prefijo_tipo_doc": "RCA",
"descripcion": "RECIBO DE CAJA",
"numero": 2,
"num_digitos_decimal": 2,
"mensaje_factura1": "MENSAJE DE LA FACTURA 1",
"mensaje_factura2": "MENSAJE DE LA FACTURA 2",
"numero_resolucion_dian": "1234567",
"formato_doc": "PDF",
"prefijo_factura": "PF",
"activo": true,
"sub_costo_venta": 1,
"sub_ingreso_venta": 4,
"sub_devolucion_venta": 1,
"mensaje_factura3": "MENSAJE DE LA FACTURA 3",
"aplica_COLGAAP": true,
"aplica_NIIF": true,
"predeterminado": false,
"aplica_restringe_orden_cronologico": false,
"aplica_fecha_primer_documento": false,
"mensaje_factura4": "MENSAJE DE LA FACTURA 4",
"resolucion_desde": 1234567,
"resolucion_hasta": 1234567,
"res_fecha_desde": "2023-06-01",
"aplica_doc_recurrente": true,
"aplica_intereses_venta": true,
"id_documento_electronico": 6,
"aplica_gestiona_tarea": true,
"aplica_adjuntar_formato_facturaSerpi": true,
"res_fecha_hasta": "2023-06-01",
"seleccione_tipo_doc_soporte_automatico": 80,
"seleccione_tipo_devolucion_causacion_compra": 80,
"id_bodega_pos": 2,
"nit_tercero_pos": "1234567",
"aplica_asignar_recepcion_electronico": true,
"fecha_recepcion_electronica": "2023-06-01"
}
| Campo | Tipo de dato | Longitud | Requerido | Descripción |
|---|---|---|---|---|
| id | int | 11 | Si | Identificador del tipo de documento |
| id_centro_operacion | int | 11 | Si | Identificador del centro de operación |
| categoria_doc | string | 5 | Si | Categoría del documento (Se especifican en la descripción inicial de esta API) |
| prefijo_tipo_doc | string | 5 | Si | Prefijo del tipo de documento |
| descripcion | string | 100 | Si | Descripción del documento |
| numero | int | 11 | No | Número del documento |
| num_digitos_decimal | int | 11 | No | Número de dígitos decimales |
| mensaje_factura1 | string | 65535 | No | Mensaje de la factura 1 |
| mensaje_factura2 | string | 65535 | No | Mensaje de la factura 2 |
| numero_resolucion_dian | string | 65535 | No | Número de resolución DIAN |
| formato_doc | string | 100 | No | Formato del documento |
| prefijo_factura | string | 5 | No | Prefijo de la factura |
| activo | bool | 1 | No | Indicador de activo |
| sub_costo_venta | int | 11 | No | Identificador de subcentro de costo para costo de venta |
| sub_ingreso_venta | int | 11 | No | Identificador de subcentro de costo para ingreso de venta |
| sub_devolucion_venta | int | 11 | No | Identificador de subcentro de costo para devolución de venta |
| mensaje_factura3 | string | 65535 | No | Mensaje de la factura 3 |
| aplica_COLGAAP | bool | 1 | No | Indicador de aplicación de COLGAAP |
| aplica_NIIF | bool | 1 | No | Indicador de aplicación de NIIF |
| predeterminado | bool | 1 | No | Indicador predeterminado (COLGAAP es false, NIIF es true) |
| aplica_restringe_orden_cronologico | bool | 1 | No | Indicador de aplicación de restricción de orden cronológico |
| aplica_fecha_primer_documento | bool | 1 | No | Indicador de aplicación de fecha de primer documento |
| mensaje_factura4 | string | 65535 | No | Mensaje de la factura 4 |
| resolucion_desde | int | 11 | No | Resolución desde |
| resolucion_hasta | int | 11 | No | Resolución hasta |
| res_fecha_desde | string | 10 | No | Fecha de la resolución desde. Formato YYYY-MM-DD |
| aplica_doc_recurrente | bool | 1 | No | Indicador de aplicación de documento recurrente |
| aplica_intereses_venta | bool | 1 | No | Indicador de aplicación de intereses de venta |
| id_documento_electronico | int | 11 | No | Identificador del documento electrónico (Se especifican en la descripción inicial de esta API) |
| aplica_gestiona_tarea | bool | 1 | No | Indicador de aplicación de gestión de tarea |
| aplica_adjuntar_formato_facturaSerpi | bool | 1 | No | Indicador de aplicación de adjuntar formato de factura SERPI |
| res_fecha_hasta | string | 10 | No | Fecha de la resolución hasta. Formato YYYY-MM-DD |
| seleccione_tipo_doc_soporte_automatico | int | 11 | No | Identificador de la misma tabla de tipos de documento relacionado para soporte automático |
| seleccione_tipo_devolucion_causacion_compra | int | 11 | No | Identificador de la misma tabla de tipos de documento relacionado a la devolución de causación de compra |
| id_bodega_pos | int | 11 | No | Identificador de la bodega POS |
| nit_tercero_pos | string | 15 | No | NIT del tercero POS |
| aplica_asignar_recepcion_electronico | bool | 1 | No | Indicador de aplicación de asignar recepción electrónica |
| fecha_recepcion_electronica | string | 10 | No | Fecha de recepción electrónica. Formato YYYY-MM-DD |
AVISO IMPORTANTE:
Donde los campos no sean obligatorios y no se desea asignar algún valor, pruebe digitando null o 0 en los valores de los campos de tipo numérico (int o double). Si es un campo de tipo string no obligatorio, siempre digite null.
Response
{
"success": true,
"code": 200,
"errors": [],
"message": "Validaciones exitosas. Registro modificado exitosamente"
}
{
"success": false,
"code": 204,
"errors": null,
"message": "No se encontraron registros con el id 1"
}Validaciones
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El centro de operacion 1 no existe",
"El prefijo_tipo_doc RCA ya existe",
"El campo descripcion es obligatorio",
"El campo numero debe ser mínimo 1",
"El id 1 del campo sub_costo_venta no existe",
"El id 4 del campo sub_ingreso_venta no existe",
"El id 1 del campo sub_devolucion_venta no existe",
"El campo res_fecha_hasta es inválido. Formato esperado: yyyy-MM-dd",
"El campo fecha_recepcion_electronica es inválido. Formato esperado: yyyy-MM-dd",
"El id 80 del campo seleccione_tipo_doc_soporte_automatico no existe",
"El id 80 del campo seleccione_tipo_devolucion_causacion_compra no existe",
"El id_bodega_pos 2 no existe",
"El nit_tercero_pos 1234567 no existe",
"El campo categoria_doc con la categoría NC no coincide con alguna de las nomenclaturas especificadas",
"El campo id_documento_electronico debe ser un valor del 0 al 7: 1 (FACTURA), 2 (NOTA DEBITO), 3 (NOTA CREDITO), 4 (DOCUMENTO SOPORTE), 5 (NOTE DE AJUSTE DOCUMENTO SOPORTE), 6 (FACTURA POS), 7 (NOTA CREDITO POR DESCUENTO) o 0 (NO APLICA)"
],
"message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}</Tab> </Tabs>
Códigos de estado HTTP
| Código | Descripción |
|---|---|
| 200 | La solicitud ha sido exitosa |
| 201 | La solicitud ha tenido éxito y ha llevado a la creación de un recurso |
| 204 | La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta |
| 400 | El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente |
| 401 | La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso |
| 403 | El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso |
| 404 | El recurso solicitado no se ha encontrado en el servidor |
| 500 | Internal Server Error |
| 503 | El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal |
¿Cómo consumir la API?
<Tabs>
<Tab name = "Java"> Request
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://localhost:44305/api/v1/TipoDocumento")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();</Tab>
<Tab name = "C#"> Request
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/TipoDocumento");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());</Tab>
<Tab name = "PHP"> Request
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/TipoDocumento');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'secretkey' => '{{secret key}}',
'Authorization' => 'Bearer {{token}}'
));
$request->setBody('');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}</Tab>
</Tabs>