Listar recibos

Retorna a lista de recibos.

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

GET https://segurosapi.libax.com/v1/{token}/DocumentsCount
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 a lista de recibos. Pode enviar vários separados por virgula.
ContractID int Id da apólice que pretende obter a lista de recibos. Pode enviar vários separados por virgula.
DocumentID int Id do recibo que pretende consultar. Pode enviar vários separados por virgula.
SaleID int Id do documento interno que pretende consultar. Pode enviar vários separados por virgula.
CompanyID int Id da companhia que pretende obter a lista de recibos. Pode enviar vários separados por virgula.
ProductID int Id do producto que pretende obter a lista de recibos. Pode enviar vários separados por virgula.
LineID int Id da linha de produto que pretende obter a lista de recibos.
NativeCode string Número do recibo que pretende obter informação.
Type int Tipo de recibo (enum Document.Type) que pretende obter na lista. Pode enviar vários separados por virgula.
OfficeID int Id do escritório que pretende obter na lista.
SellerID int Id do parceiro que pretende obter na lista.
SellerType int Tipo de parceiro (enum Contract.SellerType) que pretende obter a lista de apólices. -1 para não definido
FromCoverageStartDate datetime Data de início do período a partir da qual pretende obter a lista.
ToCoverageStartDate datetime Data de início do período até à qual pretende obter a lista.
FromDueDate datetime Data de vencimento a partir da qual pretende obter a lista.
ToDueDate datetime Data de vencimento até à qual pretende obter a lista.
FromStatusDate datetime Data de situação (pago ou devolvido) a partir da qual pretende obter a lista.
ToStatusDate datetime Data de situação (pago ou devolvido) até à qual pretende obter a lista.
FromCreationDate datetime Data de criação a partir da qual pretende obter a lista de recibos registados.
ToCreationDate datetime Data de criação até à qual pretende obter a lista de recibos registados.
FromModifiedDate datetime Data de modiação a partir da qual pretende obter a lista de recibos modificados.
ToModifiedDate datetime Data de modificação até à qual pretende obter a lista de recibos modificados.
IsPending bool True se pretende obter recibos pendentes, caso contrário, false.
IsCanceled bool True se pretende obter recibos devolvidos, caso contrário, false.
FractionType int Tipo de fracionamento (enum Contract.FractionType) que pretende obter a lista.
FixedSellerList bool True se pretende que a lista de sellers seja fixa, ou seja, que todos os níveis sejam preenchidos mesmo que não haja parceiro e nesse caso o sellerID pode ser null.
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 

            [
                {
                    "DocumentID": int,
                    "SaleID": int,
                    "CompanyID" : int,
                    "CompanyName" : string,
                    "ContractID": int,
                    "ContractNativeCode": string,
                    "ProductID": int,
                    "ProductNativeCode": string,
                    "LineID": int|null,
                    "ProductName": string,
                    "NativeCode": string,
                    "EntityID": int,
                    "Type": int,
                    "IssueDate": date,
                    "StartDateCoverage": date,
                    "EndDateCoverage": date,
                    "DueDate": date,
                    "StatusDate": date|null,
                    "DirectReason": int,
                    "BillingMethod": int,
                    "SimpleAmount": decimal,
                    "CommercialAmount": decimal,
                    "TotalAmount": decimal,
                    "PendingAmount": decimal,
                    "ComissionAmount": decimal,
                    "MediationAmount": decimal,
                    "ChargingAmount": decimal,
                    "BrokingAmount": decimal,
                    "OtherAmount": decimal,
                    "IsDirect": bool,
                    "IsCanceled": bool,
                    "CreationDate": datetime,
                    "ModifiedDate": datetime,
                    "IsFirst": bool,
                    "ContractFractionType": int,
                    "Sellers": [
                        {
                            "SellerID": int,
                            "SellerType": int
                        },
                        ...
                    ] | []
                },
                ...
            ]
HTTP: 200 

            int