GET Retention?search={search}&startDate={startDate}&endDate={endDate}&status={status}&page={page}&pageSize={pageSize}

Realiza la busqueda de las retenciones usando una serie de filtros

Request Information

URI Parameters

Name	Type	Additional information
search	string	Required
startDate	date	None.
endDate	date	None.
status	DocumentStatusEnum	None.
page	integer	Default value is 1
pageSize	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

Devuelve una lista de facturas

Collection of RetentionDto

Name	Description	Type	Additional information
Id	Identificador Unico del Documento	integer	Required
RUC	Registro Unico de Contribuyente	string	Required Max length: 13
DocumentTypeCode	Código del Documento a Emitir (Tabla 3 Ficha Tecnica)	string	String length: inclusive between 0 and 2
EstablishmentCode	Codigo Establecimiento	string	String length: inclusive between 0 and 5
IssuePointCode	Punto de Emisión del Comprobante	string	String length: inclusive between 0 and 5
Sequential	Secuencial	string	String length: inclusive between 0 and 9
Emails	Emails, Emails para enviar el comprobante.	string	String length: inclusive between 0 and 500
CreatedOn	Fecha de creacion del documento	date	None.
BussinesName	Razon Social	string	Required Max length: 300
TradeName	Nombre Comercial	string	Max length: 300
MainAddress	Direccion Principal	string	Max length: 300
IsEnabled	Estado Habilitado del Documento	boolean	None.
RetentionInfo	Informacion de la Factura	RetentionInfo	None.
AdditionalFields	Campos Adicionales	Collection of AdditionalField	None.
IssuerId	Id del Emisor	integer	Required
AccessKey	Clave de Acceso	string	None.
AuthorizationDate	Fecha de autorizacion	string	None.
AuthorizationNumber	Numero de Autorizacion	string	None.
PDF	PDF	string	None.
XML	XML	string	None.
Status	Estado actual del documento	DocumentStatusEnum	None.
StatusMsg	Mensaje del Estado	string	None.
LastModifiedOn	Fecha de Modificacion	date	None.
DocumentNumber	Numero del Documento	string	None.
IssuedOn		date	None.
ContributorId		integer	None.
ContributorIdentificationType		string	None.
ContributorName		string	None.
ContributorIdentification		string	None.
ContributorAddress		string	None.
Currency		string	None.
Reason		string	None.
Total		decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "RUC": "sample string 2",
    "DocumentTypeCode": "sample string 3",
    "EstablishmentCode": "sample string 4",
    "IssuePointCode": "sample string 5",
    "Sequential": "sample string 6",
    "Emails": "sample string 7",
    "CreatedOn": "2025-06-14T10:41:54.3519606-05:00",
    "BussinesName": "sample string 9",
    "TradeName": "sample string 10",
    "MainAddress": "sample string 11",
    "IsEnabled": true,
    "RetentionInfo": {
      "RetentionInfoId": 1,
      "IssuedOn": "sample string 2",
      "ContributorId": 1,
      "IdentificationType": "sample string 3",
      "Identification": "sample string 4",
      "BusinessName": "sample string 5",
      "Currency": "sample string 6",
      "Reason": "sample string 7",
      "FiscalPeriod": "sample string 8",
      "FiscalAmount": 9.0,
      "Details": [
        {
          "RetentionTaxId": 2,
          "TaxTypeCode": "sample string 3",
          "RetentionTaxCode": "sample string 4",
          "TaxBase": 5.0,
          "TaxRate": 6.0,
          "TaxValue": 7.0,
          "ReferenceDocumentCode": "sample string 8",
          "ReferenceDocumentNumber": "sample string 9",
          "ReferenceDocumentDate": "sample string 10",
          "RetentionInfoId": 11
        },
        {
          "RetentionTaxId": 2,
          "TaxTypeCode": "sample string 3",
          "RetentionTaxCode": "sample string 4",
          "TaxBase": 5.0,
          "TaxRate": 6.0,
          "TaxValue": 7.0,
          "ReferenceDocumentCode": "sample string 8",
          "ReferenceDocumentNumber": "sample string 9",
          "ReferenceDocumentDate": "sample string 10",
          "RetentionInfoId": 11
        }
      ],
      "ReferenceDocumentCode": "sample string 10",
      "ReferenceDocumentNumber": "sample string 11",
      "ReferenceDocumentDate": "sample string 12",
      "ReferenceDocumentAuth": "sample string 13",
      "ReferenceDocumentAmount": 14.0,
      "ReferenceDocumentVat": 15.0
    },
    "AdditionalFields": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "LineNumber": 4,
        "DocumentId": 5
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "LineNumber": 4,
        "DocumentId": 5
      }
    ],
    "IssuerId": 13,
    "AccessKey": "sample string 14",
    "AuthorizationDate": "sample string 15",
    "AuthorizationNumber": "sample string 16",
    "PDF": "sample string 17",
    "XML": "sample string 18",
    "Status": 0,
    "StatusMsg": "sample string 19",
    "LastModifiedOn": "2025-06-14T10:41:54.3529637-05:00",
    "DocumentNumber": "sample string 4-sample string 5-sample string 6",
    "IssuedOn": "2025-06-14T10:41:54.3529637-05:00",
    "ContributorId": 22,
    "ContributorIdentificationType": "sample string 23",
    "ContributorName": "sample string 24",
    "ContributorIdentification": "sample string 25",
    "ContributorAddress": "sample string 26",
    "Currency": "sample string 27",
    "Reason": "sample string 28",
    "Total": 29.0
  },
  {
    "Id": 1,
    "RUC": "sample string 2",
    "DocumentTypeCode": "sample string 3",
    "EstablishmentCode": "sample string 4",
    "IssuePointCode": "sample string 5",
    "Sequential": "sample string 6",
    "Emails": "sample string 7",
    "CreatedOn": "2025-06-14T10:41:54.3519606-05:00",
    "BussinesName": "sample string 9",
    "TradeName": "sample string 10",
    "MainAddress": "sample string 11",
    "IsEnabled": true,
    "RetentionInfo": {
      "RetentionInfoId": 1,
      "IssuedOn": "sample string 2",
      "ContributorId": 1,
      "IdentificationType": "sample string 3",
      "Identification": "sample string 4",
      "BusinessName": "sample string 5",
      "Currency": "sample string 6",
      "Reason": "sample string 7",
      "FiscalPeriod": "sample string 8",
      "FiscalAmount": 9.0,
      "Details": [
        {
          "RetentionTaxId": 2,
          "TaxTypeCode": "sample string 3",
          "RetentionTaxCode": "sample string 4",
          "TaxBase": 5.0,
          "TaxRate": 6.0,
          "TaxValue": 7.0,
          "ReferenceDocumentCode": "sample string 8",
          "ReferenceDocumentNumber": "sample string 9",
          "ReferenceDocumentDate": "sample string 10",
          "RetentionInfoId": 11
        },
        {
          "RetentionTaxId": 2,
          "TaxTypeCode": "sample string 3",
          "RetentionTaxCode": "sample string 4",
          "TaxBase": 5.0,
          "TaxRate": 6.0,
          "TaxValue": 7.0,
          "ReferenceDocumentCode": "sample string 8",
          "ReferenceDocumentNumber": "sample string 9",
          "ReferenceDocumentDate": "sample string 10",
          "RetentionInfoId": 11
        }
      ],
      "ReferenceDocumentCode": "sample string 10",
      "ReferenceDocumentNumber": "sample string 11",
      "ReferenceDocumentDate": "sample string 12",
      "ReferenceDocumentAuth": "sample string 13",
      "ReferenceDocumentAmount": 14.0,
      "ReferenceDocumentVat": 15.0
    },
    "AdditionalFields": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "LineNumber": 4,
        "DocumentId": 5
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "LineNumber": 4,
        "DocumentId": 5
      }
    ],
    "IssuerId": 13,
    "AccessKey": "sample string 14",
    "AuthorizationDate": "sample string 15",
    "AuthorizationNumber": "sample string 16",
    "PDF": "sample string 17",
    "XML": "sample string 18",
    "Status": 0,
    "StatusMsg": "sample string 19",
    "LastModifiedOn": "2025-06-14T10:41:54.3529637-05:00",
    "DocumentNumber": "sample string 4-sample string 5-sample string 6",
    "IssuedOn": "2025-06-14T10:41:54.3529637-05:00",
    "ContributorId": 22,
    "ContributorIdentificationType": "sample string 23",
    "ContributorName": "sample string 24",
    "ContributorIdentification": "sample string 25",
    "ContributorAddress": "sample string 26",
    "Currency": "sample string 27",
    "Reason": "sample string 28",
    "Total": 29.0
  }
]