GET ReferralGuide?documentNumber={documentNumber}

Devuelve una guia de remision por numero de documento. (Formato: XXX-XXX-XXXXXXXXX)

Request Information

URI Parameters

Name	Description	Type	Additional information
documentNumber	Numero del Documento	string	Required

Body Parameters

None.

Response Information

Resource Description

Return a ReferralGuide of an Issuer by id

ReferralGuideDto

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
DocumentNumber	Numero del Documento	string	None.
IssuedOn	Fecha de Emision del Documento	date	None.
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 del Emisor	string	Required Max length: 300
TradeName	Nombre Comercial del Emisor	string	Max length: 300
MainAddress	Direccion Principal del Emisor	string	Max length: 300
IssuerId	Id del Emisor	integer	Required
ContributorId	ID del Contribuyente	integer	None.
ContributorIdentificationType	Tipo de Identificacion del Contribuyente	string	None.
ContributorName	Nombre del Contribuyente	string	None.
ContributorIdentification	Numero de Identificacion del Contribuyente	string	None.
ContributorAddress	Direccion del Contribuyente	string	None.
Currency	Moneda	string	None.
Reason	Motivo o Explicacion del Documento	string	None.
Total	Valor Total del Documento	decimal number	None.
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.
IsEnabled	Estado Habilitado del Documento	boolean	None.
ReferralGuideInfo	Informacion de la Guia de Remision	ReferralGuideInfo	None.
AdditionalFields	Campos Adicionales	Collection of AdditionalField	None.
Details	Detalle de Productos de la Guia de Remision	Collection of ReferralGuideDetailModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "RUC": "sample string 2",
  "DocumentTypeCode": "sample string 3",
  "DocumentNumber": "sample string 6-sample string 7-sample string 8",
  "IssuedOn": "2025-06-14T10:24:47.2839603-05:00",
  "EstablishmentCode": "sample string 6",
  "IssuePointCode": "sample string 7",
  "Sequential": "sample string 8",
  "Emails": "sample string 9",
  "CreatedOn": "2025-06-14T10:24:47.2839603-05:00",
  "BussinesName": "sample string 11",
  "TradeName": "sample string 12",
  "MainAddress": "sample string 13",
  "IssuerId": 14,
  "ContributorId": 15,
  "ContributorIdentificationType": "sample string 16",
  "ContributorName": "sample string 17",
  "ContributorIdentification": "sample string 18",
  "ContributorAddress": "sample string 19",
  "Currency": "sample string 20",
  "Reason": "sample string 21",
  "Total": 22.0,
  "AccessKey": "sample string 23",
  "AuthorizationDate": "sample string 24",
  "AuthorizationNumber": "sample string 25",
  "PDF": "sample string 26",
  "XML": "sample string 27",
  "Status": 0,
  "StatusMsg": "sample string 28",
  "LastModifiedOn": "2025-06-14T10:24:47.2839603-05:00",
  "IsEnabled": true,
  "ReferralGuideInfo": {
    "ReferralGuideInfoId": 1,
    "IssuedOn": "sample string 2",
    "ContributorId": 1,
    "IdentificationType": "sample string 3",
    "Identification": "sample string 4",
    "BusinessName": "sample string 5",
    "SenderAddress": "sample string 6",
    "OriginAddress": "sample string 7",
    "DestinationAddress": "sample string 8",
    "DriverId": 9,
    "DriverIdentificationType": "sample string 10",
    "DriverIdentification": "sample string 11",
    "DriverName": "sample string 12",
    "CarPlate": "sample string 13",
    "ShippingStartDate": "sample string 14",
    "ShippingEndDate": "sample string 15",
    "RecipientId": 16,
    "RecipientIdentificationType": "sample string 17",
    "RecipientIdentification": "sample string 18",
    "RecipientName": "sample string 19",
    "RecipientAddress": "sample string 20",
    "Reason": "sample string 21",
    "DAU": "sample string 22",
    "RecipientEstablishment": "sample string 23",
    "ShipmentRoute": "sample string 24",
    "ReferenceDocumentId": 1,
    "ReferenceDocumentCode": "sample string 25",
    "ReferenceDocumentNumber": "sample string 26",
    "ReferenceDocumentDate": "sample string 27",
    "ReferenceDocumentAuth": "sample string 28",
    "Details": [
      {
        "Id": 1,
        "ReferralGuideInfoId": 2,
        "ProductId": 3,
        "MainCode": "sample string 4",
        "AuxCode": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7
      },
      {
        "Id": 1,
        "ReferralGuideInfoId": 2,
        "ProductId": 3,
        "MainCode": "sample string 4",
        "AuxCode": "sample string 5",
        "Description": "sample string 6",
        "Quantity": 7
      }
    ]
  },
  "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
    }
  ],
  "Details": [
    {
      "ProductId": 1,
      "MainCode": "sample string 2",
      "AuxCode": "sample string 3",
      "Description": "sample string 4",
      "Quantity": 5
    },
    {
      "ProductId": 1,
      "MainCode": "sample string 2",
      "AuxCode": "sample string 3",
      "Description": "sample string 4",
      "Quantity": 5
    }
  ]
}