API Reference — Panamá | Digifact Developer Portal

🧪 Test

https://testnucpa.digifact.com/api

🚀 Producción

https://nucpa.digifact.com/api

ℹ️

Todas las operaciones requieren un token JWT obtenido en GET TOKEN. El token expira automáticamente — al recibir un error 401, solicitar un nuevo token.

POSTObtención del TOKENGet Token

El primer paso es la obtención del TOKEN, este se utilizará como forma de autenticación para las peticiones que se detallan más adelante. Para obtener el Token deberá agregar en el Body/Cuerpo de la solicitud, los atributos: Username, y el Password, proporcionado en las credenciales, enviados en formato JSON. Donde Username será la concatenación siguiente, separada por punto (.): PA + "." + <RUC del usuario> + "." + <Nombre de usuario>.

TESThttps://testnucpa.digifact.com/api/login/get_token

PRODhttps://nucpa.digifact.com/api/login/get_token

Body

Nombre	Tipo	Req.	Descripción	Ejemplo
Username	string	Req	Concatenación separada por punto (.): PA + "." + <RUC del usuario> + "." + <Nombre de usuario>	PA.155704849-2-2021.USER_TEST
Password	string	Req	Password brindado en las credenciales TEST o Productivas según sea el caso

Respuesta

Nombre	Tipo	Descripción
Token	string	Token generado. Tendrá una vigencia de 30 días a partir del momento que se solicita.

ℹ️

Solicitar credenciales TEST a través del correo de soporte [email protected] brindando su nombre, nombre de la empresa que representa y un número de contacto, colocando como Subject: "Solicitud de credenciales TEST". También podrá hacerlo a través del número 2319-1921 opción 2.

⚠️

El token generado tendrá una vigencia de 30 días a partir del momento que se solicita. Una vez se haya vencido el token la API mostrará como respuesta a cualquier petición el mensaje con el código de error 401 o Unauthorized. Y será necesario generar un nuevo token para poder realizar consultas autorizadas a la API.

ℹ️

El token se deberá agregar como encabezado en la petición, ingresando el nombre de Authorization y en su valor el Token vigente.

Ejemplo de Request

curl -X POST "https://testnucpa.digifact.com/api/login/get_token" \
  -d '{
  "Username": "PA.155704849-2-2021.USER_TEST",
  "Password": "<password de las credenciales>"
}'

Ejemplo de Response

json

POSTCertificación NUC JSONCertificar JSON

Transforma una cadena con un esquema definido (NUC) en formato JSON a su factura electrónica correspondiente y realiza la certificación de la misma. El funcionamiento de la API va de la mano con las validaciones de la Factura Electrónica de Panamá creada por la Dirección General de Ingresos (DGI).

TESThttps://testnucpa.digifact.com/api/v2/transform/nuc_json

PRODhttps://nucpa.digifact.com/api/v2/transform/nuc_json

Headers

Nombre	Req.	Descripción
Authorization	Req	Token vigente

Query Params

Nombre	Req.	Descripción	Ejemplo
TAXID	Req	RUC del emisor	155704849-2-2021
FORMAT	Req	Formatos de respuesta para visualizar la factura: XML, PDF o HTML. Se pueden ingresar separados por pipelines: XML\|HTML\|PDF
USERNAME	Req	Nombre de usuario quien realiza la consulta	USER_EXAMPLE

Body

Nombre	Req.	Descripción
BODY (raw)	Req	JSON con el contenido del NUC. Ver en sección Formato del NUC.

Respuesta

