Listar apólices

Retorna a lista de apólices.

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

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

Permissão requerida: leitura

Parametro   Descrição
EntityID int Id da entidade que pretende obter a lista de apólices.
ContractID int Id da apólice que pretende consulta. Pode enviar vários separados por virgula.
CompanyID int Id da companhia que pretende obter a lista de apólices.
ProductID int Id do producto que pretende obter a lista de apólices.
LineID int Id da linha de produto que pretende obter a lista de apólices.
NativeCode string Número da apólice que pretende obter informação.
OfficeID int Id do escritório que pretende obter a lista de apólices.
SellerID int Id do parceiro que pretende obter a lista de apólices.
SellerType int Tipo de parceiro (enum Contract.SellerType) que pretende obter a lista de apólices.
FromStartDate datetime Data de início do risco a partir da qual pretende obter a lista de apólices.
ToStartDate datetime Data de início do risco até à qual pretende obter a lista de apólices.
FromCanceledDate datetime Data de cancelamento a partir da qual pretende obter a lista de apólices canceladas.
ToCanceledDate datetime Data de cancelamento até à qual pretende obter a lista de apólices canceladas.
FromCanceledRegisterDate datetime Data de registo do cancelamento a partir da qual pretende obter a lista de apólices canceladas.
ToCanceledRegisterDate datetime Data de registo do cancelamento até à qual pretende obter a lista de apólices canceladas.
FromCreationDate datetime Data de criação a partir da qual pretende obter a lista de apólices registadas.
ToCreationDate datetime Data de criação até à qual pretende obter a lista de apólices registadas.
FromModifiedDate datetime Data de modiação a partir da qual pretende obter a lista de apólices modificadas.
ToModifiedDate datetime Data de modificação até à qual pretende obter a lista de apólices modificadas.
Status int Situação da apólices (enum Contract.ContractStatus) que pretende obter a lista de apólices.
FractionType int Tipo de fracionamento (enum Contract.FractionType) que pretende obter a lista de apólices.
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. Entre 1 e 50. Se não enviado será assumido 50

Respostas

HTTP: 200

            [
                {
                    "ContractID": int,
                    "CompanyID" : int,
                    "CompanyName" : string,
                    "ProductID": int,
                    "LineID": int|null,
                    "ProductNativeCode": string,
                    "ProductName": string,
                    "NativeCode": string,
                    "PolicyHolderID": int,
                    "IssueDate": date,
                    "StartDate": date,
                    "EndDate": date|null,
                    "PeriodStartDate": date,
                    "DueDate": date,
                    "FractionType": int,
                    "BillingMethod": int,
                    "Title": string|null,
                    "Status": int,
                    "CancelDate": date|null,
                    "CancelRegisterDate": date|null,
                    "LastDocumentAmount": decimal,
                    "LastDocumentComissionAmount": decimal,
                    "LastDocumentCommercialAmount": decimal,
                    "CreationDate": datetime,
                    "ModifiedDate": datetime,
                    "OfficeID": int|null,
                    "Sellers": [
                        {
                            "SellerID": int,
                            "SellerType": int
                        },
                        ...
                    ] | []
                },
                ...
            ]
        
HTTP: 200

            int
        
HTTP: 400

            { "Message": "Invalid Status" }
            { "Message": "Invalid FractionType" }
            { "Message": "Invalid SellerType" }