Guida
Changelog
XOX Group
Guida
Changelog
XOX Group

Elenco anagrafiche

[baseUrl]/api/sync/v1/irs

API per l'elenco delle anagrafiche o dell'anagrafica loggata nel caso sia passato l'header AccessToken

Parametri Richiesta

Field Type Required Default Description Notes
FIDIR int ❌ null ID del cliente in alternativa a IRIDS
IRIDS int[] ❌ null Elenco ID clienti in alternativa a FIDIR
FIDGroup int ❌ null Gruppo anagrafico
FIDTypologies int[] ❌ null Tipologie anagrafiche
Email string ❌ null Email del cliente
Phone string ❌ null Telefono/Cellulare del cliente
INFO

Se è presente l'header AccessToken viene restituita soltanto l'anagrafica dell'utente loggato.

Esempio Richiesta

Ricerca per ID del cliente

sh
curl --location '[baseUrl]/api/sync/v1/irs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "FIDIR": 1
}'

Ricerca per elenco ID clienti

sh
curl --location '[baseUrl]/api/sync/v1/irs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "IRIDS": [1,2,3]
}'

Ricerca per email

sh
curl --location '[baseUrl]/api/sync/v1/irs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Email": "mail@mail.it"
}'

Risposta

JSON
{
    "statusCode": 200,
    "errorCode": null,
    "message": null,
    "result": {
        "totalCount": 1,
        "totalPages": 1,
        "page": 1,
        "count": 100,
        "records": [
            {
                "ID": 1,
                "Code": "CODE",
                "Denomination": "DENOMINATION",
                "Alias": "ALIAS",
                "Name": "",
                "Surname": "",
                "Address": "ADDRESS",
                "Country": "COUNTRY",
                "Region": "REGION",
                "Province": "PROVINCE",
                "City": "CITY",
                "Zip": "ZIP",
                "TaxCode": "TAXCODE",
                "VatNumber": "VATNUMBER",
                "Group": "Azienda",
                "FIDGroup": 2,
                "FIDCountry": 1,
                "FIDRegion": 1,
                "FIDProvince": 1,
                "FIDCity": 1,
                "FIDZip": 1,
                "Destinations": [
                    {
                        "ID": 2,
                        "Code": "CODE",
                        "Denomination": "DENOMINATION",
                        "Alias": "ALIAS",
                        "Name": "",
                        "Surname": "",
                        "Address": "ADDRESS",
                        "Country": "COUNTRY",
                        "Region": "REGION",
                        "Province": "PROVINCE",
                        "City": "CITY",
                        "Zip": "ZIP",
                        "TaxCode": "TAXCODE",
                        "VatNumber": "VATNUMBER",
                        "Group": "Azienda",
                        "FIDGroup": 2,
                        "FIDCountry": 1,
                        "FIDRegion": 1,
                        "FIDProvince": 1,
                        "FIDCity": 1,
                        "FIDZip": 1,
                    },
                    ...
                ],
                "Typologies": [
                    {
                        "ID": 2,
                        "Typology": "Cliente"
                    },
                ],
                "Files": [
                    {
                        "Extension": ".png",
                        "FileName": "Logo.png",
                        "Link": "[baseUrl]/api/catalog/image/?ID=1"
                    }
                ],
                "Contacts": [
                    {
                        "ID": 1,
                        "FIDContactTypology": 4,
                        "ContactTypology": "PEC",
                        "Value": "pec@pec.it",
                        "Remarks": ""
                    }
                ],
                "Users": [
                    {
                        "ID": 3,
                        "Username": "username"
                    },
                    ...
                ]
            },
            ...
        ],
        "record": null
    },
    "debug": null
}
IN QUESTA PAGINA