Nombre	Tipo	Descripción
code	string	muestra el código de la respuesta obtenida. Ver detalle de códigos en Códigos dentro de la Respuesta
message	string	contiene un mensaje informativo relacionado a la respuesta
description	string	descripción adicional del mensaje
responseData1	string	texto codificado en base64 que contiene la factura el formato XML
responseData2	string	texto codificado en base64 que contiene la factura el formato HTML
responseData3	string	texto codificado en base64 que contiene la factura el formato PDF
authNumber	string	CUFE o código único de la factura electrónica
url	string	url del QR generado para consultar la factura
infoDetails	array	atributo tipo arreglo de objetos que, cuando la respuesta es un error, muestra el listado de errores que contiene el XML. Atributos: evento (tipo de error), dCodRes (código del error), dMsgRes (descripción de error)
suggestedFileName	string	nombre sugerido para nombrar y guardar el contenido de la información que contiene el responseData1, responseData2, responseData3 o algún otro documento relacionado con la información de la factura emitida.
suggestedFileName2	string	otro nombre sugerido
batch	string	número de serie de la factura
serial	string	número de documento fiscal
issuedTimeStamp	string	fecha de emisión de la factura electrónica
taxID	string	RUC del contribuyente emisor de la factura
name	string	nombre o razón social del emisor
branchCode	string	código de establecimiento o sucursal donde fue emitida la factura, atributo sin valor por el momento
branchName	string	nombre comercial, atributo sin valor por el momento
receiverTaxID	string	RUC del receptor/comprador
receiverName	string	nombre o razón social del receptor
discounts	string	indica el total de descuentos aplicados a la factura, atributo sin valor por el momento
taxes	string	indica el total de impuestos aplicados a la factura, atributo sin valor por el momento
subtotal	string	subtotal de la factura, atributo sin valor por el momento
totalAmount	string	monto total de la factura
enrolledTimeStamp	string	fecha y hora de certificación de la factura
backprocessor	string	servidor que realiza la consulta
additionalInfo	object	atributo tipo objeto que contiene información adicional sobre la factura emitida. Actualmente puede contener: DocumentGUID (identificador único del documento emitido) y ProtocoloAutorizacion (protocolo de autorización del documento emitido).

ℹ️

Ejemplo de URL: https://testnucpa.digifact.com/api/v2/transform/nuc_json?TAXID=155704849-2-2021&FORMAT=XML|HTML&USERNAME=USER_EXAMPLE

⚠️

Los nombres de los campos y datos que hagan referencia a información deben ser ingresados tomando en cuenta las mayúsculas y minúsculas, es decir, el API es case sensitive; si no se ingresan los valores como se espera, la aplicación no podrá generar el texto equivalente a la Factura Electrónica.

Ejemplo de Request

curl -X POST "https://testnucpa.digifact.com/api/v2/transform/nuc_json?TAXID=155704849-2-2021&FORMAT=%3CFORMAT%3E&USERNAME=USER_EXAMPLE" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

POSTCERTIFICATE_FE_XML_TOSIGN V2Certificar XML v2

Esta operación permitirá generar un documento -FE- el cual espera dentro del Body, el XML respectivo, de acuerdo al tipo de documento que se está solicitando, bajo el esquema de la DGI. Realiza la misma funcionalidad que el CERTIFICATE_FE_XML_TOSIGN V1, pero la diferencia se encuentra en la respuesta que devuelve la API. Hará todas las validaciones que la DGI ha normado tanto en su documentación técnica, como en lo publicado en el régimen FE.

TESThttps://testnucpa.digifact.com/api/v2/transform/nuc

PRODhttps://nucpa.digifact.com/api/v2/transform/nuc

Headers

Nombre	Req.	Descripción
Content-type	Req	application/xml
Authorization	Req	Token vigente

Query Params

Nombre	Req.	Descripción	Ejemplo
TAXID	Req	RUC del usuario.	23824-0930-212623
FORMAT	Req	Posibles valores: XML, PDF, HTML. Se deben ingresar separados por pipelines "\|" por ejemplo PDF\|HTML\|XML
USERNAME	Req	Usuario asignado de Test o Productivo según sea el caso.	La_Lechita

Body

Nombre	Req.	Descripción
BODY (raw)	Req	De acuerdo a la documentación proporcionada del NUC para Panamá

Respuesta

