Code Block
http://<dominio>:<puerto>

Parámetro	Descripción	Obligatorio	Ejemplo
<dominio>	Dominio API	Sí	192.168.293.365
<puerto>	Puerto API	Sí	8080

Estándar cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/estados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Header	Descripción	Obligatorio	Ejemplo
<idioma>	Idioma para las descripciones	No	es
<token>	Token de acceso	Sí	`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH`

Note
Importante: El tipo de autenticación que se utiliza en la API es JWT, y su nomenclatura es: `Bearer <token>`

...

Expand

title	Más información...

Petición

Info
`GET /filtros`

Request URL

Code Block
http://<dominio>:<puerto>/filtros

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/filtros' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/filtros

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/filtros' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EQ",
            "descripcion": "Igual que el/los valor(es)"
        },
        {
            "codigo": "BT",
            "descripcion": "Between - Resultados entre dos valores"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /empresas

...

🆕

Descripción

Devuelve un listado con las empresas disponibles.

Expand

title	Más información...

Petición

Info
`GET /empresas`

Request URL

Code Block
http://<dominio>:<puerto>/empresas'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/empresas' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/empresas'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/empresas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        { 
            "codigo": "E1",
            "descripcion": "Empresa 1",
            "codPaispais": "null", {
                  "codMonedacodigo": "nullES",
                  "CIFdescripcion": "R2788776BEspaña"
        },    },
     {       "moneda": {
    "codigo": "E2",             "descripcioncodigo": "Empresa 2EUR",
            "codPais      "descripcion": "null",Moneda de los estados miembros de EMU"
            "codMoneda": "null"},
            "CIF": "E0413308R2788776B""
        },
        {
            "codigo": "E3E2",
            "descripcion": "Empresa 32",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "E0413308"R2777776B"
        },
        {
            "codigo": "E4E3",
            "descripcion": "Empresa 43",
            "pais": {
                  "codigo": "ES",
                  "descripcion": "España"
            },
            "moneda": {
                  "codigo": "EUR",
                  "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "V04182408R2777776B"
        },
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode "codigo": 500"E4", "message "descripcion": <mensaje_error>,"Empresa 4", "datapais": null }

[GET] /estados

Descripción

Devuelve un listado con los estados disponibles.

Expand

title	Más información...

Petición

Info
`GET /estados`

Request URL

Code Block
http://<dominio>:<puerto>/estados

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/estados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/estados

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/estados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,{
                  "codigo": "ES",
                  "messagedescripcion": "PeticiónEspaña"
 finalizada correctamente",     "data": [    },
    {        "moneda": {
   "codigo": "A",               "descripcioncodigo": "Alta"EUR",
              },    "descripcion": "Moneda de los estados miembros {de EMU"
           "codigo": "B" },
            "descripcionCIF": "BajaV04182408"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

estados

Descripción

Devuelve un listado con los idiomas estados disponibles.

Expand

title	Más información...

Petición

Info
`GET /idiomas/descripcionesestados`

Request URL

Code Block
http://<dominio>:<puerto>/idiomas/descripciones'estados

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/idiomas/descripcionesestados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/idiomas/descripciones'estados

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/idiomas/descripcionesestados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": [ { "codigo": "bgA", "descripcion": "BúlgaroAlta" }, { "codigo": "enB", "descripcion": "InglésBaja" }, ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": "codigo": "es", "descripcion": "Español" }, { "codigo": "et", "descripcion": "Estonio" } ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": 500, "message": <mensaje_error>, "data": null }

[GET] /idiomas/

...

descripciones

Descripción

Devuelve un listado con las modalidades los idiomas disponibles.

Expand

title	Más información...

Petición

Info
`GET /modalidadesidiomas/descripciones`

Request URL

Code Block
http://<dominio>:<puerto>/idiomas/modalidadesdescripciones'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/modalidadesidiomas/descripciones' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/idiomas/modalidadesdescripciones'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/modalidadesidiomas/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "Abg",
            "descripcion": "Marca de la Unión EuropeaBúlgaro"
        },
        {
            "codigo": "Hen",
            "descripcion": "Marca InternacionalInglés"
        },
        {
            "codigo": "Pes",
            "descripcion": "PatenteEspañol"
        },
        {
            "codigo": "Uet",
            "descripcion": "Modelo de UtilidadEstonio"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

modalidades

Descripción

Devuelve un listado con las monedas modalidades disponibles.

Expand

title	Más información...

Petición

Info
`GET /monedasmodalidades`

Request URL

Code Block
http://<dominio>:<puerto>/monedasmodalidades'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/monedasmodalidades' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/monedasmodalidades'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/monedasmodalidades' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

language	json

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EURA",
            "descripcion": "Moneda de los estados miembros de EMUMarca de la Unión Europea"
        },
        {
            "codigo": "H",
            "descripcion": "Marca Internacional"
        },
        {
            "codigo": "GBPP",
            "descripcion": "Libra BritánicaPatente"
        },
        {
            "codigo": "USDU",
            "descripcion": "DólarModelo de AmericanoUtilidad"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

monedas 🆕

Descripción

Devuelve un listado con los países las monedas disponibles.

Expand

title	Más información...

Petición

Info
`GET /paisesmonedas`

Request URL

Code Block
http://<dominio>:<puerto>/paisesmonedas'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/paisesmonedas' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/paisesmonedas'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/paisesmonedas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

language	json

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "ALEUR",
            "descripcion": "AlbaniaMoneda de los estados miembros de EMU"
        },
        {
            "codigo": "AMGBP",
            "descripcion": "Armenia"
        },
        {
            "codigo": "AR",Libra Británica"
             "descripcion": "Argentina"
        },
        {
            "codigo": "ASUSD",
            "descripcion": "Samoa Americana (American Samoa)"
        },
        {
            "codigo": "AT",
  Dólar Americano"
         "descripcion": "Austria"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

paises

Descripción

Devuelve un listado con los tipos países disponibles para contactos.

Expand

title	Más información...

Petición

Info
`GET /tipos/contactospaises`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/contactospaises'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/contactospaises' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/tipos/contactospaises'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/contactospaises' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "AAL",
            "descripcion": "AgenteAlbania"
        },
        {
            "codigo": "BAM",
            "descripcion": "AbogadoArmenia"
        },
        {
            "codigo": "CAR",
            "descripcion": "ClienteArgentina"
        },
    ]
}    {
            "codigo": "AS",
            "descripcion": "Samoa Americana (American Samoa)"
        },
        {
            "codigo": "AT",
            "descripcion": "Austria"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /tipos/

...

contactos

Descripción

Devuelve un listado con los tipos disponibles para las descripcionescontactos.

Expand

title	Más información...

Petición

Info
`GET /tipos/descripcionescontactos`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/descripcionescontactos'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/descripcionescontactos' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/tipos/descripcionescontactos'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/descripcionescontactos' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "DTA",
            "descripcion": "DenominaciónAgente"
        },
        {
            "codigo": "DEB",
            "descripcion": "DescripciónAbogado"
        },
        {
            "codigo": "INC",
            "descripcion": "IndicaciónCliente"
        },
        {
            "codigo": "RE",
            "descripcion": "Renuncia"
        }
    ]
}

