Listar documentos comerciais

Retorna a lista de documentos comerciais.

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

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

Permissão requerida: leitura internos

Parâmetro   Descrição
SaleID int Id do recibo que pretende consultar. Pode enviar vários separados por virgula.
EntityID int Id da entidade que pretende obter a lista de recibos.
DocumentType int Identifica o tipo de documento.
Number int Número do documento que pretende obter informação.
SerieID int Id da série do documento que pretende.
FromSaleDate datetime Data do documento desde a qual pretendende obter a lista.
ToSaleDate datetime Data do documento até à qual pretendende 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 (criado ou alterado) a partir da qual pretende obter a lista.
ToStatusDate datetime Data de situação (criado ou alterado) 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.
IsPending bool True se pretende obter documentos pendentes, caso contrário, false.
IsCanceled bool True se pretende obter documentos cancelados, caso contrário, false.
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

            [
                {
                    "SaleID": int,
                    "DocumentType": int,
                    "Number": int,
                    "SerieID": int,
                    "SerieDisplayCode": string,
                    "EntityID": int,
                    "SaleDate": date,
                    "StatusDate": datetime,
                    "CreationDate": datetime,
                    "SubTotal": decimal,
                    "DiscountAmount": decimal,
                    "GrossAmount": decimal,
                    "RetentionRate": decimal,
                    "IrsRetentionAmount": decimal,
                    "IrcRetentionAmount": decimal,
                    "SealAmount": decimal,
                    "TaxAmount": decimal,
                    "TotalDue": decimal,
                    "PendingAmount": decimal,
                    "Reference": string,
                    "IsCanceled": bool,
                    "Details": [
                        {
                            "ProductReference": string,
                            "Description": string,
                            "ProductDetail": string,
                            "UnitPrice": decimal,
                            "Quantity": decimal,
                            "UnitOfMeasure": string,
                            "TaxRate": decimal,
                            "DiscountRate": decimal,
                            "TaxIncidenceAmount": decimal,
                            "TaxAmount": decimal,
                            "LineTotal": decimal
                        }
                    ]
                },
                ...
            ]
        
HTTP: 200

            int