GET api/Invoice/SearchDocumentRelated/{GrantorTaxId}/{CustomerId}/{DocumentType}/{RelatedType}/{CurrencyId}?SerieFolio={SerieFolio}

Obtener lista de documentos relacionados para emisión

Request Information

URI Parameters

NameDescriptionTypeAdditional information
GrantorTaxId

RFC de la empresa

string

Required

CustomerId

Identificador del dlciente del cliente

globally unique identifier

Required

DocumentType

Tipo de documento (Ingreso = I, Egreso = E)

string

Required

RelatedType

Código de tipo de relación (ej. 01 = Nota de crédito de los documentos relacionados)

string

Required

CurrencyId

Identificador de la moneda

integer

Required

SerieFolio

SerieFolio para búsqueda

string

None.

Body Parameters

None.

Response Information

Resource Description

ResponseModelApiOfListOfSearchDocumentRelatedApiModel
NameDescriptionTypeAdditional information
success

Indica si la solicitud se procesó de manera satisfactoria

boolean

None.

message

Mensaje de la solicitud

string

None.

messageDetail

Lista de mensajes

Collection of string

None.

failureCode

Código de error en caso de existir

string

None.

data

Layout de respuesta de la solicitud

Collection of SearchDocumentRelatedApiModel

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": [
    {
      "DocumentId": "sample string 1",
      "Folio": "sample string 2",
      "Serial": "sample string 3",
      "DueDate": "2025-01-06T06:41:09.3560195-06:00",
      "TotalAmount": 5.0,
      "DocumentBalance": 1.0,
      "DocumentDate": "2025-01-06T06:41:09.3560195-06:00",
      "Currency": "sample string 7"
    },
    {
      "DocumentId": "sample string 1",
      "Folio": "sample string 2",
      "Serial": "sample string 3",
      "DueDate": "2025-01-06T06:41:09.3560195-06:00",
      "TotalAmount": 5.0,
      "DocumentBalance": 1.0,
      "DocumentDate": "2025-01-06T06:41:09.3560195-06:00",
      "Currency": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseModelApiOfListOfSearchDocumentRelatedApiModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <SearchDocumentRelatedApiModel>
      <DocumentId>sample string 1</DocumentId>
      <Folio>sample string 2</Folio>
      <Serial>sample string 3</Serial>
      <DueDate>2025-01-06T06:41:09.3560195-06:00</DueDate>
      <TotalAmount>5</TotalAmount>
      <DocumentBalance>1</DocumentBalance>
      <DocumentDate>2025-01-06T06:41:09.3560195-06:00</DocumentDate>
      <Currency>sample string 7</Currency>
    </SearchDocumentRelatedApiModel>
    <SearchDocumentRelatedApiModel>
      <DocumentId>sample string 1</DocumentId>
      <Folio>sample string 2</Folio>
      <Serial>sample string 3</Serial>
      <DueDate>2025-01-06T06:41:09.3560195-06:00</DueDate>
      <TotalAmount>5</TotalAmount>
      <DocumentBalance>1</DocumentBalance>
      <DocumentDate>2025-01-06T06:41:09.3560195-06:00</DocumentDate>
      <Currency>sample string 7</Currency>
    </SearchDocumentRelatedApiModel>
  </data>
</ResponseModelApiOfListOfSearchDocumentRelatedApiModel>