Request/response protocol
1. REST service
Service authentication
1. Obtaining session token
Notification management [Notification]
Client management [Client]
User management [User]
1. Get user groups [User/GetUserGroup]
Group management [Group]
1. Listed Groups [Group/GetAllGroups]
2. Get user groups [Group/GetGroupUser]
Automation management [Automation]
1. Automation Users [Automation/users]
Master data management [MasterData]
NeosDocCoud management [NeosDocCloud]
1. Get Document [NeosDocCloud/GetNeosDocCloud]
Agent management [Agent]
1. Create Order Download [Agent/createOrderDownload]
2. Get Order Download Status [Agent/getOrderDownloadStatus]
Common objects definition
Fixed values
1. Notification status
OData Examples
1. Filter expressions

1. Request/response protocol

It is possible to connect to Neos API through REST protocol.
The methods are organized in categories. Some of them, such as the signature engine, may require a validation or a license in order to be used.

Consult with your project manager to obtain the URL and the credentials needed for a demo of the product in our ndemo environments.

1.1. REST service

REST service uses JSON notation for in and out of the service.
It is required a POST request to each operation URL with the request data.
The Auth category operations will return a session token. It will be needed on each operation and must be sent on the Authentication headline.

In order to access to each REST method it is needed to create the URL using the following example:
https://ENVIRONMENT/rest/v1/api/CATEGORY/ACTION

For instance, to do a get notification :
https://ndemo.ivnosys.net/api/rest/v1/api/notification/get

2. Service authentication

2.1. Obtaining session token

VERB : POST

URL: https://ENVIRONMENT/token
Example:https://ndemo.ivnosys.net/api/token

Obtaining a session token is done trough the Auth/Login method using the following parameters.
This token will be necessary on headers of the rest of the api calls.
This method is used to obtain a valid session or refresh exist one.

Auth/Login - Request New Sesion
Parameter	Type	Requested	Header	Description
grant_type	string	Yes		Value: password
logintype	string	Yes		Login type value: credentials
username	string	Yes		User's identifier
password	string	Yes		User's password
orgid	string	Yes		User's organization code
Content-Type	string	Yes	Yes	Value: application/x-www-form-urlencoded
Accept	string	Yes	Yes	Value: application/json

Auth/Login - Request Refresh Session
Parameter	Type	Requested	Header	Description
grant_type	string	Yes		Value: refresh_token
logintype	string	Yes		Login type value: credentials
refresh_token	string	Yes		Refresh_token obtains in call "New Session"
Content-Type	string	Yes	Yes	Value: application/x-www-form-urlencoded
Accept	string	Yes	Yes	Value: application/json

Auth/Login - Response
Parameter	Type	Description
access_token	string	Session token
token_type	string	Token type
expires_in	integer	Token duration in seconds
refresh_token	string	Sesion token to call Refresh method
rol	string	User role
.issued	string	Token issued date
.expires	string	Token expires date

Request and response example:

Request new session
Content-Type: application/x-www-form-urlencoded Accept: application/json Accept-Encoding: gzip, deflate grant_type=password&logintype=credentials&username=myUser&password=mypass&idOrg=myidorg

Request refresh session
Content-Type: application/x-www-form-urlencoded Accept: application/json Accept-Encoding: gzip, deflate grant_type=refresh_token&logintype=credentials&refresh_token=dbe18108-861f-47ff-a56a-b1e03070e2bb

JSON response
{ "token": "KrFWFozz0Mt5z+6A7vnz8VjWD9Xbt2/vROvRfJqtXjXuWBIVztI26HNL1Ko0ZAWqM8rzzXGdXN6QYWVqfcYADYA3OwIqZERoBvJdEYSuHimA=", "token_type": "bearer", "expires_in": 14399, "refresh_token": "dbe18108-861f-47ff-a56a-b1e03070e2bb", "userName": "admin", "rol": "SuperAdmin", ".issued": "Mon, 07 Oct 2019 13:39:47 GMT", ".expires": "Mon, 07 Oct 2019 17:39:47 GMT" }

In this example the token is: KrFWFozz0Mt5z+6A7vnz8VjWD9Xbt2/vROvRfJqtXjXuWBIVztI26HNL1Ko0ZAWqM8rzzXGdXN6QYWVqfcYADYA3OwIqZERoBvJdEYSuHimA=

3. Notification management [Notification]

3.1. Get notification List[Notification/Notifications]

VERB : GET

URL: https://ENVIRONMENT/rest/v1/api/Notificacion/notifications
Example: https://ndemo.ivnosys.net/api/rest/v1/api/notification/notifications

Getting a notifications list is done through the Notification/notifications method.

Notification/Get - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

This method use OData.
OData is a data access protocol for the web. It provides a uniform way to query and manipulate data sets.

Web API supports the following OData query options:

Query string parameters
Query String Parameter	Explanation
$top	Returns only the first n the results.
$skip	Skips the first n results.
$filter	Filters the results, based on a Boolean condition.
$select	Selects which properties to include in the response.
$inlinecount	Tells the server to include the total count of matching entities in the response. (Useful for server-side paging.)
$orderby	Sorts the results.

Notification/Get - Response
Parameter	Type	Description
result	PageResult of MessagePV1	Page result object

Request and response example:

Request examples:

https://ndemo.ivnosys.net/api/rest/v1/api/notification/notifications?$top=20&$skip=0&$inlinecount=allpages
https://ndemo.ivnosys.net/api/rest/v1/api/notification/notifications?$top=20&$skip=5&$inlinecount=allpages&$orderby=idservice%20desc
https://ndemo.ivnosys.net/api/rest/v1/api/notification/notifications?$top=20&$skip=5&$filter=idservice%20eq%20'SS'&$inlinecount=allpages&$orderby=idservice%20desc

FILTER EXPRESSIONS DOCUMENTATION HERE

JSON response
{ "Items": [ { "messageid": "17012680", "idservice": "Recibos Diputación Almeria", "clientid": "00000000T", "clientname": "JUAN CAMARA", "platform": "Recibos Diputación Almeria", "datesent": null, "datereceived": "2019-10-10T09:32:54.913", "dateMaxTramitacion": null, "setTateMaxTramitacion": false, "status": 0, "statusName": "Recibido pendiente de lectura", "ptf_estado": "Sin descargar", "ptf_asunto": "VOLUNTARIA: 047 - GADOR - IBI de naturaleza rustica", "dateMAxRead": null, "ptf_access_date": "2019-10-10T00:00:00", "listed": true, "emisor": "Diputación de Almería", "detail": "", "idneos": "8e22612e-88bd-4add-b378-76076b895244", "gestor": "", "tipoGestor": 0, "grupoGestor": null, "descripcionGestor": "", "statusOrderDownload": null, "tipo": 3, "descargada": false }, { "messageid": "17038184", "idservice": "Recibos Diputación Almeria", "clientid": "00000000T", "clientname": "JUAN CAMARA", "platform": "Recibos Diputación Almeria", "datesent": null, "datereceived": "2019-10-10T09:32:54.923", "dateMaxTramitacion": null, "setTateMaxTramitacion": false, "status": 0, "statusName": "Recibido pendiente de lectura", "ptf_estado": "Sin descargar", "ptf_asunto": "VOLUNTARIA: 046 - FONDON - IBI de naturaleza rustica", "dateMAxRead": null, "ptf_access_date": "2019-10-10T00:00:00", "listed": true, "emisor": "Diputación de Almería", "detail": "", "idneos": "442f2dc6-632a-428d-b5df-d82c4359c40a", "gestor": "", "tipoGestor": 0, "grupoGestor": null, "descripcionGestor": "", "statusOrderDownload": null, "tipo": 3, "descargada": false } ], "NextPageLink": null, "Count": 26450 }