Nombre	Tipo	Descripción
code	string	contiene el código de la respuesta obtenida
message	string	contiene un mensaje informativo relacionado a la respuesta
description	string	descripción adicional del mensaje
responseData1	string	texto codificado en base64 que contiene la factura el formato XML
responseData2	string	texto codificado en base64 que contiene la factura el formato HTML
responseData3	string	texto codificado en base64 que contiene la factura el formato PDF
authNumber	string	CUFE o código único de la factura electrónica
url	string	url del QR generado para consultar la factura
infoDetails	array	atributo tipo arreglo de objetos que, cuando la respuesta es un error, muestra el listado de errores que contiene el XML. Atributos: evento (tipo de error), dCodRes (código del error), dMsgRes (descripción del error)
suggestedFileName	string	nombre sugerido para nombrar y guardar el contenido de la información que contiene el responseData1, responseData2, responseData3 o algún otro documento relacionado con la información de la factura emitida.
suggestedFileName2	string	otro nombre sugerido
batch	string	atributo sin valor por el momento
serial	string	atributo sin valor por el momento
issuedTimeStamp	string	fecha de emisión de la factura electrónica
taxID	string	RUC del contribuyente emisor de la factura
name	string	nombre o razón social del emisor
branchCode	string	código de establecimiento o sucursal donde fue emitida la factura, atributo sin valor por el momento
branchName	string	nombre comercial, atributo sin valor por el momento
receiverTaxID	string	RUC del receptor/comprador
receiverName	string	nombre o razón social del receptor
discounts	string	indica el total de descuentos aplicados a la factura, atributo sin valor por el momento
taxes	string	indica el total de impuestos aplicados a la factura, atributo sin valor por el momento
subtotal	string	subtotal de la factura, atributo sin valor por el momento
totalAmount	string	monto total de la factura
enrolledTimeStamp	string	fecha y hora de certificación de la factura
backprocessor	string	servidor que realiza la consulta
additionalInfo	object	atributo tipo objeto que contiene información adicional sobre la factura emitida. Actualmente puede contener: DocumentGUID (identificador único del documento emitido) y ProtocoloAutorizacion (protocolo de autorización del documento emitido).

⚠️

Solicitar credenciales. Únicamente funciona con credenciales productivas cuando se da de alta a un RUC en nuestros sistemas.

⚠️

Para el uso de esta operación en productivo, deberá proporcionarnos su firma electrónica y contraseña asignada a dicha firma, la cual obtiene en la agencia virtual de DGI. Si se está consumiendo en Test, no será necesario proporcionarla previamente.

🚫

La operación CERTIFICATE_FE_XML_TOSIGN V1 se encuentra obsoleta y no se le seguirá brindando mantenimiento. Si actualmente sigue utilizando esa operación le sugerimos que utilice la operación CERTIFICATE_FE_XML_TOSIGN V2.

Ejemplo de Request

curl -X POST "https://testnucpa.digifact.com/api/v2/transform/nuc?TAXID=23824-0930-212623&FORMAT=%3CFORMAT%3E&USERNAME=La_Lechita" \
  -H "Content-type: <valor>" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

POSTCANCEL FELAnular FE

La operación CANCEL FEL es un consumo de tipo POST, que realiza la anulación de un documento electrónico anteriormente emitido.

TESThttps://testnucpa.digifact.com/api/CancelFePA

PRODhttps://nucpa.digifact.com/api/CancelFePA

Headers

Nombre	Req.	Descripción
Authorization	Req	Token vigente
Content-Type	Req	application/json

Body

Nombre	Tipo	Req.	Descripción	Ejemplo
Taxid	string	Req	Número de identificación tributaria (RUC) del contribuyente emisor de la factura electrónica	123456112-3-2021
Cufe	string	Req	Código único de la factura electrónica que será anulada	FE0120000155704842-2-2021-3200012022080884296177330010110008136737
Motivo	string	Req	Descripción del motivo de anulación del documento
Username	string	Req	Nombre del usuario que realizará dicha anulación

Respuesta

Nombre	Tipo	Descripción
Codigo	string	Código de respuesta que indicará si la operación fue realizada exitosamente
Anulado	boolean	Atributo booleano que indicará si la anulación fue realizada correctamente
Mensaje	string	Contiene información relacionada a la respuesta

⚠️

Solicitar credenciales. Únicamente funciona con credenciales productivas cuando se da de alta a un RUC en nuestros sistemas.

Ejemplo de Request

curl -X POST "https://testnucpa.digifact.com/api/CancelFePA" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

Ejemplo de Response

json

GETSHARED_GETDTEINFOConsultar DTE por CUFE

Permite obtener un documento, bajo la identificación de la FE. Las operaciones de tipo GET permitirán obtener diferente información relacionada al contribuyente, como información fiscal, información sobre facturas, etc.

TESThttps://testnucpa.digifact.com/api/SHAREDINFO

PRODhttps://nucpa.digifact.com/api/SHAREDINFO

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
TRANSACTION	Req	Tipo de transacción	SHARED_INFO_EFACE
RUC	Req	RUC del usuario	23824-0930-212623
DATA1	Req	Tipo de procedimiento a ejecutar	SHARED_GETDTEINFO
DATA2	Req	Parámetros que acepte dicho procedimiento, separados por pipelines " \| "	AUTHNUMBER\|FE0120000155704849-2-2021-3200012022050185396177520010120008136739
USERNAME	Req	Nombre de usuario

Respuesta

Nombre	Tipo	Descripción
REQUEST_DATA	array	Este atributo contendrá en la primera y única posición de su arreglo los siguientes atributos: { "Respuesta", "Codigo", "Procesador", "Mensaje", "Descripcion", "Fecha" }
RESPONSE	array	Este atributo contendrá todas las respuestas que se obtengan. No tiene un formato en específico, depende de qué resultado devuelva la transacción. Nota: si se ingresa como DATA1 alguna operación que no exista y no devuelva un resultado, este arreglo se encontrará vacío. Campos: NIT_EMISOR (RUC del emisor de la factura electrónica), TIPO_DTE (Tipo de documento emitido), GUID (Identificador único del documento electrónico emitido), SERIE (Número de serie del documento), NUMERO (Número fiscal del documento), ESTATUS, FECHA_DE_EMISION (Fecha de emisión del documento), FECHA_DE_CERTIFICACION (fecha en que se realizó la certificación del documento), NIT_COMPRADOR (RUC del comprador, si es CF este dato se encuentra vacío), NOMBRE_COMPRADOR (Nombre o razón social del comprador), SUBTOTAL_SIN_DESCUENTO (Subtotal de la factura sin descuento), DESCUENTO (Descuento total en la factura), SUBTOTAL_CON_DESCUENTO (Subtotal de la factura aplicando descuento), IVA (Total de impuesto ITBMS), TOTAL (Total de la factura), ITEMS (Cantidad de ítems que contiene la factura), DTE (Xml en base64 de la factura electrónica), ESTADO_DGI (Estado en que se encuentra la factura ante la DGI: RECIBIDO_EXITOSAMENTE, EN_COLA_DE_ENVIO, ERROR_AL_ENVIAR), ESTADO_ANULACION (Si el documento fue anulado, indica el estado), ReferenciaInterna (Si se indica, contiene el numero de referencia interna)

ℹ️

Url de ejemplo: https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=23824-0930-212623&DATA1=SHARED_GETDTEINFO&DATA2=AUTHNUMBER|FE0120000155704849-2-2021-3200012022050185396177520010120008136739&USERNAME=Test_User

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=23824-0930-212623&DATA1=SHARED_GETDTEINFO&DATA2=AUTHNUMBER%7CFE0120000155704849-2-2021-3200012022050185396177520010120008136739&USERNAME=%3CUSERNAME%3E" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

"RESPONSE": [
  {
    "NIT_EMISOR": "155704849-2-2021",
    "TIPO_DTE": "FACT",
    "GUID": "87DF1A8C-C9DA-436F-B6B1-39E805CB51D1",
    "SERIE": "1139617701",
    "NUMERO": "813673",
    "ESTATUS": "",
    "FECHA_DE_EMISION": "9/14/2022 8:42:00 AM",
    "FECHA_DE_CERTIFICACION": "9/14/2022 10:30:07 AM",
    "NIT_COMPRADOR": "xxxx-xxx-xxxxx",
    "NOMBRE_COMPRADOR": "Nombre del comprador",
    "SUBTOTAL_SIN_DESCUENTO": "2.010000",
    "DESCUENTO": "0.000000",
    "SUBTOTAL_CON_DESCUENTO": "2.010000",
    "IVA": "0.000000",
    "TOTAL": "2.010000",
    "ITEMS": "1",
    "DTE": "PD94bWwgd..",
    "ESTADO_DGI": "RECIBIDO_EXITOSAMENTE ",
    "ESTADO_ANULACION": "-",
    "ReferenciaInterna": "-"
  }
]

GETGET DTE INFO BY NUMDOCConsultar DTE por número

Permite obtener un documento, indicando el número del documento fiscal o correlativo, el tipo de documento y el Ruc que emitió el mismo.

TESThttps://testnucpa.digifact.com/api/SHAREDINFO

PRODhttps://nucpa.digifact.com/api/SHAREDINFO

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
TRANSACTION	Req	Tipo de transacción	SHARED_INFO_EFACE
RUC	Req	RUC del usuario	23824-0930-212623
DATA1	Req	Tipo de procedimiento a ejecutar	SHARED_GETDTEINFO_BYNUMDOC
DATA2	Req	Datos a ingresar: STAXID: RUC del emisor; NUMFACT: número del documento fiscal; TIPODOC: tipo de documento que fue emitido, por ejemplo: 1 (perteneciente a Factura de Operación Interna), 3 (Factura de exportación), etc.	STAXID\|23824-0930-212623\|NUMFACT\|0000000005\|TIPODOC\|3
USERNAME	Req	Nombre de usuario

Respuesta

Nombre	Tipo	Descripción
REQUEST_DATA	array	Este atributo contendrá en la primera y única posición de su arreglo los siguientes atributos: { "Respuesta", "Codigo", "Procesador", "Mensaje", "Descripcion", "Fecha" }
RESPONSE	array	Campos: NIT_EMISOR (RUC del emisor de la factura electrónica), TIPO_DTE (Tipo de documento emitido), GUID (Identificador único del documento electrónico emitido), CUFE (Codigo Unico de Factura Electronica), SERIE (Número de serie del documento), NUMERO (Número fiscal del documento), ESTATUS, FECHA_DE_EMISION (Fecha de emisión del documento), FECHA_DE_CERTIFICACION (fecha en que se realizó la certificación del documento), NIT_COMPRADOR (RUC del comprador, si es CF este dato se encuentra vacío), NOMBRE_COMPRADOR (Nombre o razón social del comprador), SUBTOTAL_SIN_DESCUENTO (Subtotal de la factura sin descuento), DESCUENTO (Descuento total en la factura), SUBTOTAL_CON_DESCUENTO (Subtotal de la factura aplicando descuento), IVA (Total de impuesto ITBMS), TOTAL (Total de la factura), ITEMS (Cantidad de ítems que contiene la factura), DTE (Xml en base64 de la factura electrónica), ESTADO_DGI (Estado en que se encuentra la factura ante la DGI: RECIBIDO_EXITOSAMENTE, EN_COLA_DE_ENVIO, ERROR_AL_ENVIAR), ESTADO_ANULACION (Si el documento fue anulado, indica el estado), ReferenciaInterna (Si se indica, contiene el numero de referencia interna)

ℹ️

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=23824-0930-212623&DATA1=SHARED_GETDTEINFO_BYNUMDOC&DATA2=STAXID%7C23824-0930-212623%7CNUMFACT%7C0000000005%7CTIPODOC%7C3&USERNAME=%3CUSERNAME%3E" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

"RESPONSE": [
  {
    "NIT_EMISOR": "155704849-2-2021",
    "TIPO_DTE": "FACT",
    "GUID": "87DF1A8C-C9DA-436F-B6B1-39E805CB51D1",
    "CUFE": "FE0320000155704849-2-2021-3200002022090810000018430010126511502508",
    "SERIE": "1139617701",
    "NUMERO": "813673",
    "ESTATUS": "",
    "FECHA_DE_EMISION": "9/14/2022 8:42:00 AM",
    "FECHA_DE_CERTIFICACION": "9/14/2022 10:30:07 AM",
    "NIT_COMPRADOR": "xxxx-xxx-xxxxx",
    "NOMBRE_COMPRADOR": "Nombre del comprador",
    "SUBTOTAL_SIN_DESCUENTO": "2.010000",
    "DESCUENTO": "0.000000",
    "SUBTOTAL_CON_DESCUENTO": "2.010000",
    "IVA": "0.000000",
    "TOTAL": "2.010000",
    "ITEMS": "1",
    "DTE": "PD94bWwgd..",
    "ESTADO_DGI": "RECIBIDO_EXITOSAMENTE ",
    "ESTADO_ANULACION": "-",
    "ReferenciaInterna": "-"
  }
]

GETGET INFO FISCAL FEPARTNERInfo fiscal y sucursales

Permite obtener la información de los establecimientos y sucursales asociadas al RUC del emisor.

TESThttps://testnucpa.digifact.com/api/SHAREDINFO

PRODhttps://nucpa.digifact.com/api/SHAREDINFO

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
TRANSACTION	Req	Tipo de transacción	SHARED_INFO_EFACE
RUC	Req	RUC del usuario	23824-0930-212623
DATA1	Req	Tipo de procedimiento a ejecutar	SHARED_GetInfoFiscalFEPARTNER
DATA2	Req	Datos a ingresar: STAXID: RUC del emisor; sCountryCode: Código del país, en este caso "PA"	STAXID\|23824-0930-212623\| sCountryCode \|PA
USERNAME	Req	Nombre de usuario

Respuesta

Nombre	Tipo	Descripción
TaxID	string	Contiene el RUC del contribuyente
DV	string	Digito verificador
Nombre	string	Nombre del contribuyente
CodTipo	string	Tipo de Ruc
Tipo	string	Tipo de contribuyente
Estado	string	Estado (Activo/Inactivo)
TAXID1	string
EST	string	Información de los establecimientos que tiene el emisor, cada establecimiento es separado por el carácter "\|". La información de cada establecimiento se encuentra separada por el carácter "<", de la siguiente manera: "codigo o numero de establecimiento"<"nombre de sucursal"<"tipo de sucursal"<"estado (Activo/Inactivo)"
ESTDIR	string	Información de la ubicación de establecimientos o sucursales que tiene el emisor. Si se tiene más de una sucursal cada información es separada por el carácter "\|". La información de la ubicación se encuentra separada por el carácter "<", de la siguiente manera: "dirección"<"codigo de ubicacion"<"coordenadas"

ℹ️

Url de ejemplo: https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=155704849-2-2021&DATA1=SHARED_GetInfoFiscalFEPARTNER&DATA2=sCountryCode|PA|STAXID|155704849-2-2021&USERNAME=TESTUSER

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=23824-0930-212623&DATA1=SHARED_GetInfoFiscalFEPARTNER&DATA2=STAXID%7C23824-0930-212623%7C%20sCountryCode%20%7CPA&USERNAME=%3CUSERNAME%3E" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

"RESPONSE": [
  {
    "TaxID": "155704849-2-2021",
    "DV": "32",
    "Nombre": "Bocas del Toro",
    "CodTipo": "2",
    "Tipo": "",
    "estado": "ACTIVO",
    "TAXID1": "155704849-2-2021",
    "EST": "0001<Branch & Áéíóú<1<A| 0002<TestBranch2<2<A",
    "ESTDIR": "Dirección Test<1-1-1< 8.9213|-79| Direccion<1-1-1< 8.9213|-79"
  }
]

GETGET DOCUMENTObtener documento

Operación de tipo GET, permitirán obtener un documento específico por medio del número de autorización o CUFE.

TESThttps://testnucpa.digifact.com/api/GetDocument

PRODhttps://nucpa.digifact.com/api/GetDocument

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
CUFE	Req	Código único de factura electrónica que se desea obtener	FE1120000155704849-2-2021-3200012022080484296177280010120008136737
RUC	Req	RUC del usuario	23824-0930-212623
FORMAT	Req	Tipo de formato en que se desea recibir el documento en base64, puede ser XML, HTML o PDF, separados por pipelines " \| ". Ej. Si se desea recibir el documento en formato HTML y PDF: HTML\|PDF
USERNAME	Req	Nombre de usuario

Respuesta

Nombre	Tipo	Descripción
REQUEST_DATA	array	Este atributo contendrá en la primera y única posición de su arreglo los siguientes atributos: { "Respuesta", "Codigo", "Procesador", "Mensaje", "Descripcion", "Fecha" }
RESPONSE	array	Este atributo contendrá en la primera y única posición de su arreglo los siguientes atributos: { "ResponseData1", "ResponseData2", "ResponseData3" }. Nota: ResponseData1 corresponde al documento en formato XML, ResponseData2 corresponde al documento en formato HTML y ResponseData3 corresponde al documento en formato PDF. Si algún dato que se requiere en los parámetros no existe, la respuesta será un arreglo vacío. Ej. "RESPONSE": []

ℹ️

Url de ejemplo: https://testnucpa.digifact.com/api/GetDocument?CUFE=FE0120000155704849-2-2021-3200012022080484296177280010120008136737&RUC=155704849-2-2021&FORMAT=PDF&USERNAME=TESTUSER

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/GetDocument?CUFE=FE1120000155704849-2-2021-3200012022080484296177280010120008136737&RUC=23824-0930-212623&FORMAT=%3CFORMAT%3E&USERNAME=%3CUSERNAME%3E" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

GETGET INFO RUCInfo de RUC

Operación de tipo GET que permitirá obtener la Razón Social, Digito Verificador e información relevante sobre un RUC.

TESThttps://testnucpa.digifact.com/api/GetInfoRuc

PRODhttps://nucpa.digifact.com/api/GetInfoRuc

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
RUC	Req	RUC del contribuyente al que se desea obtener información	23824-0930-212623
TIPO	Req	Tipo del contribuyente asociado al RUC. Puede ser: 1: Natural; 2: Jurídico	2

Respuesta

Nombre	Tipo	Descripción
Ok	boolean	Atributo booleano que indica si se encuentra información en la respuesta o no. true: significa que si se encontró información asociada al RUC. false: significa que no se pudo encontrar información válida sobre el RUC.
Ruc	string	Atributo que contiene el RUC del contribuyente
Nombre	string	Atributo que contiene el nombre o razón social del contribuyente
DV	string	Digito verificador del RUC
TipoRuc	string	Tipo de RUC del contribuyente. 1: Natural; 2: Jurídico
Tipo	string	Tipo de contribuyente
Estado	string	Indica si el RUC se encuentra afiliado al SFE. A: Activo; I: Inactivo

ℹ️

Url de ejemplo: https://testnucpa.digifact.com/api/GetInfoRuc?RUC=155704849-2-2021&TIPO=2

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/GetInfoRuc?RUC=23824-0930-212623&TIPO=2" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

GETCATALOGO DE DIRECCIONESUbicaciones

Operación de tipo GET que permitirá obtener el catálogo y los códigos de las direcciones existentes en Panamá (Provincias, Distritos y Corregimientos).

TESThttps://testnucpa.digifact.com/api/Pa/Ubicaciones

PRODhttps://nucpa.digifact.com/api/Pa/Ubicaciones

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción
TIPO	Req	Tipo de operación que se desea ejecutar, las diferentes opciones son: CODIGO: obtiene la dirección específica enviando el código de ubicación. GET_PROV: obtiene el catálogo de provincias. GET_DIST: obtiene el catálogo de distritos y la provincia a la que pertenece. GET_CORREG: obtiene el catálogo de corregimientos, el distrito y la provincia donde pertenece cada uno.
PARAM	Opt	Indica los diferentes filtros o resultados que se deseen obtener para cada tipo de operación. Este parámetro es opcional dependiendo de la operación. TIPO = CODIGO: obligatorio que exista un valor en este parámetro; se debe agregar el código de la dirección con formato n-n-n. TIPO = GET_PROV: parámetro opcional; acepta <parámetro vacío>, ID\|<identificador> o NAME\|<nombre_provincia>. TIPO = GET_DIST: parámetro opcional; acepta <parámetro vacío>, NAME\|<nombre_distrito>, NAME_PROV\|<nombre_provincia> o ID_PROV\|<codigo_provincia>. TIPO = GET_CORREG: parámetro opcional; acepta <parámetro vacío>, NAME\|<nombre_corregimiento>, NAME_DIST\|<nombre_distrito>, NAME_PROV\|<nombre_provincia> o ID_PROV\|<codigo_provincia>.	2-6-9

Respuesta

Nombre	Tipo	Descripción
Codigo	int	Atributo entero que indica el codigo de la respuesta. 1: información encontrada; 0: información inexistente; 401: no autorizado
Mensaje	string	Atributo que contiene una descripción de la respuesta obtenida
Resultado	array	Arreglo del objeto { "Codigo": "", "Provincia": "", "Distrito": "", "Corregimiento": "" }. Donde: Codigo: contiene el codigo de la dirección obtenida, este puede estar completo o no, dependiendo de los datos que se deseen; Provincia: nombre de la provincia resultante; Distrito: nombre del distrito resultante; Corregimiento: nombre del corregimiento resultante. Por ejemplo, si se desea consultar información sobre las provincias, los atributos que contendrán valores son "Codigo" y "Provincia", los demás tendrán un valor de "null".

ℹ️

Ejemplo de petición: https://testnucpa.digifact.com/api/Pa/Ubicaciones?TIPO=CODIGO&PARAM=2-6-9

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/Pa/Ubicaciones?TIPO=%3CTIPO%3E&PARAM=2-6-9" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

GETSHARED_GETDTEINFO_BYBILLINGPOINTConsultar DTE por punto de facturación

Obtiene los detalles completos de un documento electrónico (factura) buscándolo por RUC, número de factura, tipo de documento, sucursal y punto de facturación.

TESThttps://testnucpa.digifact.com/api/SHAREDINFO

PRODhttps://nucpa.digifact.com/api/SHAREDINFO

Headers

Nombre	Req.	Descripción
Authorization	Req	Token de autorización generado

Query Params

Nombre	Req.	Descripción	Ejemplo
TRANSACTION	Req	Tipo de transacción	SHARED_INFO_EFACE
RUC	Req	RUC del usuario	23824-0930-212623
DATA1	Req	Tipo de procedimiento a ejecutar	SHARED_GETDTEINFO_BYBILLINGPOINT
DATA2	Req	Parámetros del procedimiento: STAXID, NUMFACT, TIPODOC, BRANCH y BILLINGPOINT separados por pipelines	STAXID\|155704849-2-2021\|NUMFACT\|9999927792\|TIPODOC\|10\|BRANCH\|0002\|BILLINGPOINT\|100
USERNAME	Req	Nombre de usuario

Respuesta

Nombre	Tipo	Descripción
REQUEST_DATA	array	Este atributo contendrá en la primera y única posición de su arreglo los siguientes atributos: { "Respuesta", "Codigo", "Procesador", "Mensaje", "Descripcion", "Fecha" }
RESPONSE	array	Contenido del documento electrónico encontrado.

ℹ️

ℹ️

Operación agregada en la versión 2.0.5 de la documentación del API.

Ejemplo de Request

curl -X GET "https://testnucpa.digifact.com/api/SHAREDINFO?TRANSACTION=SHARED_INFO_EFACE&RUC=23824-0930-212623&DATA1=SHARED_GETDTEINFO_BYBILLINGPOINT&DATA2=STAXID%7C155704849-2-2021%7CNUMFACT%7C9999927792%7CTIPODOC%7C10%7CBRANCH%7C0002%7CBILLINGPOINT%7C100&USERNAME=%3CUSERNAME%3E" \
  -H "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Ejemplo de Response

json

Soporte Técnico

Disponible en horario hábil para dudas durante implementación, pruebas y producción.

[email protected]

Teléfono

2319-1921 opción 2

Subject recomendado: [NIT] Tipo_REST · [NIT] Tipo_GENERAL

API Reference — Panamá 🇵🇦

Soporte Técnico