Status

colour Yellow

title

]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /tipos/

...

descripciones

Descripción

Devuelve un listado con los tipos disponibles para los domicilioslas descripciones.

Expand

title	Más información...

Petición

Info
`GET /tipos/domiciliosdescripciones`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/domiciliosdescripciones'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/domiciliosdescripciones' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/tipos/domiciliosdescripciones'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/domiciliosdescripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [

        {
            "codigo": "ADT",
            "descripcion": "Etiqueta AlternativaDenominación"
        },
        {
            "codigo": "CDE",
            "descripcion": "Solo CorrespondenciaDescripción"
        },
        {
            "codigo": "FIN",
            "descripcion": "Solo FacturaciónIndicación"
        },
        {
            "codigo": "GRE",
            "descripcion": "GenéricoRenuncia"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

Contactos

[GET] /

...

tipos/

...

domicilios

Descripción

Obtiene la información de un contacto, a partir de su identificadorDevuelve un listado con los tipos disponibles para los domicilios.

Expand

title	Más información...

Petición

Info
`GET /contactostipos/<id>`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del contacto

Sí

6450

domicilios

Request URL

Code Block
http://<dominio>:<puerto>/contactostipos/<id>domicilios'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/contactostipos/<id>domicilios' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/contactostipos/3992domicilios'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/contactostipos/3992domicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
   {      {
  "id": 1,         "codigo": "4879A",
    
   "tipo": {             "codigodescripcion": "C",
            "descripcion": "Cliente"Etiqueta Alternativa"
         },
        "referencia": "RF39438948",
        "estado": {
            "codigo": "AC",
            "descripcion": "AltaSolo Correspondencia"
        },
        "domicilios": [
   
        {
   
            "idcodigo": 442"F",
                "nombredescripcion": "JoseSolo Facturación",
        },
       "apellidos": "García",
 {
               "domiciliocodigo": "Wayna AeroG",
                "poblaciondescripcion": "ValenciaGenérico",
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "tipostatusCode": {500, "message": <mensaje_error>, "data": null }

Contactos

[GET] /contactos/{id}

Descripción

Obtiene la información de un contacto, a partir de su identificador.

Expand

title	Más información...

Petición

Info
`GET /contactos/<id>`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

Code Block
http://<dominio>:<puerto>/contactos/<id>'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/contactos/<id>' \
--header 'accept-language: <idioma>' \
  "codigo": "G",
                    "descripcion": "Genérico"
                }
            }
        ],--header 'Authorization: Bearer <token>'

Note
Importante: no olvidar headers

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/contactos/3992'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": {
         "titularesid": [1,
        "codigo": "4879",
    {    "tipo": {
            "idcodigo": 1"C",
                "nombre": null,"descripcion": "Cliente"
        },
        "apellidosreferencia": "Empresa S.A."RF39438948",
        "estado": {
            "codigo": "A",
            "descripcion": "Alta"
        },
        "domicilios": [
            {
                "id": 2442,
                "nombre": "JuanJose",
                "apellidos": "GómezGarcía",
            }    "domicilio": "Wayna Aero",
           ]     "poblacion": "Valencia",
    } }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "messagetipo": { "No se ha encontrado el contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "messagecodigo": <mensaje_error>"G", "data": null }

[POST] /contactos

Descripción

Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente

Body (request)

Expand

title	Más información...

Petición

Info
`POST /contactos`

Request URL

Code Block
http://<dominio>:<puerto>/contactos'

cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Información del contacto que queremos crear

Sí

Code Block
{ "codigo": <codigo>, "tipo": <tipo>, "estado": <estado> }

Parámetro

Descripción

Obligatorio

Tipo parámetro

Longitud máxima parámetro

Ejemplo

<codigo>

Código del contacto

Sí

Cadena de caracteres

10 caracteres

58634

<tipo>

Tipo del contacto. Consultar petición [GET] /tipos/contactos para más información

Sí

Cadena de caracteres

Único carácter

C

<estado>

Estado del contacto. Consultar petición [GET] /estados para más información

No

Cadena de caracteres

Único carácter

B

Note

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/contactos'

Ejemplo de body

Code Block
{ "codigo": "58634", "tipo": "C", "estado": "B" }

Ejemplo de cURL

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071/contactos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "codigo": "58634",
  "tipo": "C",
  "estado": "B"
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

Code Block
{ "statusCode": 400, "message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/contactos para más información", "data": null }

Status

colour	Purple
title	400

Valor no válido para el campo ‘estado’

Code Block
{ "statusCode": 400, "message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información", "data": null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": 3992 }

Status

colour	Purple
title	409

Ya existe el contacto que está intentando crear

Code Block

{
    "statusCode": 409,
    "message": "Ya existe el contacto que está intentando crear",
    "data": 3992
}                  "descripcion": "Genérico"
                }
            }
        ],
        "titulares": [
            {
                "id": 1,
                "nombre": null,
                "apellidos": "Empresa S.A."
            },
            {
                "id": 2,
                "nombre": "Juan",
                "apellidos": "Gómez"
            }        
        ]      
    }
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[POST] /contactos

