Diferencia entre revisiones de «Servicios de Manejo de Documentos Electrónicos para Receptor - Índice Manual Integración Recepción Electrónica»
(Página creada con « <includeonly>=</includeonly>==<font color="blue">Servicios de Manejo de Documentos Electrónicos para Receptor</font>==<includeonly>=</includeonly> ===<font color="blue">…») |
|||
Línea 1604: | Línea 1604: | ||
− | ===<font color="blue">Método | + | ===<font color="blue">Método DescargaAnexo </font>=== |
Permite la descarga del Anexo o adjunto del documento que se encuentra vinculado al documento de factura. Que originalmente fue anexada al documento. | Permite la descarga del Anexo o adjunto del documento que se encuentra vinculado al documento de factura. Que originalmente fue anexada al documento. |
Revisión del 15:51 2 may 2022
Sumario
- 1 Servicios de Manejo de Documentos Electrónicos para Receptor
- 2 Tabla 1
- 3 Ejemplo de entrada
- 4 Ejemplo de Salida
- 5 Ejemplo de entrada
- 6 Ejemplo de salida
- 7 Ejemplos: tomando el ultimoenviado
- 8 Ejemplo Respuesta:Tomando el ultimo enviado
- 9 Tabla 2
- 10 Tabla 3
- 11 Ejemplo de entrada
- 12 Ejemplo de salida
- 13 Tabla 2
- 14 Ejemplo de entrada
- 15 Ejemplo de salida
- 16 Tabla 2
- 17 Ejemplo de entrada
- 18 Ejemplo de salida
- 19 Tabla 2
- 20 Ejemplo de entrada
- 21 Ejemplo de salida
- 22 Tabla 2
- 23 CodigoRechazo
- 24 Ejemplo de entrada
- 25 Tabla 2
- 26 Tabla 1
- 27 Ejemplo de entrada
- 28 Ejemplo de salida
- 29 Tabla 2
- 30 Ejemplo de entrada
- 31 Ejemplo de salida
- 32 Tabla 2
- 33 Ejemplo de entrada
- 34 Ejemplo de salida
- 35 Tabla 2
- 36 Ejemplo de entrada
- 37 Ejemplo de salida
- 38 Tabla 2
- 39 Ejemplo de entrada
- 40 Ejemplo de salida
- 41 Tabla 2
- 42 Ejemplo de entrada
- 43 Ejemplo de salida
- 44 Tabla 2
- 45 Tabla 2
Servicios de Manejo de Documentos Electrónicos para Receptor
Método de Reporte con Estatus (ReporteStatus)
Muestra la lista de los 500 últimos documentos de Facturación Electrónica con el respectivo estado que se está buscando, que se han recibidos para un Receptor dado y que tienen asociado un consecutivo menor a un valor suministrado.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | consecutivo | Número consecutivo de los documentos a revisa | número consecutivo del documento o en blanco |
status_code | Código de Estatus del documento | Requerido para la búsqueda*,se puede verificar en la siguiente tabla. | |
String | tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres |
tokenPassword |
En la siguiente tabla se muestran los estados +(tabla 1) posibles del documento para ingresarlos y obtener un reporte solo con los documentos con el estado proporcionado.
Tabla 1
Código | Descripción |
---|---|
00 | Cargado |
01 | Entregado |
02 | Aceptación expresa (DIAN) |
04 | Reclamo (DIAN) |
10 | Acuse de recibo (DIAN |
11 | Rechazado (DIAN) |
12 | Recibo del bien y/o prestación del servicio |
13 | Precargado |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:ReporteStatus> <tem:request> <wcf:consecutivo>500</wcf:consecutivo> <wcf:status_code>01</wcf:status_code> <wcf:tokenEmpresa>89………………………………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3…………………………43</wcf:tokenPassword> </tem:request> </tem:ReporteStatus> </soapenv:Body> </soapenv:Envelope>
Ejemplo de Salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReporteStatusResponse xmlns="http://tempuri.org/"> <ReporteStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>200</a:codigo> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReporteStatusResponse xmlns="http://tempuri.org/"> <ReporteStatusResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>200</a:codigo> <a:documentoselectronicos> <a:InfoDocumentoStatus> <a:correlativoempresa>177</a:correlativoempresa> <a:cufe>90931e5e4e97f8d695326b2cd49328b1fcb0bf669bf9252b02acfaaab6bebe281c6adc846165e3b00a3cf23d00dfeb99</a:cufe> <a:estatus>1</a:estatus> <a:estatusDIANcodigo/> <a:estatusDIANdescripcion <a:estatusDIANfecha/> <a:estatusnombre>Entregado</a:estatusnombre> <a:fechaemision>2021-09-21</a:fechaemision> <a:fecharecepcion>2021-11-17T19:24:07</a:fecharecepcion> <a:horaemision>23:24:46</a:horaemision> <a:montototal>21665472.08</a:montototal> <a:numerodocumento>SUN64</a:numerodocumento> <a:numeroidentificacion>595454595</a:numeroidentificacion> <a:razonsocial>Ady.SA</a:razonsocial> <a:tipodocumento>01</a:tipodocumento> <a:tipoemisor>1</a:tipoemisor> <a:tipoidentidad>31</a:tipoidentidad> </a:InfoDocumentoStatus> ………………… </a:documentoselectronicos> <a:mensaje>Procesado</a:mensaje> <a:pendiente>false</a:pendiente> <a:resultado>Procesado</a:resultado> <a:ultimoEnviado>25</a:ultimoEnviado> </ReporteStatusResult> </ReporteStatusResponse> </s:Body> </s:Envelope>
NOTA: El ultimoEnviado es el número consecutivo para ver los archivos anteriores a el último que se muestra. Si se tienen más documentos el reporte mostrará true en la etiqueta pendientes, de caso contrario si se tiene false indica que ya no se tienen documentos.
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | Código | Código de retorno. Ver catálogo de respuesta del método |
Int | CorrelativoEmpresa | Número correlativo de la empresa |
String | estatus | Estatus del documento en el que se encuentra (Ver tabla relacionada) |
String | cufe | Certificado Único de Facturación Electrónica. |
Date | fechaemision | Fecha en el que fue emitido el documento |
Date | fecharecepcion | Fecha en que anexado |
Time | horaemisión | Hora de emisión |
Int | montotal | Monto total de la factura electrónica |
String | numerodocumento | Identificador del documento |
Int | numeroidentificacion | NIT del Emisor o Identificador Tributario del Emisor de la Factura |
String | razonsocial | Razón social del Emisor |
String | tipodocumento | Identificador del documento |
Int | tipoemisor | |
Int | tipoentidad | Identificador del Emisor (Revisión de tabla ) |
String | mensaje | Mensaje descriptivo del resultado de la operación |
Boolean | pendiente | respuesta (false/True |
String | resultado | Contiene información adicional (Procesado/Error) |
Int | ultimoenviado | Último número consecutivo |
Método Reporte
Muestra la lista de los 500 últimos documentos de Facturación Electrónica, que se han recibidos para un Receptor dado y que tienen asociado un consecutivo menor a un valor suministrado.
El reporte mostrará la información del documento, sin importar que estatus tenga.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | consecutivo | Número consecutivo de los documentos a revisa | número consecutivo del documento o en blanco |
String | tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:Reporte> <tem:request> <wcf:consecutivo>800</wcf:consecutivo> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3…………43</wcf:tokenPassword> </tem:request> </tem:Reporte> </soapenv:Body> </soapenv:Envelope>
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReporteResponse xmlns="http://tempuri.org/"> <ReporteResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>200</a:codigo> <a:documentoselectronicos> <a:InfoDocumento> <a:correlativoempresa>733</a:correlativoempresa> <a:cufe>0e12f97ef32ed6c1b104bfb...ad96f36060039e2d5f2</a:cufe> <a:estatusDIANcodigo/> <a:estatusDIANdescripcion/> <a:estatusDIANfecha/> <a:fechaemision>2021-08-31</a:fechaemision> <a:fecharecepcion>2022-02-17T16:56:55</a:fecharecepcion> <a:horaemision>01:01:45</a:horaemision> <a:montototal>412423.87</a:montototal> <a:numerodocumento>ABB12</a:numerodocumento> <a:numeroidentificacion>45......34</a:numeroidentificacion> <a:razonsocial>JD Proveedor 01</a:razonsocial> <a:tipodocumento>01</a:tipodocumento> <a:tipoemisor>1</a:tipoemisor> <a:tipoidentidad>31</a:tipoidentidad> </a:InfoDocumento> <a:InfoDocumento>...</a:InfoDocumento> </a:documentoselectronicos> <a:mensaje>Procesado</a:mensaje> <a:pendiente>true</a:pendiente> <a:resultado>Procesado</a:resultado> <a:ultimoEnviado>234</a:ultimoEnviado> </ReporteResult> </ReporteResponse> </s:Body> </s:Envelope>
NOTA: El ultimoEnviado es el número consecutivo para ver los archivos anteriores a el último que se muestra. Si se tienen más documentos el reporte mostrará true en la etiqueta pendientes, de caso contrario si se tiene false indica que ya no se tienen documentos.
Ejemplos: tomando el ultimoenviado
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:Reporte> <!--Optional:--> <tem:request> <!--Optional:--> <wcf:consecutivo>253</wcf:consecutivo> <!--Optional:--> <wcf:tokenEmpresa>89………b52</wcf:tokenEmpresa> <!--Optional:--> <wcf:tokenPassword>b3…………43</wcf:tokenPassword> </tem:request> </tem:Reporte> </soapenv:Body> </soapenv:Envelope>
Ejemplo Respuesta:Tomando el ultimo enviado
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReporteResponse xmlns="http://tempuri.org/"> <ReporteResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>200</a:codigo> <a:documentoselectronicos> <a:InfoDocumento> <a:correlativoempresa>252</a:correlativoempresa> <a:cufe>cdb0097ff69b252d8c1dd27b57fa8d5637a661de7a30e0554c99babd295354506dbdb33c48ba3c6dfbd8fc474984a60c</a:cufe> <a:estatusDIANcodigo/> <a:estatusDIANdescripcion/> <a:estatusDIANfecha/> <a:fechaemision>2021-08-11</a:fechaemision> <a:fecharecepcion>2021-11-26T12:19:30</a:fecharecepcion> <a:horaemision>15:00:00</a:horaemision> <a:montototal>1593558.75</a:montototal> <a:numerodocumento>LAS40021</a:numerodocumento> <a:numeroidentificacion>45671234</a:numeroidentificacion> <a:razonsocial>Karmi</a:razonsocial> <a:tipodocumento>01</a:tipodocumento> <a:tipoemisor>1</a:tipoemisor> <a:tipoidentidad>31</a:tipoidentidad> </a:InfoDocumento> .............. <a:InfoDocumento> <a:correlativoempresa>1</a:correlativoempresa> <a:cufe>e1307a9f41f427d2ce379a6b951b82fe3c0c2400468ed22bb3f571f50112c7c67ee551d865c50b95252f62b06043b14b</a:cufe> <a:estatusDIANcodigo/> <a:estatusDIANdescripcion/> <a:estatusDIANfecha/> <a:fechaemision>2021-08-11</a:fechaemision> <a:fecharecepcion>2021-08-13T10:44:47</a:fecharecepcion> <a:horaemision>15:00:00</a:horaemision> <a:montototal>1593558.75</a:montototal> <a:numerodocumento>LAS15143</a:numerodocumento> <a:numeroidentificacion>45671234</a:numeroidentificacion> <a:razonsocial>Karmi</a:razonsocial> <a:tipodocumento>01</a:tipodocumento> <a:tipoemisor>1</a:tipoemisor> <a:tipoidentidad>31</a:tipoidentidad> </a:InfoDocumento> </a:documentoselectronicos> <a:mensaje>Procesado</a:mensaje> <a:pendiente>false</a:pendiente> <a:resultado>Procesado</a:resultado> <a:ultimoEnviado>1</a:ultimoEnviado> </ReporteResult> </ReporteResponse> </s:Body> </s:Envelope>
Apartado pendientes: False es indicativo que no hay más documentos por mostrar, True indica que hay más documentos anteriores.
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Tabla 3
Código | Descripción |
---|---|
00 | Cargado |
01 | Entregado |
02 | Aceptación expresa (DIAN) |
04 | Reclamo (DIAN) |
10 | Acuse de recibo (DIAN |
11 | Rechazado (DIAN) |
12 | Recibo del bien y/o prestación del servicio |
13 | Precargado |
Método de Descarga XML
Permite obtener el Archivo XML codificado Base64, correspondiente al documento de Facturación Electrónica identificado por un valor dado y emitido por un emisor identificado, cuyo adquiriente es el Receptor que lo está solicitando.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:DescargarXML> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>ABB10</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:DescargarXML> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
- | archivo | Archivo en Base 64 |
Int | Código | Código de retorno. Ver catálogo de respuesta del método |
String | crc | Chequeo de Redundancia Cíclica |
String | cufe | Certificado Único de Facturación Electrónica. |
String | mensaje | Mensaje descriptivo del resultado de la operación |
String | resultado | Contiene información adicional (Procesado/Error) |
Int | size | Tamaño del documento |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DescargarXMLResponse xmlns="http://tempuri.org/"> <DescargarXMLResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:archivo>PD94b………………….b2N1bWVudD4=</a:archivo> <a:codigo>200</a:codigo> <a:crc>4ecd4e588d71e689a32bb07d92c58b4e</a:crc> <a:cufe>0e12f97ef32ed6c1b104bfb13...f36060039e2d5f2</a:cufe> <a:mensaje>Se retorna el archivo solicitado</a:mensaje> <a:resultado>Procesado</a:resultado> <a:size>44864</a:size> </DescargarXMLResult> </DescargarXML </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método de Descarga RepresentacionGrafica
Permite obtener el Archivo que contiene la Representación Gráfica codificado Base64, correspondiente al documento de Facturación Electrónica identificado por un valor dado y emitido por un emisor identificado, cuyo adquiriente es un Receptor que lo está solicitando
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:DescargarRepGrafica> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>LAS40588</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:DescargarRepGrafica> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | codigo | Código de retorno. Ver catálogo de respuesta del método |
string | mensaje | Mensaje descriptivo del resultado de la operación |
String | resultado | Contiene información adicional (Procesado/Error) |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DescargarRepGraficaResponse xmlns="http://tempuri.org/"> <DescargarRepGraficaResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:archivo i:nil="true"/> <a:codigo>102</a:codigo> <a:crc i:nil="true"/> <a:cufe i:nil="true"/> <a:mensaje>Longitud No Válida para el Tipo de Identificador del Emisor</a:mensaje> <a:resultado>Error</a:resultado> <a:size i:nil="true"/> </DescargarRepGraficaResult> </DescargarRepGraficaResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método de Descarga de Adjuntos/Anexos
Permite obtener el Archivo que contiene el Anexo cuya identificación interna fue indicada, correspondiente al documento de Facturación Electrónica identificado por un valor dado y emitido por un emisor identificado, cuyo adquiriente es el Receptor que lo está solicitando. El contenido del archivo es presentado codificado base64.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | IdentificadorinternoAnexo | corresponde al identificador interno (NameFile) del anexo que se desea descargar. | El FileName se obtiene con el método ListaAnexo* |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:DescargarAnexo> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:identificadorInternoAnexo>32168992-676A-44C8-862D-F5E5EBC762DB</wcf:identificadorInternoAnexo> <wcf:numeroDocumento>LAS40588</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:DescargarAnexo> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
- | archivo | Archivo XML en Base64 que contiene el documento electrónico. |
Int | codigo | Código de retorno. Ver catálogo de respuesta del método |
String | crc | Chequeo de Redundancia Cíclica |
String | cufe | Certificado Único de Facturación Electrónica. |
String | displayname | |
String | extension | Tipo de documento que se tiene |
Int | idfile |
|string |mensaje |Mensaje descriptivo del resultado de la operación |- |String |resultado |Contiene información adicional (Procesado/Error) |- |Int |sizefile |Tamaño del documento |- |Int |Type |Tipo de documento, (Ver catálogo) |}
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DescargarAnexoResponse xmlns="http://tempuri.org/"> <DescargarAnexoResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:archivo>JVB……………………….YK</a:archivo> <a:codigo>200</a:codigo> <a:crc>5e9b2925ae58b8f7c2c95ef8d748d864</a:crc> <a:cufe>6c406410fc912ca1...8da809c1517da5</a:cufe> <a:displayname>ad0000346585016210001271e</a:displayname> <a:extension>pdf</a:extension> <a:idfile>5984</a:idfile> <a:mensaje>Se retorna el archivo solicitado</a:mensaje> <a:resultado>Procesado</a:resultado> <a:sizefile>43203</a:sizefile> <a:type>2</a:type> </DescargarAnexoResult> </DescargarAnexoResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método Consulta de Estado Documento
Permite conocer el estatus, así como la lista de estados por la que ha pasado un documento de Facturación Electrónica, que originalmente fue remitida por un Proveedor, cuyo adquiriente tiene como proveedor tecnológico de Facturación Electrónica a The Factory HKA Colombia
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:EstadoDocumento> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>ABB09</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:EstadoDocumento> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
String | comentarios | Status del documento . Ver catálogo de respuesta del método |
String | descripcion | Descripción del status relacionado |
Int | codigoEStatus | Código del estatus |
Date | fecha | fecha en formato “s” ”( yyyy'-'MM'-'dd'T'HH':'mm':'ss ) del estatus actual |
String | uuid | Identificador Universal Único |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EstadoDocumentoResponse xmlns="http://tempuri.org/"> <EstadoDocumentoResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:ListEstatusHistory> <a:HistorialEstatus> <a:Comentarios>Pasa del estado Acuse de recibo (DIAN) al estado Aceptación expresa (DIAN)</a:Comentarios> <a:Descripcion>Aceptación expresa (DIAN)</a:Descripcion> <a:codigoEstatus>2</a:codigoEstatus> <a:fecha>2022-03-07 13:37:47</a:fecha> </a:HistorialEstatus> <a:HistorialEstatus> <a:Comentarios>Pasa del estado Acuse de recibo (DIAN) al estado Recibo del bien y/o prestación del servicio</a:Comentarios> <a:Descripcion>Recibo del bien y/o prestación del servicio</a:Descripcion> <a:codigoEstatus>12</a:codigoEstatus> <a:fecha>2022-03-07 13:37:46</a:fecha> </a:HistorialEstatus> <a:HistorialEstatus> <a:Comentarios>Pasa del estado Acuse de recibo (DIAN) al estado Acuse de recibo (DIAN)</a:Comentarios> <a:Descripcion>Acuse de recibo (DIAN)</a:Descripcion> <a:codigoEstatus>10</a:codigoEstatus> <a:fecha>2022-03-07 13:32:19</a:fecha> </a:HistorialEstatus> <a:HistorialEstatus> <a:Comentarios>Cambio de Estado a Entregado por Descarga de Documento Electrónico</a:Comentarios> <a:Descripcion>Entregado</a:Descripcion> <a:codigoEstatus>1</a:codigoEstatus> <a:fecha>2022-02-11 12:38:25</a:fecha> </a:HistorialEstatus> <a:HistorialEstatus> <a:Comentarios>Cargado</a:Comentarios> <a:Descripcion>Cargado</a:Descripcion> <a:codigoEstatus>0</a:codigoEstatus> <a:fecha>2022-02-11 12:23:02</a:fecha> </a:HistorialEstatus> </a:ListEstatusHistory> <a:codigo>200</a:codigo> <a:estatusDIANDescripcion/> <a:estatusDIANcodigo/> <a:estatusDIANfecha/> <a:estatusDocumento>Aceptación expresa (DIAN)</a:estatusDocumento> <a:fechaDocumento>2022-02-11T12:23:01</a:fechaDocumento> <a:mensaje>Se retorna los datos del estado del documento</a:mensaje> <a:resultado>Procesado</a:resultado> <a:tipoDocumento>01</a:tipoDocumento> <a:uuid>0e12f97ef3...060039e2d5f2</a:uuid> </EstadoDocumentoResult> </EstadoDocumentoResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método Cambio de Status
Permite cambiar el estatus de un documento de Facturación Electrónica, que originalmente fue emitida por un Emisor, del cual el adquiriente tiene como proveedor tecnológico de Facturación Electrónica a The Factory HKA Colombia.
Nota:Si el documento está en un estado DIAN y se requiere cambiar a otro estado y es imposible hacerlo, puede que esté en espera para recibir respuesta de la DIAN, por lo cual se debe de esperar 5 minutos para realizar el cambio
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
String | Identificadorinternoanexo | dentificador del Anexo el cual debe de consultarse en el Método de ListaAnexo | |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
El código de Rechazo es requerido para realizar cualquier cambio de estado.
CodigoRechazo
Código | Descripción |
---|---|
01 | Documento con inconsistencias |
02 | Mercancía no entregada totalmente |
03 | Mercancía no entregada parcialmente |
04 | Servicio no prestado |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:CambioEstatus> <tem:request> <wcf:EjecutadoPor> <wcf:Apellido>López</wcf:Apellido> <wcf:Cargo>Recursos</wcf:Cargo> <wcf:Departamento>RG</wcf:Departamento> <wcf:Identificacion> <wcf:Dv>9</wcf:Dv> <wcf:NumeroIdentificacion>31</wcf:NumeroIdentificacion> <wcf:TipoIdentificacion>31</wcf:TipoIdentificacion> </wcf:Identificacion> <wcf:Nombre>Adriana</wcf:Nombre> </wcf:EjecutadoPor> <wcf:codigoRechazo>01</wcf:codigoRechazo> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>ABB01</wcf:numeroDocumento> <wcf:status>13</wcf:status> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:CambioEstatus> </soapenv:Body> </soapenv:Envelope> ; RESPONSE: Parámetros a Recibir {| class="mw-collapsible mw-collapsed wikitable" style="margin: auto;" |- ! style="background:#f2f2f2; text-align:center;"|Tipo ! style="background:#f2f2f2; text-align:center;"|Identificador ! style="background:#f2f2f2; text-align:center;"|Descripción |- valign="center" |- |Int |Código |Código de retorno. Ver catálogo de respuesta del método |- |String |mensaje |Mensaje descriptivo del resultado de la operación |- |String |resultado |Contiene información adicional (Procesado/Error) |} ==<font color="Blue">Ejemplo de salida</font>== <pre> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <CambioEstatusResponse xmlns="http://tempuri.org/"> <CambioEstatusResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>103</a:codigo> <a:mensaje>Se produjo un error en el servicio...{"Codigo":"108","Mensaje":"No se pudo cambiar el status del Documento ABB01 emitido por NIT 45......34 a NIT 12.....9. Estatus no válido. No está permitido el status Precargado cuando se está en el estatus Acuse de recibo (DIAN)","Resultado":"Error"} por favor inténtelo más tarde</a:mensaje> <a:resultado>Error</a:resultado> </CambioEstatusResult> </CambioEstatusResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Tabla 1
Código | Descripción |
---|---|
00 | Cargado |
01 | Entregado |
02 | Aceptación expresa (DIAN) |
04 | Reclamo (DIAN) |
10 | Acuse de recibo (DIAN |
11 | Rechazado (DIAN) |
12 | Recibo del bien y/o prestación del servicio |
13 | Precargado |
Método Consulta de Metadata (a los documentos) ConsultaDocumentosMetadata
(Infodatos) Permite a un Receptor consultar el o los metadato(s) correspondientes a un documento de Facturación Electrónica, identificado con el numero documento, emitido por un proveedor de bienes y servicios identificado al Receptor ya mencionado
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
numeroDocumento | Identificador del documento | Hasta 20 caracteres | |
String | tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:CosultaDocumentoMetadata> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>ABB09</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:CosultaDocumentoMetadata> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
String | createdat | Creación del Infodato |
String | createdby | Quien lo creo |
String | label | Nombre del Infodato |
Time | updatedat | Tiempo de relación |
String | value | Nombre de la subcategoría o valor que está relacionado del Infodato |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <CosultaDocumentoMetadataResponse xmlns="http://tempuri.org/"> <CosultaDocumentoMetadataResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:ListMetadata> <a:SPPostMetadata> <a:createdat>2022-02-17T12:08:47</a:createdat> <a:createdby>Customer</a:createdby> <a:label>Nueva Categoría 2</a:label> <a:updatedat>2022-02-17T12:08:47</a:updatedat> <a:updatedby>Customer</a:updatedby> <a:value>A</a:value> </a:SPPostMetadata> <a:SPPostMetadata> <a:createdat>2022-02-17T12:08:47</a:createdat> <a:createdby>Customer</a:createdby> <a:label>Nueva Categoría</a:label> <a:updatedat>2022-02-17T12:08:47</a:updatedat> <a:updatedby>Customer</a:updatedby> <a:value>Calle Carrera</a:value> </a:SPPostMetadata> <a:SPPostMetadata> <a:createdat>2022-02-17T12:08:47</a:createdat> <a:createdby>Customer</a:createdby> <a:label>Regiones 1</a:label> <a:updatedat>2022-02-17T12:08:47</a:updatedat> <a:updatedby>Customer</a:updatedby> <a:value>J&J</a:value> </a:SPPostMetadata> </a:ListMetadata> <a:codigo>200</a:codigo> <a:estatusDIANDescripcion/> <a:estatusDIANcodigo/> <a:estatusDIANfecha/> <a:estatusDocumento>Aceptación expresa (DIAN)</a:estatusDocumento> <a:fechaDocumento>2022-02-11T12:23:01</a:fechaDocumento> <a:mensaje>Se retorna los datos sobre metadatos del documento</a:mensaje> <a:resultado>Procesado</a:resultado> <a:tipoDocumento>01</a:tipoDocumento> <a:uuid>0e12f97ef32ed6...11ad96f36060039e2d5f2</a:uuid> </CosultaDocumentoMetadataResult> </CosultaDocumentoMetadataResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método ListaAnexo
Permite obtener la lista de anexos asociados al documento de Facturación Electrónica identificado por un valor dado y emitido por un emisor identificado, cuyo adquiriente es el Receptor que lo está solicitando
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
String | numeroDocumento | Identificador del documento | Hasta 20 caracteres |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:ListaAnexo> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:numeroDocumento>LAS40588</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89………………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:ListaAnexo> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | InvoiceFileId | Campo de control de identificación del archivo |
InvoiceId | Campo de control de identificación del documento | |
TypeCode | Entero que indica el código de tipo de anexo; a saber admite los siguientes valores (Ver tabla) | |
size | tamaño del documento | |
String | Format | Extensión del Archivo |
NameDisplay | Nombre Archivo dado por el Proveedor Tecnológico, hasta 100 caracteres | |
PathFile | Campo de control de identificación del documento | |
Type | Indica el tipo de adjunto; a saber : Representación Gráfica, Anexo, Acuse de Recibido, Acuse de Aceptado, Acuse de Rechazado y Acuse de Aceptación Tácita | |
NameFile | Nombre interno del archivo. Este valor es usado tanto para la solicitud de recuperación, como la solicitud de eliminación del archivo | |
Time | UpdatedAt | fecha de la última actualización del archivo |
CreatedAt | Fecha en la que fue incorporado el archivo | |
Boolean | ProviderVisible | Indicador que señala si el archivo puede ser descargado por el emisor |
NameFile : Este es indispensable para el método DercargaAnexo este debe de coincidir Type: Anexo. Para la descarga del Anexo que es el siguiente método
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ListaAnexoResponse xmlns="http://tempuri.org/"> <ListaAnexoResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:ListArchivoDocumento> <a:ArchivoDocumento> <a:CreatedAt>2022-02-01T10:14:09.223</a:CreatedAt> <a:Format>.pdf</a:Format> <a:InvoiceFileId>5782</a:InvoiceFileId> <a:InvoiceId>19981</a:InvoiceId> <a:NameDisplay>LAS40588</a:NameDisplay> <a:NameFile>LAS40588</a:NameFile> <a:PathFile>Recepcion/542/31/45......34/2021/8/11/LAS40588/</a:PathFile> <a:ProviderVisible>true</a:ProviderVisible> <a:Type>Representacion Gráfica</a:Type> <a:TypeCode>1</a:TypeCode> <a:UpdatedAt>2022-02-01T10:14:09.223</a:UpdatedAt> <a:size>43282</a:size> </a:ArchivoDocumento> <a:ArchivoDocumento> <a:CreatedAt>2022-03-09T12:16:47.597</a:CreatedAt> <a:Format>.pdf</a:Format> <a:InvoiceFileId>5984</a:InvoiceFileId> <a:InvoiceId>19981</a:InvoiceId> <a:NameDisplay>ad0000346585016210001271e</a:NameDisplay> <a:NameFile>32168992-676A-44C8-862D-F5E5EBC762DB</a:NameFile> <a:PathFile>Recepcion/542/31/45......34/2021/8/11/LAS40588/</a:PathFile> <a:ProviderVisible>true</a:ProviderVisible> <a:Type>Anexo</a:Type> <a:TypeCode>2</a:TypeCode> <a:UpdatedAt>2022-03-09T12:16:47.597</a:UpdatedAt> <a:size>43203</a:size> </a:ArchivoDocumento> </a:ListArchivoDocumento> <a:codigo>200</a:codigo> <a:mensaje>Se retorna los datos del Archivos asociados al documento LAS40588 emitido por el NIT 45......34 al solicitante con NIT 12.....9</a:mensaje> <a:resultado>Procesado</a:resultado> </ListaAnexoResult> </ListaAnexoResponse> </s:Body>
Tabla 2
Código | Descripción |
---|---|
1 | Representación Gráfica |
2 | Anexo |
3 | Para uso futuro |
4 | Para uso futuro |
5 | Acuse de recibo de Factura Electrónica de Venta |
6 | Acuse Aceptación expresa |
7 | Acuse de Reclamo de la Factura Electrónica de Venta |
12 | Acuse de Recibo del bien y/o prestación del servicio |
Método DescargaAnexo
Permite la descarga del Anexo o adjunto del documento que se encuentra vinculado al documento de factura. Que originalmente fue anexada al documento.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 20 dígitos |
String | identificadorinternoanexo | Identificador del Anexo el cual debe de consultarse en el Método de ListaAnexo | |
tipoIdentificacionemisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres | |
numeroDocumento | Identificador del documento | Hasta 20 caracteres | |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:DescargarAnexo> <tem:request> <wcf:identificadorEmisor>45......34</wcf:identificadorEmisor> <wcf:identificadorInternoAnexo>32168992-0000-44C8-862D-F5E5EBC762DB</wcf:identificadorInternoAnexo> <wcf:numeroDocumento>LAS40588</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:DescargarAnexo> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
- | archivo | Archivo en Base 64 del documento |
Int | codigo | Código de retorno, (Ver catálogo de respuesta del método) |
Id | Id del documento. | |
Type | Tipo de documento, (Ver catálogo) | |
sizeFile | tamaño del documento | |
String | crc | Chequeo de Redundancia Cíclica |
String | cufe | Certificado Único de Facturación Electrónica. |
String | displayname | |
String | extension | Tipo de documento que se tiene |
string | mensaje | Mensaje descriptivo del resultado de la operación |
String | resultado | Contiene información adicional (Procesado/Error) |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DescargarAnexoResponse xmlns="http://tempuri.org/"> <DescargarAnexoResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:archivo>JVBERi0xLjQKM……</a:archivo> <a:codigo>200</a:codigo> <a:crc>5e9b2925ae58b8f7c2c95ef8d748d864</a:crc> <a:cufe>6c406410fc912ca1a937d1b...e08ad3c91fa8da809c1517da5</a:cufe> <a:displayname>ad0000346585016210001271e</a:displayname> <a:extension>pdf</a:extension> <a:idfile>5984</a:idfile> <a:mensaje>Se retorna el archivo solicitado</a:mensaje> <a:resultado>Procesado</a:resultado> <a:sizefile>43203</a:sizefile> <a:type>2</a:type> </DescargarAnexoResult> </DescargarAnexoResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método Envío de XML Método de “EnviarXML”
Permite enviar el archivo XML que representa Documento Fiscal Electrónico, el cual fue emitido por un proveedor* de bienes y servicios a un cliente The Factory HKA Colombia, el archivo XML está representado en Base64. Opcionalmente se puede remitir los llamados Metadatos
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | metadata | Lista Optativa de cuarteto, que permite especificar atributos adicionales referentes al Documento Fiscal Electrónico; los cuartetos son de la forma (code, value, internal1 (optativo), internal2 (optativo)); estableciendo una asociación entre el elemento code (que representa el código de metadata ) y el resto de los “atributos” del cuarteto en cuestión. | |
String | archivo | Archivo XML en Base64 que contiene el documento electrónico que se desea enviar | |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:EnviarXML> <tem:request> <wcf:archivo>PD94b…………..bnQ+</wcf:archivo> <wcf:metadata> <wcf:metadata> <wcf:Metadata> <wcf:code>01</wcf:code> <wcf:internal1/> <wcf:internal2/> <wcf:value/> </wcf:Metadata> </wcf:metadata> </wcf:metadata> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> </tem:request> </tem:EnviarXML> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
- | archivo | Archivo en Base 64 del documento |
Int | codigo | Código de retorno, (Ver catálogo de respuesta del método) |
numeroIdentificacion | Id del documento. | |
tipoIdentificacion | Tipo de identificación del documento | |
String | Identificador del documento | |
estatusDocumento | Estatus del Documento | |
mensaje | Mensaje descriptivo del resultado de la operación | |
String | resultado | Contiene información adicional (Procesado/Error) |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EnviarXMLResponse xmlns="http://tempuri.org/"> <EnviarXMLResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>203</a:codigo> <a:documentoId>AHJ07</a:documentoId> <a:estatusDocumento>Cargado</a:estatusDocumento> <a:mensaje>Documento Enviado Satisfactoriamente - Problema(s) con Metadato(s) : Valor(es) suministrado(s) para Metadato(s) no corresponde(n) a la(s) lista(s) definida(s)</a:mensaje> <a:numeroIdentificacion>45......34</a:numeroIdentificacion> <a:resultado>Procesado</a:resultado> <a:tipoIdentificacion>31</a:tipoIdentificacion> </EnviarXMLResult> </EnviarXMLResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Método Envío de Representación Gráfica (EnviarRepGrafica)
Permite a un Receptor enviar el archivo que corresponde a la representación gráfica de un documento de Facturación Electrónica, identificado con el número documento, emitido por un proveedor de bienes y servicios identificado al Receptor ya mencionado; el archivo está codificado en Base64.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
Int | visible | Indica si el archivo posteriormente puede ser o no descargado por el Emisor | Visible = 1, No visible = 0, 1 dígito |
identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | ||
String | archivo | Archivo XML en Base64 que contiene el documento electrónico que se desea enviar | |
nombre | Nombre del documento de la Representación Gráfica | Hasta 100 caracteres | |
extension | Indica el formato del archivo remitido; los valores admitidos son | bmp|jpg|pdf|doc|docx|xls|xlsx|ppt|pptx|rar|zip | |
identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | De 6 a 9 digitos | |
numeroDocumento | Identificador del documento | Hasta 20 caracteres | |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:EnviarRepGrafica> <tem:request> <wcf:archivo>JVB……FT0YK</wcf:archivo> <wcf:extension>ppt</wcf:extension> <wcf:identificadorEmisor>45…34</wcf:identificadorEmisor> <wcf:nombre>SOAP01-2</wcf:nombre> <wcf:numeroDocumento>SOAP019</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> <wcf:visible>1</wcf:visible> </tem:request> </tem:EnviarRepGrafica> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | codigo | Código de retorno, (Ver catálogo de respuesta del método) |
String | mensaje | Mensaje descriptivo del resultado de la operación |
String | resultado | Contiene información adicional (Procesado/Error) |
Ejemplo de salida
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EnviarRepGraficaResponse xmlns="http://tempuri.org/"> <EnviarRepGraficaResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>102</a:codigo> <a:mensaje>Token Password es Requerido</a:mensaje> <a:resultado>Error</a:resultado> </EnviarRepGraficaResult> </EnviarRepGraficaResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Mensaje: String que contiene mensaje descriptivo del resultado de la operación resultado: String que contiene información adicional (Uso futuro)
Método Envío de Anexo (EnvioAnexo)
Permite a un Receptor enviar un archivo que archivo que se “adjunta” a un documento de Facturación Electrónica , identificado con el numero documento, emitido por un proveedor de bienes y servicios también identificado; al Receptor ya mencionado; el archivo está codificado en Base64.
- REQUEST
- Parámetros a Enviar
Tipo | Identificador | Descripción | Valor numérico |
---|---|---|---|
- | archivo | Archivo en Base64 que representa un anexo de factura identificada por número de documento | |
Byte | Indica si el archivo posteriormente puede ser o no descargado por el Emisor. | Visible = 1, No visible = 0, 1 dígito | |
Int | tipoidentificadoremisor | Identificador del Emisor (Revisión de tabla 1 ) | 2 caracteres |
identificadorEmisor | NIT del Emisor o Identificador Tributario del Emisor de la Factura | ||
String | nombre | Nombre del documento de la Representación Gráfica | Hasta 100 caracteres |
extension | Indica el formato del archivo remitido; los valores admitidos son | bmp|jpg|pdf|doc|docx|xls|xlsx|ppt|pptx|rar|zip | |
numeroDocumento | Identificador del documento | Hasta 20 caracteres | |
tokenEmpresa | Dato suministrado por The Factory HKA Colombia | 40 caracteres | |
tokenPassword |
Ejemplo de entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:wcf="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP"> <soapenv:Header/> <soapenv:Body> <tem:EnviarAnexo> <tem:request> <wcf:archivo>JVB…….</wcf:archivo> <wcf:extension>pdf</wcf:extension> <wcf:identificadorEmisor>456…34</wcf:identificadorEmisor> <wcf:nombre>AHJ07-7</wcf:nombre> <wcf:numeroDocumento>AHJ07</wcf:numeroDocumento> <wcf:tipoIdentificacionemisor>31</wcf:tipoIdentificacionemisor> <wcf:tokenEmpresa>89……………52</wcf:tokenEmpresa> <wcf:tokenPassword>b3……………43</wcf:tokenPassword> <wcf:visible>1</wcf:visible> </tem:request> </tem:EnviarAnexo> </soapenv:Body> </soapenv:Envelope>
- RESPONSE
- Parámetros a Recibir
Tipo | Identificador | Descripción |
---|---|---|
Int | codigo | Código de retorno, (Ver catálogo de respuesta del método) |
String | mensaje | Mensaje descriptivo del resultado de la operación |
String | resultado | Contiene información adicional (Procesado/Error) |
Ejemplo de salida
<?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <EnviarAnexoResponse xmlns="http://tempuri.org/"> <EnviarAnexoResult xmlns:a="http://schemas.datacontract.org/2004/07/WcfRecepcionSOAP" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:codigo>200</a:codigo> <a:mensaje>Archivo enviado satisfactoriamente</a:mensaje> <a:resultado>Procesado</a:resultado> </EnviarAnexoResult> </EnviarAnexoResponse> </s:Body> </s:Envelope>
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |
Mensaje: String que contiene mensaje descriptivo del resultado de la operación resultado: String que contiene información adicional (Uso futuro)
Tabla 2
Código | Descripción |
---|---|
200 | Reporte Generado Satisfactoriamente |
102 | El campo {nombre del campo} es requerido / La longitud del campo {nombre del campo} no cumple con el rango / Valor no válido para el campo {nombre del campo} |
103 | Error Interno en el Servicio |