JSON response

{
"Items": [
{
"messageid": "17012680",
"idservice": "Recibos Diputación Almeria",
"clientid": "00000000T",
"clientname": "JUAN CAMARA",
"platform": "Recibos Diputación Almeria",
"datesent": null,
"datereceived": "2019-10-10T09:32:54.913",
"dateMaxTramitacion": null,
"setTateMaxTramitacion": false,
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin descargar",
"ptf_asunto": "VOLUNTARIA: 047 - GADOR - IBI de naturaleza rustica",
"dateMAxRead": null,
"ptf_access_date": "2019-10-10T00:00:00",
"listed": true,
"emisor": "Diputación de Almería",
"detail": "",
"idneos": "8e22612e-88bd-4add-b378-76076b895244",
"gestor": "",
"tipoGestor": 0,
"grupoGestor": null,
"descripcionGestor": "",
"statusOrderDownload": null,
"tipo": 3,
"descargada": false
},
{
"messageid": "17038184",
"idservice": "Recibos Diputación Almeria",
"clientid": "00000000T",
"clientname": "JUAN CAMARA",
"platform": "Recibos Diputación Almeria",
"datesent": null,
"datereceived": "2019-10-10T09:32:54.923",
"dateMaxTramitacion": null,
"setTateMaxTramitacion": false,
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin descargar",
"ptf_asunto": "VOLUNTARIA: 046 - FONDON - IBI de naturaleza rustica",
"dateMAxRead": null,
"ptf_access_date": "2019-10-10T00:00:00",
"listed": true,
"emisor": "Diputación de Almería",
"detail": "",
"idneos": "442f2dc6-632a-428d-b5df-d82c4359c40a",
"gestor": "",
"tipoGestor": 0,
"grupoGestor": null,
"descripcionGestor": "",
"statusOrderDownload": null,
"tipo": 3,
"descargada": false
}
],
"NextPageLink": null,
"Count": 26450
}

3.2. Getting notification [Notification/Get]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Notificacion/get
Example: https://ndemo.ivnosys.net/api/rest/v1/api/notification/get

Getting a notification data is done through the Notification/Get method.

Notification/Get - Request
Parameter	Type	Requested	Header	Description
m	MessagepV1		No	Notification object
\m.idneos	string	Yes	No	Unique id notification
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Notification/Get - Response
Parameter	Type	Description
error	NeosError	Error object
data	MessagepV1	Notification object

Request and response example:

JSON request
{ "m": { "idneos": "71f20f02-7701-4056-a977-e7eddb60ade4", "status": 1, "pft_asunto": "Subject modify" "dateMaxtramitacion": "2019-10-07T13:27:47.435Z" } }