...

Descripción

Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsqueda.Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente

cURL

Expand

title	Más información...

Petición

Info
`POST /contactos/search`

Petición con opciones de paginación

Info
`POST /contactos/search?PageSize=<size>&PageNumber=<number>`

Request URL

Code Block
http://<dominio>:<puerto>/contactos/search'

Request URL con opciones de paginación

cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>'

Parámetro

Descripción

Obligatorio

Ejemplo

<size>

Número de elementos por página

No

10 <number>

Número de página

No

2

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

cURL con opciones de paginación

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>' \
--' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

No

Header	Descripción	Obligatorio
<body>

Conjunto de filtros a aplicar sobre la búsqueda

Información del contacto que queremos crear

Sí

Body (request)

Code Block

{
  "domicilioscodigo": [
    {
      "campo": <campo>,
  <codigo>,
   "valorestipo": <valores><tipo>,
   
  "codigoestado": <filtro>
    }
  ],
  "titulares": [
    {
      "campo": <campo>,,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ],
  "generales": [
    {
      "campo": <campo>,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ]
}<estado>
}

Parámetro

Descripción

Obligatorio

Tipo parámetro

<campo>

Campo por el que se va a aplicar el filtro dentro del bloque al que corresponde. En este caso, sobre contactos, domicilios o titulares

Longitud máxima parámetro	Ejemplo
<codigo>	Código del contacto	Sí	Cadena de caracteres	10 caracteres

<valores>

Lista de valores

<filtro>

Tipo de filtro a aplicar

58634
<tipo>	Tipo del contacto. Consultar petición [GET] /tipos/contactos para más información	Sí

Lista de valores

Cadena de caracteres	Único carácter	C
<estado>	Estado del contacto. Consultar petición [GET] /

filtros

estados para más información

Sí

No

Cadena de caracteres

Único carácter

B

Note

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/contactos/search'

Ejemplo de request URL

con opciones de paginación

Code Block
http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2'

Ejemplo de body

Code Block
{ "domicilioscodigo": ["58634", { "campo"tipo": "apellidosC", "valoresestado": [ "García" ], "B" }

Ejemplo de cURL

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071/contactos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "codigo": "EQ58634",
    }
  ]"tipo": "C",
  "titularesestado": [
    "B"
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

Code Block

{
      "campostatusCode": "apellidos"400,
 
    "valoresmessage": ["Valor 'X' no válido para el    "S.A."
      ]campo 'tipo'. [GET]  /tipos/contactos para más información",
      "codigodata": "EQ"
    }
  ],
  "generales": [
    {
 null
}

Status

colour	Purple
title	400

Valor no válido para el campo ‘estado’

Code Block
{ "campostatusCode": "codigo"400, "valoresmessage": ["Valor 'X' no válido para el campo 'estado'. "424" ], [GET] /estados para más información", "codigodata": "EQ" },null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ { "statusCode": 200, "campomessage": "tipoPetición finalizada correctamente", "valoresdata": [ 3992 }

Status

colour	Purple
title	409

Ya existe el contacto que está intentando crear

Code Block
{ "CstatusCode": 409, "A" ]"message": "Ya existe el contacto que está intentando crear", "codigodata": "EQ" }, { "campo": "referencia"3992 }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "valoresmessage": [ "RF239348" ], <mensaje_error>, "codigodata": "EQ" } ] }

Campo

Descripción

Obligatorio

Tipo parámetro

“apellidos”

Filtro sobre el campo apellidos de titulares o domicilios (dependiendo del bloque en el que se encuentre)

No

Cadena de caracteres

“codigo”

Filtro sobre el código de contacto

No

Cadena de caracteres

“tipo”

Filtro sobre el tipo de contacto

No

Cadena de caracteres

“referencia”

Filtro sobre la referencia del contacto

No

Cadena de caracteres

Ejemplo de

null
}

