Listar entidades

Retorna a lista de entidades por id ou número de contribuinte.

GET https://segurosapi.libax.com/v1/{token}/Entities
Obter uma lista com os filtros definidos

GET https://segurosapi.libax.com/v1/{token}/EntitiesCount
Obter quantos registos é possível obter com os filtros definidos. Skip e Take são ignorados.

Permissão requerida: leitura

Parâmetro   Descrição
EntityID int Id da entidade que pretende obter informação. Pode enviar vários separados por virgula.
Name string Nome da entidade que pretende obter informação (por aproximação).
VatNumber string Número de contribuinte da entidade que pretende obter informação.
Status int Situação da entitidade (enum Entity.Status) que pretende obter a lista.
FromCreationDate datetime Data de criação a partir da qual pretende obter a lista de clientes registados.
ToCreationDate datetime Data de criação até à qual pretende obter a lista de clientes registados.
FromModifiedDate datetime Data de modificação a partir da qual pretende obter a lista de clientes modificados.
ToModifiedDate datetime Data de modificação até à qual pretende obter a lista de clientes modificados.
ConsentStastus int 0: se aceitou consentimento RGPD, 1: pedido em espera, 2: não aceita, 3: sem registo
FromConsentAnswerDate datetime Data de resposta ao consentimento RGPD a partir da qual pretende obter lista.
ToConsentAnswerDate datetime Data de resposta ao consentimento RGPD até à qual pretende obter lista.
EntityType int Tipo da entitidade (enum Entity.EntityType) que pretende obter a lista.
Skip int Número de registos que pretende ignorar. Normalmente defina o número de registo que já obteve.
Take int Número de registos a obter por página.

Respostas

HTTP: 200 

            [
                {
                    "EntityID": int,
                    "Number": int,
                    "Name": string,
                    "VatNumber": string,
                    "Type": int,
                    "Street": string|null,
                    "City": string,
                    "Code": string|null,
                    "Country": string,
                    "Email": string|null,
                    "Phone": string|null,
                    "Mobile": string|null,
                    "Balance": decimal,
                    "BirthDate": date|null,
                    "Status": int,
                    "OccupationName": string|null,
                    "CreationDate" : date,
                    "ModifiedDate" : date,
                    "Iban" : string|null,
                    "PersonalCardNumber" : string|null,
                    "DrivingLicenseNumber" : string|null,
                    "DrivingLicenseDate" : date|null,
                    "IsConsentAccepted": bool,
                    "ConsentStatus": int,
                    "ExternalIds": [
                        {
                            "App": int,
                            "Id": string
                        }
                    ] | [],
                    "Sellers": [
                        {
                            "SellerID": int,
                            "SellerType": int
                        },
                        ...
                    ] | []
                    "OfficeIds": [
                        int,
                        ...
                    ] | [],
                    "ChildrenCount" : int,
                    "Observation" : string|null
                },
                ...
            ]
HTTP: 200 

            int