JSON response
{ "data": { "messageid": "0015f816-ffdd-43fb-8b2c-95c68684ac3a", "idservice": "ARTIC", "clientid": "00000000T", "clientname": "JUAN CÁMARA ESPAÑOL", "platform": "c-Office", "datesent": "2017-04-06T00:00:00", "datereceived": "2019-08-28T13:12:58.98", "dateMaxTramitacion": null, "status": 0, "statusName": "Recibido pendiente de lectura", "ptf_estado": "Sin leer", "ptf_asunto": "Subject4", "dateMAxRead": "2017-04-16T00:00:00", "ptf_access_date": null, "listed": true, "emisor": "Organismo Emisor", "detail": "Id Notificacion: 0015f816-ffdd-43fb-8b2c-95c68684ac3a Estado: Sin leer Emisor: Organismo Emisor Asunto: Subject4 Tipo:NOTIFICACION Detalle:detalle2 Fecha: 06/04/2017 Expediente: ", "idneos": "71f20f02-7701-4056-a977-e7eddb60ade4" }, "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

{
"data": {
"messageid": "0015f816-ffdd-43fb-8b2c-95c68684ac3a",
"idservice": "ARTIC",
"clientid": "00000000T",
"clientname": "JUAN CÁMARA ESPAÑOL",
"platform": "c-Office",
"datesent": "2017-04-06T00:00:00",
"datereceived": "2019-08-28T13:12:58.98",
"dateMaxTramitacion": null,
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin leer",
"ptf_asunto": "Subject4",
"dateMAxRead": "2017-04-16T00:00:00",
"ptf_access_date": null,
"listed": true,
"emisor": "Organismo Emisor",
"detail": "Id Notificacion: 0015f816-ffdd-43fb-8b2c-95c68684ac3a
Estado: Sin leer
Emisor: Organismo Emisor
Asunto: Subject4
Tipo:NOTIFICACION
Detalle:detalle2
Fecha: 06/04/2017
Expediente: ",
"idneos": "71f20f02-7701-4056-a977-e7eddb60ade4"
},
"error": {
"code": "0",
"message": "OK",
"traceid": ""
}
}

3.3. Setting notification [Notification/Set]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Notificacion/set
Example: https://ndemo.ivnosys.net/api/rest/v1/api/notification/set
Setting a notification parameters is done through the Notification/Set method.

This method is also used to modify the value of fields:
- Status.
- Subject.
- Maximum processing date.

Notification/Set - Request
Parameter	Type	Requested	Header	Description
m	MessagepV1		No	Notification object
\m.idneos	int	Yes		Notification ID
\m.status	int	No		Status id : Values
\m.pft_asunto	string	No		Notification subject
\m.dateMaxtramitacion	DateTime	No		Notification maximum processing date
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Notification/Set - Response
Parameter	Type	Description
error	NeosError	Error object
data	MessagepV1	Notification object

Request and response example:

JSON request
{ "m": { "idneos": "71f20f02-7701-4056-a977-e7eddb60ade4", "status": 1, "pft_asunto": "Subject modify" "dateMaxtramitacion": "2019-10-07T13:27:47.435Z" } }

JSON response
{ "data": { "messageid": "0065868c-7f6d-41f2-9382-7850ece73fb3", "idservice": "ARTIC", "clientid": "00000000T", "clientname": "JUAN CÁMARA ESPAÑOL", "platform": "c-Office", "datesent": "2017-03-06T00:00:00", "datereceived": "2019-08-30T09:21:34.907", "dateMaxTramitacion": null, "status": 2, "statusName": "Leida, pendiente de tramitar", "ptf_estado": "Sin leer", "ptf_asunto": "Subject3", "dateMAxRead": "2017-03-16T00:00:00", "ptf_access_date": null, "listed": false, "emisor": "Organismo Emisor", "detail": "Id Notificacion: 0065868c-7f6d-41f2-9382-7850ece73fb3 Estado: Sin leer Emisor: Organismo Emisor Asunto: Subject3 Tipo:COMUNICACION Detalle:detalle1 Fecha: 06/03/2017 Expediente: ", "idneos": "71f20f02-7701-4056-a977-e7eddb60ade4" }, "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

{
"data": {
"messageid": "0065868c-7f6d-41f2-9382-7850ece73fb3",
"idservice": "ARTIC",
"clientid": "00000000T",
"clientname": "JUAN CÁMARA ESPAÑOL",
"platform": "c-Office",
"datesent": "2017-03-06T00:00:00",
"datereceived": "2019-08-30T09:21:34.907",
"dateMaxTramitacion": null,
"status": 2,
"statusName": "Leida, pendiente de tramitar",
"ptf_estado": "Sin leer",
"ptf_asunto": "Subject3",
"dateMAxRead": "2017-03-16T00:00:00",
"ptf_access_date": null,
"listed": false,
"emisor": "Organismo Emisor",
"detail": "Id Notificacion: 0065868c-7f6d-41f2-9382-7850ece73fb3
Estado: Sin leer
Emisor: Organismo Emisor
Asunto: Subject3
Tipo:COMUNICACION
Detalle:detalle1
Fecha: 06/03/2017
Expediente: ",
"idneos": "71f20f02-7701-4056-a977-e7eddb60ade4"
},
"error": {
"code": "0",
"message": "OK",
"traceid": ""
}
}

3.4. Get notification Documents [documents/get]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Notificacion/documents/get
Example: https://ndemo.ivnosys.net/api/rest/v1/api/notification/documents/get
Setting a notification parameters is done through the Notification/documents/get method.

This method obtain the list of notification documents

Notification/Set - Request
Parameter	Type	Requested	Header	Description
m	MessagepV1		No	Notification object
\m.idneos	int	Yes		Notification ID
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Request and response example:

JSON request
{ "m": { "idneos": "d84df5a4-6f3e-455f-a1ee-4bc2e06e3a82" } }

JSON response
{ "data": [ { "documentid": "d08be4c5-913d-4280-96c0-b57afba750fc", "title": "dd5decf9-ea0c-40a6-8c54-d51a0411d0cb", "doctype": 1, "doctypedesc": "Notificación", "docname": "dd5decf9-ea0c-40a6-8c54-d51a0411d0cb.pdf" } ], "Code": "200", "Description": null }

4. Client management [Client]

4.1. Listed client [Client/clients]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Client/clients
Example: https://ndemo.ivnosys.net/api/rest/v1/api/client/clients

Getting a list of clients data is done through the Client/clients method.

Client/clients - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Client/clients - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of ClientPV1	Client list object

Request and response example:

JSON response
{ "data": [ { "clientid": "00000000T", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": null, "contactoCliente": null }, { "clientid": "00000002T", "clientname": "RUBEN", "clientSurname": "GARCIA LOPEZ", "eNotifications": true, "Notes": "Note 2", "email": "ruben@garcia.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "ruben@garcia.com", "SStIdentification": "00000002T", "SSccc": "33333333T", "ssnaf": "44444444T", "docID": "11111111T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": null, "contactoCliente": null } ], "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

{
"data": [
{
"clientid": "00000000T",
"clientname": "JUAN",
"clientSurname": "CÁMARA ESPAÑOL",
"eNotifications": true,
"Notes": "Note 1",
"email": "juancamara@camara.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "juancamara@camara.com",
"SStIdentification": "00000000T",
"SSccc": "11111111T",
"ssnaf": "22222222T",
"docID": "00000000T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente": null,
"contactoCliente": null
},
{
"clientid": "00000002T",
"clientname": "RUBEN",
"clientSurname": "GARCIA LOPEZ",
"eNotifications": true,
"Notes": "Note 2",
"email": "ruben@garcia.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "ruben@garcia.com",
"SStIdentification": "00000002T",
"SSccc": "33333333T",
"ssnaf": "44444444T",
"docID": "11111111T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente": null,
"contactoCliente": null
}
],
"error": {
"code": "0",
"message": "OK",
"traceid": ""
}
}

4.2. Gettting client [Client/get]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Client/get
Example: https://ndemo.ivnosys.net/api/rest/v1/api/client/get

Getting a client data is done through the Client/Get method.

Client/get - Request
Parameter	Type	Requested	Header	Description
m	ClientPV1		No	Client object
\m.clientid	int	Yes		Client ID
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Client/get - Response
Parameter	Type	Description
error	NeosError	Error object
data	ClientPV1	Client object

Request and response example:

JSON request
{ "m": { "clientid": "00000000T", } }

JSON response
{ "data": { "clientid": "00000000T", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }, "contactoCliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" } }, "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

{
"data":
{
"clientid": "00000000T",
"clientname": "JUAN",
"clientSurname": "CÁMARA ESPAÑOL",
"eNotifications": true,
"Notes": "Note 1",
"email": "juancamara@camara.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "juancamara@camara.com",
"SStIdentification": "00000000T",
"SSccc": "11111111T",
"ssnaf": "22222222T",
"docID": "00000000T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"direccion": "C/ Mayor 20 Pta 1",
"codPostal": 46980,
"tipoVia": "2",
"descTipoVia": "Calle",
"provincia": "46",
"descProvincia": "Valencia/Valencia",
"poblacion": "1901",
"descPoblacion": "Paterna",
"phone": "688888888",
},
"contactoCliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"docID": "00000000T",
"name": "Juan",
"surname": "Camara Español",
"phone": "666999988",
"email": "juancamara@camara.com",
"notes": "note 2"
}
},
"error": {
"code": "0",
"message": "OK",
"traceid": ""
}
}

4.3. Create client [Client/create]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Client/create
Example: https://ndemo.ivnosys.net/api/rest/v1/api/client/create

Create client is done through the Client/create method.

Client/Create - Request
Parameter	Type	Requested	Header	Description
m	ClientPV1		No	Client object
\m.clientid	int	Yes		Client ID
\m.clientName	string	No		Client Name
\m.clientSurname	string	No		Client Surname
\m.eNotifications	bool	No		Client allow check notifications on bulletin boards flag
\m.Notes	string	No		Client notes
\m.email	string	No		Client email
\m.SStIdentification	string	No		Client SS Identification
\m.SSccc	string	No		Client CCC Identification
\m.ssnaf	string	No		Client NAF Identification
\m.docID	string	No		Client DOC id
\m.direccioncliente	DirectionPV1	No		Client address
\m.contactoCliente	ClientContactPV1	No		Client contact
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Client/create - Response
Parameter	Type	Description
error	NeosError	Error object
data	ClientPV1	Client object

Request and response example:

JSON request
{ "m": { "clientid": "clientid", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }, "contactoCliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" } }

JSON request

{
"m": {
"clientid": "clientid",
"clientname": "JUAN",
"clientSurname": "CÁMARA ESPAÑOL",
"eNotifications": true,
"Notes": "Note 1",
"email": "juancamara@camara.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "juancamara@camara.com",
"SStIdentification": "00000000T",
"SSccc": "11111111T",
"ssnaf": "22222222T",
"docID": "00000000T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"direccion": "C/ Mayor 20 Pta 1",
"codPostal": 46980,
"tipoVia": "2",
"descTipoVia": "Calle",
"provincia": "46",
"descProvincia": "Valencia/Valencia",
"poblacion": "1901",
"descPoblacion": "Paterna",
"phone": "688888888",
},
"contactoCliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"docID": "00000000T",
"name": "Juan",
"surname": "Camara Español",
"phone": "666999988",
"email": "juancamara@camara.com",
"notes": "note 2"
}
}

JSON response
{ "data": { "clientid": "clientid", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }, "contactoCliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" } }, "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

{
"data":
{
"clientid": "clientid",
"clientname": "JUAN",
"clientSurname": "CÁMARA ESPAÑOL",
"eNotifications": true,
"Notes": "Note 1",
"email": "juancamara@camara.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "juancamara@camara.com",
"SStIdentification": "00000000T",
"SSccc": "11111111T",
"ssnaf": "22222222T",
"docID": "00000000T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"direccion": "C/ Mayor 20 Pta 1",
"codPostal": 46980,
"tipoVia": "2",
"descTipoVia": "Calle",
"provincia": "46",
"descProvincia": "Valencia/Valencia",
"poblacion": "1901",
"descPoblacion": "Paterna",
"phone": "688888888",
},
"contactoCliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"docID": "00000000T",
"name": "Juan",
"surname": "Camara Español",
"phone": "666999988",
"email": "juancamara@camara.com",
"notes": "note 2"
}
},
"error": {
"code": "0",
"message": "OK",
"traceid": ""
}
}

4.4. Setting client [Client/set]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Client/set
Example: https://ndemo.ivnosys.net/api/rest/v1/api/client/set
Setting a client parameters is done through the Client/Set method.

This method is also used to modify the value of fields:
- Client Name.
- Client Surname.
- Client allow check notifications on bulletin boards.
- Client notes
- Client email
- SS Identification
- CCC Identification
- NAF Identification
- Client DOC id
- Client direction
- Client contact

Client/Set - Request
Parameter	Type	Requested	Header	Description
m	ClientPV1		No	Client object
\m.clientid	int	Yes		Client ID
\m.clientName	string	No		Client Name
\m.clientSurname	string	No		Client Surname
\m.eNotifications	bool	No		Client allow check notifications on bulletin boards flag
\m.Notes	string	No		Client notes
\m.email	string	No		Client email
\m.SStIdentification	string	No		Client SS Identification
\m.SSccc	string	No		Client CCC Identification
\m.ssnaf	string	No		Client NAF Identification
\m.docID	string	No		Client DOC id
\m.direccioncliente	DirectionPV1	No		Client address
\m.contactoCliente	ClientContactPV1	No		Client contact
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Client/set - Response
Parameter	Type	Description
error	NeosError	Error object
data	ClientPV1	Client object

Request and response example:

JSON request
{ "m": { "clientid": "clientid", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }, "contactoCliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" } }

JSON request

JSON response
{ "data": { "clientid": "clientid", "clientname": "JUAN", "clientSurname": "CÁMARA ESPAÑOL", "eNotifications": true, "Notes": "Note 1", "email": "juancamara@camara.com", "autoGest": true, "autoGestIdLic": 1, "AutoGestEmailReceiv": "juancamara@camara.com", "SStIdentification": "00000000T", "SSccc": "11111111T", "ssnaf": "22222222T", "docID": "00000000T", "nnotif": 120, "nnotifteu": 60, "direccioncliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }, "contactoCliente": { "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" } }, "error": { "code": "0", "message": "OK", "traceid": "" } }

JSON response

4.5. Delete client [Client/delete]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Client/delete
Example: https://ndemo.ivnosys.net/api/rest/v1/api/client/delete

Delete client is done through the Client/delete method.

Client/delete - Request
Parameter	Type	Requested	Header	Description
m	ClientPV1		No	Client object
\m.clientid	int	Yes		Client ID
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Client/delete - Response
Parameter	Type	Description
error	NeosError	Error object
data	int	Result of operation : 1 OK - 1 Error\|

JSON request
{ "m": { "clientid": "00000000T", } }

JSON response
{ "data": 1 , "error": { "code": "0", "message": "OK", "traceid": "" } }

5. User management [User]

5.1. Get user groups [User/GetUserGroup]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/User/GetUserGroup
Example: https://ndemo.ivnosys.net/api/rest/v1/api/User/GetUserGroup

Getting a list of groups asigned to user method.

User/GetUserGroup - Request
Parameter	Type	Requested	Header	Description
m	UserReqPV1		No	User request object
\m.iduser	int	Yes		User ID
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

User/GetUserGroup - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of GroupPV1	Group list object

Request and response example:

JSON request
{ "m": { "idUser": "Admin" } }

JSON response
{ "data": [ { "idgroup": 1322, "Nombre": "General", "NUsuarios": 0, "NClientes": 0, "recAccessPermission": null, "error": null } ], "Code": "200", "Description": null }

6. Group management [Group]

6.1. Listed Groups [Group/GetAllGroups]

VERB : GET

URL: https://ENVIRONMENT/rest/v1/api/Group/GetAllGroups
Example: https://ndemo.ivnosys.net/api/rest/v1/api/Group/GetAllGroups

Getting a list of groups .

Group/GetAllGroups - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

This method use OData.
OData is a data access protocol for the web. It provides a uniform way to query and manipulate data sets.

Web API supports the following OData query options:

Query string parameters
Query String Parameter	Explanation
$top	Returns only the first n the results.
$skip	Skips the first n results.
$filter	Filters the results, based on a Boolean condition.
$select	Selects which properties to include in the response.
$inlinecount	Tells the server to include the total count of matching entities in the response. (Useful for server-side paging.)
$orderby	Sorts the results.

Notification/Get - Response
Parameter	Type	Description
result	PageResult of GroupPV1	Page result object

Request and response example:

Request examples:

FILTER EXPRESSIONS DOCUMENTATION HERE

JSON response
{ "Items": [ { "idgroup": 1322, "Nombre": "General", "NUsuarios": 1, "NClientes": 3 }, { "idgroup": 1323, "Nombre": "Prueba", "NUsuarios": 1, "NClientes": 3 } ] "NextPageLink": null, "Count": null }

6.2. Get user groups [Group/GetGroupUser]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Group/GetGroupUser
Example: https://ndemo.ivnosys.net/api/rest/v1/api/Group/GetGroupUser

Getting a list of user asigned to group method.

Group/GetGroupUser - Request
Parameter	Type	Requested	Header	Description
m	GroupPV1		No	Group request object
\m.idgroup	int	Yes		group ID
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Group/GetGroupUser - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of UserPV1	User list object

Request and response example:

JSON request
{ "m": { "idgroup": 1233 } }

JSON response
{ "data": [ { "iduser": "Admin", "nombreApellidos": "Cristian Tavira ", "nombre": null, "apellidos": null, "password": null, "idpProfile": null, "descriptionProfile": null, "email": null, "observaciones": null, "lastLoginWeb": null, "lastLoginDesktop": null, "error": null, "isFirstLogin": null, "domainSID": null } ], "Code": "200", "Description": null }

7. Automation management [Automation]

7.1. Automation Users [Automation/users]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Automation/Users
Example: https://ndemo.ivnosys.net/api/rest/v1/api/Automation/Users

Recieve the file to automation on batch import users

Client/set - Response
Parameter	Type	Description
error	NeosError	Error object
data	AutomationUserPV1	AutomationUser object

Request and response example:

JSON request
{ "m": { "base64string": "77u/aWRVc2VyO25vbWJyZTthcGVsbGlkb3M7ZW1haWw7Y29udHJhc2XDsWE7aWRQZXJmaWw7YWNjaW9uO1NOIGNlcnRpZmljYWRvO2NpZiBjbGllbnRlO29yZ2FuaXNtbztyZXN1bHRhZG8NCmN0YXZpcmE7Y3Jpc3RpYW4gO3RhdmlyYTthQGEuY29tO0FiYzEyMzsxO0E7MTIyNDU2OzQ4NDA2MDEyTTtQQUc7DQpjdGF2aXJhO2NyaXN0aWFuIDt0YXZpcmE7YUBhLmNvbTtBYmMxMjM7MTtBOzEyMjQ1Njs0ODQwNjAxMk0NCg==" } }

JSON response
{ "data": { "base64string": "77u/aWRVc2VyO25vbWJyZTthcGVsbGlkb3M7ZW1haWw7Y29udHJhc2XDsWE7aWRQZXJmaWw7YWNjaW9uO1NOIGNlcnRpZmljYWRvO2NpZiBjbGllbnRlO29yZ2FuaXNtbztyZXN1bHRhZG8NCmN0YXZpcmE7Y3Jpc3RpYW4gO3RhdmlyYTthQGEuY29tO0FiYzEyMzsxO0E7MTIyNDU2OzQ4NDA2MDEyTTtQQUc7DQpjdGF2aXJhO2NyaXN0aWFuIDt0YXZpcmE7YUBhLmNvbTtBYmMxMjM7MTtBOzEyMjQ1Njs0ODQwNjAxMk0NCg==" }, "Code": null, "Description": null }

8. Master data management [MasterData]

8.1. Listed Addresses [MasterData/getAddresses]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/MasterData/getAddresses
Example: https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getAddresses

Getting a list of address type is done through the MasterData/getAddresses method.

MasterData/getAddresses - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

MasterData/getAddresses - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of AddressTypePV1	Address Type list object

Request and response example:

JSON response
{ "data": [ { "codigo": "1", "nombre": "Alameda" }, { "codigo": "2", "nombre": "Calle" }, ], "error": { "code": "0", "message": "OK", "traceid": "" } }

8.2. Listed Provinces [MasterData/getProvincias]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/MasterData/getProvincias
Example: https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getProvincias

Getting a list of provinces is done through the MasterData/getProvincias method.

MasterData/getProvincias - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

MasterData/getProvincias - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of ProvinciaPV1	Pronvince list object

Request and response example:

JSON response
{ "data": [ { "codigo": "46", "nombre": "Valencia" }, { "codigo": "47", "nombre": "Valladolid" }, ], "error": { "code": "0", "message": "OK", "traceid": "" } }

8.3. Listed Towns [MasterData/getPoblaciones]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/MasterData/getPoblaciones
Example: https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getPoblaciones

Getting a list of towns is done through the MasterData/getPoblaciones method.

MasterData/getPoblaciones- Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

MasterData/getPoblaciones - Response
Parameter	Type	Description
error	NeosError	Error object
data	List of PoblacionPV1	Town list object

Request and response example:

JSON response
{ "data": [ { "codigoProvincia": "01", "nombre": "Alegría-Dulantzi", "codigo": "0014" }, { "codigoProvincia": "01", "nombre": "Amurrio", "codigo": "0029" } ], "error": { "code": "0", "message": "OK", "traceid": "" } }

8.4. Listed Available services [MasterData/getAvailableServices]

VERB : GET

URL: https://ENVIRONMENT/rest/v1/api/MasterData/getAvailableServices
Example: https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getAvailableServices

Getting a list of available services.

MasterData/getAvailableServices - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

This method use OData.
OData is a data access protocol for the web. It provides a uniform way to query and manipulate data sets.

Web API supports the following OData query options:

Query string parameters
Query String Parameter	Explanation
$top	Returns only the first n the results.
$skip	Skips the first n results.
$filter	Filters the results, based on a Boolean condition.
$select	Selects which properties to include in the response.
$inlinecount	Tells the server to include the total count of matching entities in the response. (Useful for server-side paging.)
$orderby	Sorts the results.

Notification/Get - Response
Parameter	Type	Description
result	PageResult of EntePv1	Page result object

Request and response example:

Request examples:

https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getAvailableServices?$top=20&$skip=0&$inlinecount=allpages
https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getAvailableServices?$top=20&$skip=5&$inlinecount=allpages&$orderby=idEnte%20desc
https://ndemo.ivnosys.net/api/rest/v1/api/MasterData/getAvailableServices?$top=20&$skip=5&$filter=idEnte%20eq%20'3'&$inlinecount=allpages&$orderby=idEnte%20desc

FILTER EXPRESSIONS DOCUMENTATION HERE

JSON response

{
"Items": [
{
"idEnte": 3,
"nombre": "112 Cantabria, S.A.U.",
"dir3": null,
"codigoPôstal": null
},
{
"idEnte": 4,
"nombre": "1908 Puerto de Motril AIE (Motrilport)",
"dir3": null,
"codigoPôstal": null
},
{
"idEnte": 5,
"nombre": "A. de Acreditación-FGUPM-UPC-de Proy.de Inv.Desar.e Innov.Tecn. S.L",
"dir3": null,
"codigoPôstal": null
},
{
"idEnte": 7,
"nombre": "A.I.E. Gest. Integ. Sanit. i Assist. (GISA)",
"dir3": null,
"codigoPôstal": null
},
"NextPageLink": "https://ndemo.ivnosys.net:443/api/rest/v1/api/MasterData/getAvailableServices?$skip=2000",
"Count": null
}

9. NeosDocCoud management [NeosDocCloud]

9.1. Get Document [NeosDocCloud/GetNeosDocCloud]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/NeosDocCloud/GetNeosDocCloud
Example: https://ndemo.ivnosys.net/api/rest/v1/api/NeosDocCloud/GetNeosDocCloud

Getting a document is done through the NeosDocCloud/GetNeosDocCloud method.

Notification/Get - Request
Parameter	Type	Requested	Header	Description
m	NeosDocV1		No	NeosDocCloud object
\m.idDoc	string	Yes	No	Unique id Document
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Notification/Get - Response
Parameter	Type	Description
error	NeosError	Error object
data	NeosDocV1	Notification object

Request and response example:

JSON request
{ "m": { "idDoc": "0353376f-f76f-45b7-a355-36cb0983408c" } }

JSON response
{ "data": { "idDoc": null, "base64string": "bOHgksCOy/IGXvTJyRIcP071fZLIRxlvezOxR8NDl5qlXalwVU/R1oiJuDD4CCH/A8O3W4oNCm", "idNeos": null }, "error": { "code": "0", "message": "OK", "traceid": "" } }

10. Agent management [Agent]

10.1. Create Order Download [Agent/createOrderDownload]

VERB : POST

URL: https://ENVIRONMENT/rest/v1/api/Agent/createOrderDownload
Example: https://ndemo.ivnosys.net/api/rest/v1/api/Agent/createOrderDownload

Creare order download notification is done through the Agent/createOrderDownload method.

Notification/Get - Request
Parameter	Type	Requested	Header	Description
m	[[#createorderdownreq _object\|NeosDocV1]]		No	CreateOrderDownReq object
\m.messageId	string	Yes	No	Notification ID
\m.executionFromDate	DateTime?	Yes	No	Date from which the execution order can be executed
\m.retry	bool	Yes	No	Indicates if the download order will have retries if it fails
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Notification/Get - Response
Parameter	Type	Description
error	NeosError	Error object
data	long	OrderDowload Id

Request and response example:

JSON request
{ "m": { "messageId": "1g648fg5118848dfg18", "executionFromDate": "2020-05-20T11:53:20.250Z", "retry": true } }

JSON response
{ "data": 1550, "error": { "code": "0", "message": "OK", "traceid": "" } }

10.2. Get Order Download Status [Agent/getOrderDownloadStatus]

VERB : GET

URL: https://ENVIRONMENT/rest/v1/api/Agent/getOrderDownloadStatus
Example: https://ndemo.ivnosys.net/api/rest/v1/api/Agent/getOrderDownloadStatus?id=2

Gets order download notification status is done through the Agent/getOrderDownloadStatus method.

P (Pending) I (IN PROGRESS) F (FINALIZED

Notification/Get - Request
Parameter	Type	Requested	Header	Description
Authorization	string	Yes	Yes	Value "Bearer " + The authorization token obtains in Auth/Login

Query string parameters
Query String Parameter	Explanation
id	Order Download ID

Notification/Get - Response
Parameter	Type	Description
error	NeosError	Error object
data	AgnDownQueueP	AgnDownQueueP object

Request and response example:

Request examples:

https://ndemo.ivnosys.net/api/rest/v1/api/Agent/getOrderDownloadStatus?id=2

JSON response
{ "data": { "idDownOrder": 2, "status": "F", "downOk": true, "reasonError": null, "messageId": "0a575c75-dcde-49e8-87e7-0633f3a77389", "idService": "ARTIC" }, "Code": "200", "Description": null }

11. Common objects definition

Common object definitions are listed below.

11.1. NeosError object

The NeosError object holds all the information relative to an error that may happens during a call to Neos Api.
It comes in every keyman response. The code 0 means there was no error during the call.

NeosError
Parameter	Type	Description
code	string	Error code
message	string	Error description
traceid	string	Operation trace ID

JSON Example
{ "code": "0", "message": "OK", "traceid":"7DC44PFZOEPUQ" }

11.2. MessagePV1 object

The MessagePV1 object holds all the information relative to a Notification.

MessagePV1
Parameter	Type	Description
messageid	string	Notification id
idservice	string	Notification issuing platform code
clientid	string	Notification receiver code
clientname	string	Notification receiver name
platform	string	Notification issuing platform description
datesent	DateTime	Notification making available date
datereceived	DateTime	Notification received date in Neos Applicaction
dateMaxTramitacion	DateTime	Notification maximum processing date
status	int	Notification status code on Neos Applicacion
statusName	string	Notification status name on Neos Applicacion\|
ptf_estado	string	Notification status name on issuing platform
ptf_asunto	string	Notification subject
dateMAxRead	DateTime	Notification maximum read date
ptf_access_date	DateTime	Notification access date on issuing platform
listed	bool	Notification listed flag
emisor	string	Notification Agency issuing
detail	string	Notification extra info\|
idneos	string	Notification unique id neos

JSON Example

{
"messageid": "0015f816-ffdd-43fb-8b2c-95c68684ac3a",
"idservice": "ARTIC",
"clientid": "00000000T",
"clientname": "JUAN CÁMARA ESPAÑOL",
"platform": "c-Office",
"datesent": "2017-04-06T00:00:00",
"datereceived": "2019-08-28T13:12:58.98",
"dateMaxTramitacion": "2017-04-16T00:00:00",
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin leer",
"ptf_asunto": "Subject 1",
"dateMAxRead": "2017-04-16T00:00:00",
"ptf_access_date": "2017-04-16T00:00:00",
"listed": true,
"emisor": "Organismo Emisor",
"detail": "Id Notificacion: 0015f816-ffdd-43fb-8b2c-95c68684ac3a
Estado: Sin leer
Emisor: Organismo Emisor
Asunto: Subject4
Tipo:NOTIFICACION
Detalle:detalle2
Fecha: 06/04/2017
Expediente: ",
"idneos": "71f20f02-7701-4056-a977-e7eddb60ade4"
}

11.3. MessageDocPV1 object

The MessageDocPV1 object holds all the information relative to a Notification Document.

MessageDocPV1
Parameter	Type	Description
documentid	string	Notification id
title	string	Tittle Document
doctype	int	Doc Type Id
doctypedesc	string	Doc Type Description
docname	string	Doc name


JSON Example`{ "documentid": "d08be4c5-913d-4280-96c0-b57afba750fc", "title": "dd5decf9-ea0c-40a6-8c54-d51a0411d0cb", "doctype": 1, "doctypedesc": "Notificación", "docname": "Pruebas.pdf" }`

11.4. ClientPV1 object

The ClientPV1 object holds all the information relative to a Client.

ClientPV1
Parameter	Type	Description
clientId	string	Client id
clientName	string	Client Name
clientSurname	string	Client Surname
eNotifications	bool	Client allow check notifications on bulletin boards flag
Notes	string	Client notes
email	string	Client email
autoGest	bool	Indicates that the client manages its own notifications.
autoGestIdLic	int	AutoGest Access license
AutoGestEmailReceiv	int	AutoGest Notification email
SStIdentification	string	Client SS Identification
SSccc	string	Client CCC Identification
ssnaf	string	Client NAF Identification
docID	string	Client DOC id
nnotif	int	Number of notifs
nnotifteu	int	Number of TEU notifs
\m.direccioncliente	DirectionPV1	No
\m.contactoCliente	ClientContactPV1	No

JSON Example

{
"clientid": "00000000T",
"clientname": "JUAN",
"clientSurname": "CÁMARA ESPAÑOL",
"eNotifications": true,
"Notes": "Note 1",
"email": "juancamara@camara.com",
"autoGest": true,
"autoGestIdLic": 1,
"AutoGestEmailReceiv": "juancamara@camara.com",
"SStIdentification": "00000000T",
"SSccc": "11111111T",
"ssnaf": "22222222T",
"docID": "00000000T",
"nnotif": 120,
"nnotifteu": 60,
"direccioncliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"direccion": "C/ Mayor 20 Pta 1",
"codPostal": 46980,
"tipoVia": "2",
"descTipoVia": "Calle",
"provincia": "46",
"descProvincia": "Valencia/Valencia",
"poblacion": "1901",
"descPoblacion": "Paterna",
"phone": "688888888",
},
"contactoCliente":
{
"id": 1,
"clientid": "00000000T",
"usertoken": "TEST-IVNOSYS",
"docID": "00000000T",
"name": "Juan",
"surname": "Camara Español",
"phone": "666999988",
"email": "juancamara@camara.com",
"notes": "note 2"
}
}

11.5. DirectionPV1 object

The DirectionPV1 object holds all the information relative to a Address Client.

DirectionPV1
Parameter	Type	Description
id	int	id
clientId	string	Client Name
usertoken	string	License usertoken
direccion	string	Address
codPostal	string	Postal code
tipoVia	string	Type of address id
descTipoVia	string	Description of type address
provincia	string	Province id
descProvincia	string	Province description
poblacion	string	Town id
descPoblacion	string	Town description
phone	string	Phone number

JSON Example
{ "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "direccion": "C/ Mayor 20 Pta 1", "codPostal": 46980, "tipoVia": "2", "descTipoVia": "Calle", "provincia": "46", "descProvincia": "Valencia/Valencia", "poblacion": "1901", "descPoblacion": "Paterna", "phone": "688888888", }

11.6. AddressTypePV1 object

The AddressTypePV1 object holds all the information relative to a Type of address.

AddressTypePV1
Parameter	Type	Description
codigo	string	Code
nombre	string	Description

JSON Example
{ "codigo": "2", "nombre": "Calle", }

11.7. ProvinciaPV1 object

The ProvinciaPV1 object holds all the information relative to a Provinces.

ProvinciaPV1
Parameter	Type	Description
codigo	string	Code
nombre	string	Description

JSON Example
{ "codigo": "46", "nombre": "Valencia", }

11.8. PoblacionPV1 object

The PoblacionPV1 object holds all the information relative to a Towns.

PoblacionPV1
Parameter	Type	Description
codigoProvincia	string	Province code
codigo	string	Code
nombre	string	Description

JSON Example
{ "codigoProvincia": "46", "codigo": "1901", "nombre": "Calle", }

11.9. ClientContactPV1 object

The ClientContactPV1 object holds all the information relative to a Client Contact.

ClientContactPV1
Parameter	Type	Description
id	int	id
clientId	string	Client id
usertoken	string	License usertoken
docID	string	Doc ID
name	string	Contact name
surname	string	Contact surname\|
phone	string	Contact phone
email	string	Contact email
notes	string	Contact Notes

JSON Example
{ "id": 1, "clientid": "00000000T", "usertoken": "TEST-IVNOSYS", "docID": "00000000T", "name": "Juan", "surname": "Camara Español", "phone": "666999988", "email": "juancamara@camara.com", "notes": "note 2" }

11.10. NeosDocV1 object

The NeosDocV1 object holds the information relative to a Notificacion Document in base64string propertie.

NeosDocV1
Parameter	Type	Description
idDoc	string	id
base64string	string	Base64 array
idNeos	string	IdNeos

JSON Example
{ "idDoc": "0353376f-f76f-45b7-a355-36cb0983408c", "base64string": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAw", "idNeos": "07261516-1c82-4434-813c-8dd98a8732ed" }

11.11. CreateOrderDownReq object

The CreateOrderDownReq object holds the information who needs to create a order donwnload

CreateOrderDownReq
Parameter	Type	Description
messageId	string	Notification ID
executionFromDate	DateTime?	Date from which the execution order can be executed
retry	bool	Indicates if the download order will have retries if it fails

JSON Example
{ "messageId": "1g648fg5118848dfg18", "executionFromDate": "2020-05-20T11:53:20.250Z", "retry": true }

11.12. AgnDownQueueP object

The AgnDownQueueP object holds the information relative to a order download

AgnDownQueueP
Parameter	Type	Description
idDownOrder	string	Order download ID
status	string	Order download status P (Pending) I (IN PROGRESS) F (FINALIZED)
downOk	bool	Indicates if the download was successful
reasonError	bool	If an error has occurred, show the reason
messageId	bool	Notification Id\|
idService	bool	Notification issuing platform code

JSON Example
{ "data": { "idDownOrder": 2, "status": "F", "downOk": true, "reasonError": null, "messageId": "0a575c75-dcde-49e8-87e7-0633f3a77389", "idService": "ARTIC" }, "Code": "200", "Description": null }

11.13. GroupPV1 object

The GroupPV1 object holds the information relative to group

GroupPV1
Parameter	Type	Description
idgroup	string	Group ID
Nombre	string	Group name
NUsuarios	int	Number of users
NClientes	bool	Number of clients

JSON Example
{ "data": { "idDownOrder": 2, "status": "F", "downOk": true, "reasonError": null, "messageId": "0a575c75-dcde-49e8-87e7-0633f3a77389", "idService": "ARTIC" }, "Code": "200", "Description": null }

11.14. UserPV1 object

The UserPV1 object holds the information relative to User

UserPV1
Parameter	Type	Description
iduser	string	User ID
nombreApellidos	string	USer name and usermame\|
email	string	User email

JSON Example
{ "data": { "iduser": "Admin", "nombreApellidos": "Cristian Tavira ", "email": null, }, "Code": "200", "Description": null }

11.15. AutomationUserPV1 object

The AutomationUserPV1 object holds the information relative to a order download

AutomationUserPV1
Parameter	Type	Description
base64string	string	Base64 string file

JSON Example
{ "data": { "base64string":"77u/aWRVc2VyO25vbWJyZTthcGVsbGlkb3M7ZW1haWw7Y29udHJhc2XDsWE7aWRQZXJmaWw7YWNjaW9uO1NOIGNlcnRpZmljYWRvO2NpZiBjbGllbnRlO29yZ2FuaXNtbztyZXN1bHRhZG8NCmN0YXZpcmE7Y3Jpc3RpYW4gO3RhdmlyYTthQGEuY29tO0FiYzEyMzsxO0E7MTIyNDU2OzQ4NDA2MDEyTTtQQUc7DQpjdGF2aXJhO2NyaXN0aWFuIDt0YXZpcmE7YUBhLmNvbTtBYmMxMjM7MTtBOzEyMjQ1Njs0ODQwNjAxMk0NCg==" } }

11.16. PageResult object

Represents a feed of entities that includes additional information that OData formats support.

PageResult
Parameter	Type	Description
Count	long	Gets the total count of items in the feed.
Items	IEnumerable	Gets the collection of entities for this feed.
NextPageLing	Uri	Gets the link for the next page of items in the feed.

JSON Example

{
"Items": [
{
"messageid": "17179974",
"idservice": "Recibos Diputación Almeria",
"clientid": "00000000T",
"clientname": "JUAN CAMARA",
"platform": "Recibos Diputación Almeria",
"datesent": null,
"datereceived": "2019-10-10T09:32:54.523",
"dateMaxTramitacion": null,
"setTateMaxTramitacion": false,
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin descargar",
"ptf_asunto": "VOLUNTARIA: 101 - VIATOR - IBI de naturaleza urbana",
"dateMAxRead": null,
"ptf_access_date": "2019-10-10T00:00:00",
"listed": true,
"emisor": "Diputación de Almería",
"detail": "",
"idneos": "7ac4f82d-5c4b-49cf-93aa-4aec560c36d6",
"gestor": "",
"tipoGestor": 0,
"grupoGestor": null,
"descripcionGestor": "",
"statusOrderDownload": null,
"tipo": 3,
"descargada": false
},
{
"messageid": "17181875",
"idservice": "Recibos Diputación Almeria",
"clientid": "00000000T",
"clientname": "JUAN CAMARA",
"platform": "Recibos Diputación Almeria",
"datesent": null,
"datereceived": "2019-10-10T09:32:54.867",
"dateMaxTramitacion": null,
"setTateMaxTramitacion": false,
"status": 0,
"statusName": "Recibido pendiente de lectura",
"ptf_estado": "Sin descargar",
"ptf_asunto": "VOLUNTARIA: 101 - VIATOR - IBI de naturaleza rustica",
"dateMAxRead": null,
"ptf_access_date": "2019-10-10T00:00:00",
"listed": true,
"emisor": "Diputación de Almería",
"detail": "",
"idneos": "5e0dfb21-e871-4e4f-802c-8eaca94d8ddf",
"gestor": "",
"tipoGestor": 0,
"grupoGestor": null,
"descripcionGestor": "",
"statusOrderDownload": null,
"tipo": 3,
"descargada": false
}
],
"NextPageLink": null,
"Count": 26450
}

12. Fixed values

Fixed values definitions are listed below.

12.1. Notification status

Status values
Id	Description
0	Rreceived, pending reading
1	Read, pending processing
2	In process
3	Closed

13. OData Examples

13.1. Filter expressions

Filter expressions
Filter Operation	Example	Explanation
Equal	filter=ActionCount+eq+10	Query to find registries with ActionCount that equals 10.
Select a range of values	filter=Entry_No gt 610 and Entry_No lt 615	Query on service. Returns entry numbers 611 through 614.
And	filter=Country_Region_Code eq 'ES' and Payment_Terms_Code eq '14 DAYS'	Query on "customer" service. Returns customers in Spain where Payment_Terms_Code=14 DAYS.
Or	filter= Country_Region_Code eq 'ES' or Country_Region_Code eq 'US'	You can use OR operators to apply different filters on the same field. However, you cannot use OR operators to apply filters on two different fields.
Less than	filter=Entry_No lt 610	Returns entry numbers that are less than 610.
Greater than	filter= Entry_No gt 610	Returns entry numbers that are less than 610.
Greater than or equal to	filter=Entry_No ge 610	Returns entry numbers 610 and higher.
Less than or equal to	filter=Entry_No le 610	Returns entry numbers up to and including 610.
Different from (not equal)	filter=VAT_Bus_Posting_Group ne 'EXPORT'	Returns all customers with VAT_Bus_Posting_Group not equal to EXPORT.
endswith	filter=endswith(VAT_Bus_Posting_Group,'RT')	Returns all customers with VAT_Bus_Posting_Group values that end in RT.
startswith	filter=startswith(Name, 'S')	Query on Customer service. Returns all customers names beginning with “S”
substringof	filter=substringof(Name, ‘urn’)	Returns customer records for customers with names containing the string “urn”.
length	filter=length(Name) gt 20	Returns customer records for customers with names longer than 20 characters.
indexof	filter=indexof(Location_Code, ‘BLUE’) eq 0	Returns customer records for customers having a location code beginning with the string BLUE.
substring	filter=substring(Location_Code, 5) eq 'RED'	Returns true for customers with the string RED in their location code starting as position 5.

Neos services technical documentation / API V1

1. Request/response protocol

1.1. REST service

2. Service authentication

2.1. Obtaining session token

3. Notification management [Notification]

3.1. Get notification List[Notification/Notifications]

3.2. Getting notification [Notification/Get]

3.3. Setting notification [Notification/Set]

3.4. Get notification Documents [documents/get]

4. Client management [Client]

4.1. Listed client [Client/clients]

4.2. Gettting client [Client/get]

4.3. Create client [Client/create]

4.4. Setting client [Client/set]

4.5. Delete client [Client/delete]

5. User management [User]

5.1. Get user groups [User/GetUserGroup]

6. Group management [Group]

6.1. Listed Groups [Group/GetAllGroups]

6.2. Get user groups [Group/GetGroupUser]

7. Automation management [Automation]

7.1. Automation Users [Automation/users]

8. Master data management [MasterData]

8.1. Listed Addresses [MasterData/getAddresses]

8.2. Listed Provinces [MasterData/getProvincias]

8.3. Listed Towns [MasterData/getPoblaciones]

8.4. Listed Available services [MasterData/getAvailableServices]

9. NeosDocCoud management [NeosDocCloud]

9.1. Get Document [NeosDocCloud/GetNeosDocCloud]

10. Agent management [Agent]

10.1. Create Order Download [Agent/createOrderDownload]

10.2. Get Order Download Status [Agent/getOrderDownloadStatus]

11. Common objects definition

11.1. NeosError object

11.2. MessagePV1 object

11.3. MessageDocPV1 object

11.4. ClientPV1 object

11.5. DirectionPV1 object

11.6. AddressTypePV1 object

11.7. ProvinciaPV1 object

11.8. PoblacionPV1 object

11.9. ClientContactPV1 object

11.10. NeosDocV1 object

11.11. CreateOrderDownReq object

11.12. AgnDownQueueP object

11.13. GroupPV1 object

11.14. UserPV1 object

11.15. AutomationUserPV1 object

11.16. PageResult object

12. Fixed values

12.1. Notification status

13. OData Examples

13.1. Filter expressions