[POST] /contactos/search

Descripción

Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsqueda.

{

Expand

title	Más información...

Petición

Info
`POST /contactos/search`

Petición con opciones de paginación

Info
`POST /contactos/search?PageSize=<size>&PageNumber=<number>`

Request URL

Code Block
http://<dominio>:<puerto>/contactos/search'

Request URL con opciones de paginación

Code Block
http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>'

Parámetro	Descripción	Obligatorio	Ejemplo
<size>	Número de elementos por página	No	10
<number>	Número de página	No	2

cURL

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071<dominio>:<puerto>/contactos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domicilios": [
    {
      "campo": "apellidos",
      "valores": [
        "García"
<body>'

cURL con opciones de paginación

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Conjunto de filtros a aplicar sobre la búsqueda	No

Body (request)

Code Block

{
  "domicilios": [
    {
      "campo": <campo>,
     ] "valores": <valores>,
      "codigo": "EQ"<filtro>
    }
  ],
  "titulares": [
    {
      "campo": "apellidos"<campo>,,
      "valores": [
        "S.A."
      ]<valores>,
      "codigo": "EQ"<filtro>
    }
  ],
  "generales": [
    {
      "campo": "codigo"<campo>,
      "valores": [
        "424"
      ]<valores>,
      "codigo": "EQ"<filtro>
    },
    {
      "campo": "tipo",
      "valores]
}

Parámetro	Descripción	Obligatorio	Tipo parámetro
<campo>	Campo por el que se va a aplicar el filtro dentro del bloque al que corresponde. En este caso, sobre contactos, domicilios o titulares	Sí	Cadena de caracteres
<valores>	Lista de valores	Sí	Lista de valores
<filtro>	Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información	Sí	Cadena de caracteres

Note

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json

No olvidar el token

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/contactos/search'

Ejemplo de request URL con opciones de paginación

Code Block
http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2'

Ejemplo de body

Code Block
{ "domicilios": [ { "C", "campo": "apellidos", "valores": [ "AGarcía" ], "codigo": "EQ" } ], "titulares": [ { "campo": "referenciaapellidos", "valores": [ "RF239348S.A." ], "codigo": "EQ" } ] }'

Ejemplo de cURL con opciones de paginación

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domicilios,
  "generales": [
    {
      "campo": "apellidoscodigo",
      "valores": [
        "García424"
      ],
      "codigo": "EQ"
    }
  ],
  "titulares": [     {
      "campo": "apellidostipo",
      "valores": [
        "S.A.C",
      ],  "A"
     "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "424"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "tipo",
      "valores": [
        "C",
        "A"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "RF239348"
      ],
      "codigo": "EQ"
    }
  ]
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘codigo’

Code Block
{ "statusCode": 400, "message": "Filtro 'X' no contemplado. [GET] /filtros para más información", "data": null }

Status

colour	Purple
title	400

Valor no válido para el campo ‘campo’

Code Block

Parámetro	Descripción
<total>	Número total de contactos encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Parámetro	Descripción
<total>	Número total de expedientes encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Campo	Descripción	Obligatorio	Tipo parámetro
“fecha_acto”	Filtro sobre la fecha del acto	No	Cadena de caracteres. Formato: día/mes/año
“fecha_publicacion”	Filtro sobre la fecha de publicación del acto	No	Cadena de caracteres. Formato: día/mes/año
“fecha_alta”	Filtro sobre la fecha de alta del boletín	No	Cadena de caracteres. Formato: día/mes/año
“id_boletin”	Filtro sobre el identificador del boletín	No	Cadena de caracteres

Parámetro	Descripción
<total>	Número total de actos encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<empresa>	Empresa asociada a la factura. Consultar petición [GET] /empresas para más información	Sí	Cadena de caracteres	10 caracteres	22D
<numero_factura>	Número de la factura	No	Cadena de caracteres	30 caracteres	578549
<id_contacto>	Identificador del contacto al que pertenece la factura	Sí	Numérico	-	6450
<fecha_factura>	Fecha de la factura	No	Cadena de caracteres. Formato: Fecha con/sin hora	-	30/04/2022
<fecha_contabilizacion>	Fecha de contabilización de la factura	No	Cadena de caracteres. Formato: Fecha con/sin hora	-	31/12/2022 18:00:00
<pais>	País de la factura. Consultar petición [GET] /países para más información	Sí	Cadena de caracteres	2 caracteres	ES
<moneda>	Moneda de la factura. Consultar petición [GET] /monedas para más información	Sí	Cadena de caracteres	3 caracteres	EUR
<importe_honorarios>	Importe de los honorarios	No	Numérico con decimales	Máximo 4 decimales	100.50
<importe_tasas>	Importe de las tasas	No	Numérico con decimales	Máximo 4 decimales	504.22
<observaciones>	Observaciones de la factura	No	Cadena de caracteres	-	Factura de ejemplo

“modalidad”	Filtro sobre la modalidad del expediente	No	Cadena de caracteres
“numero”	Filtro sobre el número del expediente	No	Cadena de caracteres

“bis”	Filtro sobre bis del expediente	No	Cadena de caracteres
“referencia”	Filtro sobre la referencia del expediente	No	Cadena de caracteres

Page Comparison

Versions Compared

Old Version 34

New Version Current

Key

Parámetro

Descripción

<dominio>

Dominio API

Sí

192.168.293.365

<puerto>

Puerto API

Sí

8080

Estándar cURL

Header

Descripción

<idioma>

Idioma para las descripciones

No

es

<token>

Token de acceso

Sí

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /empresas

🆕

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /estados

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

estados

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /idiomas/

descripciones

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

modalidades

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

monedas 🆕

Descripción

Petición

`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH`