Saltar al contenido principal

Panamá: Método para consultar datos de un contribuyente (GetAccount)

Permite consultar los datos de un determinado contribuyente, especificando tipo y número de documento. El método responde si el documento consultado existe o no en los registros de la DGI, y en caso de existir, informa el nombre, dígito verificador y si se encuentra afiliado al SFE.

Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:

PRODUCCIÓNhttps://developers.gosocket.net/api/v1/Account/GetAccount
SANDBOXhttps://developers-sbx.gosocket.net/api/v1/Account/GetAccount

¿Cómo funciona el método GetAccount?

ANTES DE INICIAR

Es importante señalar que este método debe ser habilitado por Gosocket para poder hacer uso del mismo.

Solicita el acceso con el equipo comercial de Gosocket.

Para realizar la petición, el método tiene los siguientes parámetros con la siguiente estructura:

GetAccount (request)

ParámetroTipoDescripciónValores permitidos
AccountCode*StringID Fiscal de la empresa que realiza la consulta. Requerido para verificar que la empresa pueda hacer uso del servicio.Consultar tabla Estructura ID Fiscal
identificationType*StringTipo de documento de identificación del contribuyente a consultar:
1: Natural
2: Jurídico
1 o 2
receiverCode*StringNúmero de identificación del contribuyente a consultarConsultar tabla Estructura ID Fiscal
countryId*StringCódigo del país de la empresa que realiza la consultapa

* Todos los parámetros son requeridos


Ejemplo de petición

getaccountpa01.png

Nota

Recuerde que antes de utilizar el método, debe realizar su autenticación dentro de la pestaña Authorization.

Para este método utilizamos la pestaña Params de Postman.

  1. Seleccione el tipo de método. En este caso, se debe seleccionar GET.
  2. Ingrese la URL del método.
  3. Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
  4. Presione Send.

Ejemplos de respuesta

{
  "ErrorMessage": null,
  "IsValid": false,
  "StatusCode": "500",
  "StatusDescription": "Empresa no activa para utilizar el evento GetAccount",
  "StatusMessage": "Empresa no activa para utilizar el evento GetAccount",
  "XmlBase64Bytes": null,
  "XmlBytes": null,
  "XmlDocumentKey": null,
  "XmlFileName": null,
  "ResponseType": null,
  "OtherData": null,
  "GlobalDocumentId": "00000000-0000-0000-0000-000000000000",
  "Timestamp": null,
  "Response": null,
  "TaxDocument": null,
  "PrinterXml": null
}

Para interpretar adecuadamente esta respuesta, tome en cuenta los siguientes parámetros:

GetAccount (response)

ParámetroTipoDescripciónValores permitidos
errorMessageStringcode | description según corresponda mensajes de error retornados- null
- [ "0640 | CONTRIBUYENTE NO INSCRITO"" ]
isValidBoleanResultado de la petición:
- true cuando el cliente existe
- false cuando no existe el cliente
- True
- False
statusCodeStringCódigo de respuestaEjemplos:
- 0680
- 0640
- 500
statusDescriptionStringDescripción del códigoEjemplos:
- 0680: Contribuyente encontrado
- 0640: Contribuyente no inscrito
- 500: Empresa no activa para utilizar el evento GetAccount
- 500: El tipo de identificación debe ser 1 o 2.
StatusMessageStringDescripción de la respuesta- Código de respuesta 0 - Cliente encontrado.
- Código de respuesta 1 - Error El tipo de identificación debe ser 1 o 2
xmlBase64BytesStringXML en base 64 de la respuesta retornada por el catálogo de la SAT cuando existe el cliente.- null
- XML en base 64
xmlBytesStringnull
XmlDocumentKeyStringnull
XmlFileNameStringnull
ResponseTypeStringTipo de respuesta del servicio consultado: síncronaSync
OtherDataStringSolo en caso de que haya concluido con éxito la consulta, y el contribuyente haya sido encontrado, se retorna con los parámetros que siguen:
- Ruc
- TipoRuc
- Nombre
- DV
- AfilFE
- TipoRec
- null
- "OtherData": {
"Ruc": "155707757-2-2021",
"TipoRuc": "2",
"Nombre": "GOSOCKET PANAMA S.A.",
"DV": "50",
"AfilFE": "RUC afiliado al SFE",
"TipoRec": "Contribuyente"
}
OtherData.RucStringRuc del contribuyente consultadoValor del Ruc
OtherData.TipoRucStringTipo de contribuyente consultado- 1 : Natural
- 2: Jurídico
OtherData.NombreStringNombre del contribuyente consultadoEjemplo: “GOSOCKET PANAMA S.A.”
OtherData.DVStringDigito verificacador del contribuyente consultadoEjemplo: “50”
OtherData.AfilFEStringIndica si esta afiliado al SFEEjemplos:
- “RUC afiliado al SFE“
- “RUC no afiliado al SFE“
OtherData.TipoRecStringIndica si es contribuyenteEjemplo: “Contribuyente“
GlobalDocumentIdString00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-000000000000
TimestampStringFecha-hora de consulta2025-05-02T21:50:31.7268377Z
ResponseStringnull
TaxDocumentStringnull
PrinterXmlStringnull