MGBI proporciona una API completa para recuperar datos de registros públicos, incluida la Lista Blanca de Contribuyentes del IVA. Puede encontrar una lista de las fuentes de datos disponibles en este servicio en:
👉 API de Registros Públicos
Esta guía se aplica a la API de la Lista Blanca de Contribuyentes del IVA , que proporcionamos como parte del producto:
👉 API de la Lista Blanca de Contribuyentes del IVA
A continuación, describimos cómo puede recuperar el estado actual de una entidad de la Lista de Contribuyentes del IVA utilizando la API en función de su Número de Identificación Fiscal.
Paso 1: Obtenga una clave de autorización de API
Para obtener la clave de autorización necesaria para llamar a los endpoints disponibles en la API de MGBI, contáctenos a través del formulario de contacto en la página del producto:
👉 Lista blanca de contribuyentes del IVA de la API
Paso 2: Llamar al punto final Crear actualización
Ponemos a disposición los datos de la Lista de Contribuyentes del IVA en la API de MGBI en el modelo de datos con el identificador pl-wpv-record .
Este modelo se sincroniza bajo demanda, lo que significa que no disponemos de una copia completa de los datos del registro de origen en nuestra colección.
Para obtener datos actualizados del modelo sobre un deudor específico, primero debe crear una solicitud para recuperarlos de la Lista de contribuyentes del IVA mediante el Create Refresh .
👉 Documentación del punto final Create Refresh
Ejemplo de llamada al punto final Create Refresh con el número de identificación fiscal:
POST /v1/refresh HTTP/1.1 Host: api.mgbi.pl Authorization: [authorization key] { "query: { "model": "pl-wpv-record", "identifiers.pl_nip": [Número NIP] } }
punto final Create Refresh devuelve un diccionario en respuesta que contiene el identificador del pedido en el id .
Paso 3: Llamar al punto final Get Refresh
Las solicitudes para recuperar datos del registro de origen suelen tardar entre unos pocos y varios segundos desde el momento en que son creadas por el Create Refresh .
Para comprobar el estado actual de una solicitud, llame al Get Refresh , especificando el ID de solicitud obtenido en el paso anterior en la URL.
👉 Documentación del punto final Get Refresh
Ejemplo de cómo llamar al punto final Get Refresh con un identificador de pedido:
GET /v1/refresh/[ID de solicitud] HTTP/1.1 Host: api.mgbi.pl Autorización: [clave de autorización]
Si el campo status del diccionario devuelto tiene el valor pending, la tarea aún se está ejecutando y al punto final Get Refresh en unos segundos.
Si el campo de estado tiene el valor "éxito", significa que el pedido se ha ejecutado y que los datos relativos al deudor indicado ya se han descargado del registro de origen.
Paso 4: Invocar el punto final Obtener registros
La API del pl-wpv-record proporciona un Get Records que devuelve registros con el contenido completo de la respuesta de la Lista de Contribuyentes del IVA para el deudor especificado.
👉 Documentación del endpoint Get Records para el modelo pl-wpv-record
Para recibir datos recuperados del registro de origen en un pedido creado previamente, llame al Obtener registros pasando el ID del pedido en el refresh_id .
Ejemplo de cómo llamar al Obtener registros con un ID de pedido:
GET /v1/models/pl-wpv-record/records?refresh_id=[identificador de pedido] HTTP/1.1 Host: api.mgbi.pl Autorización: [clave de autorización]
Paso 5: Lea el estado actual del contribuyente del IVA en la respuesta
punto final Get Records devuelve una lista de registros que cumplen con los criterios especificados.
En el ejemplo anterior, el punto final debería devolver una lista de resultados que contenga un único registro:
{ "count": 1, "pages": 1, "results": [ { "id": [identificador de registro], "identifiers": [identificadores de entidad], "version": [información de versión del registro], "content": [contenido de la respuesta del motor de búsqueda], "meta": [metadatos del registro] } ] }
Todos los datos disponibles en el buscador de la Lista de Contribuyentes del IVA para la entidad indicada se pueden encontrar en el content.subject .
Ejemplo de contenido del diccionario content.subject:
{ "name": [nombre de la entidad], "nip": [número NIP], "statusVat": [estado del contribuyente del IVA], "regon": [número REGON], "krs": [número KRS], "workingAddress": [dirección de la oficina registrada], "representatives": [datos de los representantes], "authorizedClerks": [datos del apoderado], "partners": [datos de los socios], "registrationLegalDate": [fecha de registro del pagador del IVA], "accountNumbers": [lista de números de cuenta bancaria], "hasVirtualAccounts": [información sobre si el contribuyente tiene cuentas virtuales] }
Puede consultar el estado actual del contribuyente del IVA para la entidad indicada en el content.subject.statusVat .
Obtenga más información:
👉 Estructura de datos en el modelo pl-wpv-record
👉 Documentación de endpoints para el modelo pl-wpv-record
