GET api/Document/{DocumentId}
Obtener documento
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Identificador único del documento CFDI |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Detalle del documento CFDI
ResponseModelApiOfGetDocumentModelApi| Name | Description | Type | Additional 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 |
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": {
"Info": {
"DocumentId": "sample string 1",
"ReferenceDocumentId": "08dd2e4b-26e5-9a51-522b-6e3108c3f965",
"GrantorId": "sample string 2",
"CustomerId": "08dd2e4b-26e5-9a51-522b-6e3108c3f966",
"CreationDate": "2025-01-06T06:10:46.6484817-06:00",
"DocumentDate": "2025-01-06T06:10:46.6484817-06:00",
"DocumentTypeName": "sample string 6",
"DueDate": "2025-01-06T06:10:46.6484817-06:00",
"DueDays": 8,
"IsDue": true,
"TermOfPaymentDescription": "sample string 10",
"StatusId": 4,
"StatusName": "sample string 11",
"DeliveryPortal": true,
"CollaborativeStatusId": 1,
"CollaborativeStatus": "sample string 13",
"SerieFolio": "sample string 14",
"SubTotalAmount": 15.0,
"TaxAmount": 16.0,
"TotalAmount": 17.0,
"DocumentBalance": 18.0,
"IsCrr": true,
"IsCeded": true,
"CurrencyCode": "sample string 21",
"CurrencyIsoCode": "sample string 22",
"ExchangeRate": "sample string 23",
"DiscountAmount": 24.0,
"isCall": true,
"isEmail": true,
"isSIC": true,
"IsRecurrence": true,
"IsCancelled": true,
"Seller": "sample string 29",
"SellerId": "08dd2e4b-26e5-9a51-522b-6e3108c3f967",
"Branch": "sample string 30",
"BranchId": 1,
"Comments": "sample string 31",
"PaymentMethod": "sample string 32",
"PaymentMethodCode": "sample string 33",
"PaymentWay": "sample string 34",
"PaymentWayCode": "sample string 35",
"UseCFDI": "sample string 36",
"UseCFDICode": "sample string 37",
"RelationType": "sample string 38",
"RelationTypeCode": "sample string 39",
"Partiality": {
"PartialityNumber": 1,
"Frequency": "sample string 1",
"FrequencyId": 1,
"Interest": 1
},
"RelatedDocuments": [
{
"DocumentId": "sample string 1",
"SerieFolio": "sample string 2"
},
{
"DocumentId": "sample string 1",
"SerieFolio": "sample string 2"
}
]
},
"Taxes": [
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
},
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
}
],
"details": [
{
"Unit": "sample string 1",
"UnitCode": "sample string 2",
"Quantity": 3.0,
"ItemDescription": "sample string 4",
"ItemSATDescription": "sample string 5",
"UnitPrice": 6.0,
"ItemAmount": 7.0,
"Discount": 1.0,
"ItemCode": "sample string 8",
"Taxes": [
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
},
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
}
]
},
{
"Unit": "sample string 1",
"UnitCode": "sample string 2",
"Quantity": 3.0,
"ItemDescription": "sample string 4",
"ItemSATDescription": "sample string 5",
"UnitPrice": 6.0,
"ItemAmount": 7.0,
"Discount": 1.0,
"ItemCode": "sample string 8",
"Taxes": [
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
},
{
"TaxCode": "sample string 1",
"TaxType": "sample string 2",
"TaxFactorType": "sample string 3",
"TaxValue": 4.0,
"Base": "sample string 5",
"Amount": 6.0
}
]
}
],
"customer": {
"CustomerTaxId": "sample string 1",
"CustomerTypeName": "sample string 2",
"CitizenshipCode": "sample string 3",
"BusinessName": "sample string 4",
"isActive": true,
"ContactInfoId": "08dd2e4b-26e5-9a51-522b-6e3108c3f968",
"Phone": "sample string 7",
"Cellphone": "sample string 8",
"Email": "sample string 9",
"AddressTypeName": "sample string 10",
"StreetName": "sample string 11",
"ExternalNumber": "sample string 12",
"InternalNumber": "sample string 13",
"DistrictName": "sample string 14",
"MunicipalityName": "sample string 15",
"CityName": "sample string 16",
"ZipCode": "sample string 17",
"StateName": "sample string 18",
"CountryName": "sample string 19",
"CustomerCode": "sample string 20"
},
"Payments": [
{
"PaymentId": "08dd2e4b-26e5-9a51-522b-6e3108c3f969",
"Automatic": true,
"PaymentDate": "2025-01-06T06:10:46.6484817-06:00",
"PaymentType": "sample string 3",
"PaymentAmount": 1.0,
"PaymentMethod": "sample string 4",
"Comments": "sample string 5",
"PaymentMethodId": 1,
"Currency": "sample string 6",
"DocumentId": 1,
"StatusREP": "sample string 7",
"Status": "sample string 8"
},
{
"PaymentId": "08dd2e4b-26e5-9a51-522b-6e3108c3f969",
"Automatic": true,
"PaymentDate": "2025-01-06T06:10:46.6484817-06:00",
"PaymentType": "sample string 3",
"PaymentAmount": 1.0,
"PaymentMethod": "sample string 4",
"Comments": "sample string 5",
"PaymentMethodId": 1,
"Currency": "sample string 6",
"DocumentId": 1,
"StatusREP": "sample string 7",
"Status": "sample string 8"
}
],
"files": [
{
"FileId": "08dd2e4b-26e5-9a51-522b-6e3108c3f96a",
"FileName": "sample string 2",
"FileContent": "sample string 3",
"FileTypeName": "sample string 4",
"IsFiscal": true,
"CreationDate": "2025-01-06T06:10:46.6484817-06:00"
},
{
"FileId": "08dd2e4b-26e5-9a51-522b-6e3108c3f96a",
"FileName": "sample string 2",
"FileContent": "sample string 3",
"FileTypeName": "sample string 4",
"IsFiscal": true,
"CreationDate": "2025-01-06T06:10:46.6484817-06:00"
}
]
}
}
application/xml, text/xml
Sample:
<ResponseModelApiOfGetDocumentModelApi 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>
<Info>
<DocumentId>sample string 1</DocumentId>
<ReferenceDocumentId>08dd2e4b-26e5-9a51-522b-6e3108c3f965</ReferenceDocumentId>
<GrantorId>sample string 2</GrantorId>
<CustomerId>08dd2e4b-26e5-9a51-522b-6e3108c3f966</CustomerId>
<CreationDate>2025-01-06T06:10:46.6484817-06:00</CreationDate>
<DocumentDate>2025-01-06T06:10:46.6484817-06:00</DocumentDate>
<DocumentTypeName>sample string 6</DocumentTypeName>
<DueDate>2025-01-06T06:10:46.6484817-06:00</DueDate>
<DueDays>8</DueDays>
<IsDue>true</IsDue>
<TermOfPaymentDescription>sample string 10</TermOfPaymentDescription>
<StatusId>To_be_validated</StatusId>
<StatusName>sample string 11</StatusName>
<DeliveryPortal>true</DeliveryPortal>
<CollaborativeStatusId>Pending</CollaborativeStatusId>
<CollaborativeStatus>sample string 13</CollaborativeStatus>
<SerieFolio>sample string 14</SerieFolio>
<SubTotalAmount>15</SubTotalAmount>
<TaxAmount>16</TaxAmount>
<TotalAmount>17</TotalAmount>
<DocumentBalance>18</DocumentBalance>
<IsCrr>true</IsCrr>
<IsCeded>true</IsCeded>
<CurrencyCode>sample string 21</CurrencyCode>
<CurrencyIsoCode>sample string 22</CurrencyIsoCode>
<ExchangeRate>sample string 23</ExchangeRate>
<DiscountAmount>24</DiscountAmount>
<isCall>true</isCall>
<isEmail>true</isEmail>
<isSIC>true</isSIC>
<IsRecurrence>true</IsRecurrence>
<IsCancelled>true</IsCancelled>
<Seller>sample string 29</Seller>
<SellerId>08dd2e4b-26e5-9a51-522b-6e3108c3f967</SellerId>
<Branch>sample string 30</Branch>
<BranchId>1</BranchId>
<Comments>sample string 31</Comments>
<PaymentMethod>sample string 32</PaymentMethod>
<PaymentMethodCode>sample string 33</PaymentMethodCode>
<PaymentWay>sample string 34</PaymentWay>
<PaymentWayCode>sample string 35</PaymentWayCode>
<UseCFDI>sample string 36</UseCFDI>
<UseCFDICode>sample string 37</UseCFDICode>
<RelationType>sample string 38</RelationType>
<RelationTypeCode>sample string 39</RelationTypeCode>
<Partiality>
<PartialityNumber>1</PartialityNumber>
<Frequency>sample string 1</Frequency>
<FrequencyId>1</FrequencyId>
<Interest>1</Interest>
</Partiality>
<RelatedDocuments>
<RelatedDocumentModelApi>
<DocumentId>sample string 1</DocumentId>
<SerieFolio>sample string 2</SerieFolio>
</RelatedDocumentModelApi>
<RelatedDocumentModelApi>
<DocumentId>sample string 1</DocumentId>
<SerieFolio>sample string 2</SerieFolio>
</RelatedDocumentModelApi>
</RelatedDocuments>
</Info>
<Taxes>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
</Taxes>
<details>
<DocumentDetailsModelApi>
<Unit>sample string 1</Unit>
<UnitCode>sample string 2</UnitCode>
<Quantity>3</Quantity>
<ItemDescription>sample string 4</ItemDescription>
<ItemSATDescription>sample string 5</ItemSATDescription>
<UnitPrice>6</UnitPrice>
<ItemAmount>7</ItemAmount>
<Discount>1</Discount>
<ItemCode>sample string 8</ItemCode>
<Taxes>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
</Taxes>
</DocumentDetailsModelApi>
<DocumentDetailsModelApi>
<Unit>sample string 1</Unit>
<UnitCode>sample string 2</UnitCode>
<Quantity>3</Quantity>
<ItemDescription>sample string 4</ItemDescription>
<ItemSATDescription>sample string 5</ItemSATDescription>
<UnitPrice>6</UnitPrice>
<ItemAmount>7</ItemAmount>
<Discount>1</Discount>
<ItemCode>sample string 8</ItemCode>
<Taxes>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
<TaxApiModel>
<TaxCode>sample string 1</TaxCode>
<TaxType>sample string 2</TaxType>
<TaxFactorType>sample string 3</TaxFactorType>
<TaxValue>4</TaxValue>
<Base>sample string 5</Base>
<Amount>6</Amount>
</TaxApiModel>
</Taxes>
</DocumentDetailsModelApi>
</details>
<customer>
<CustomerTaxId>sample string 1</CustomerTaxId>
<CustomerTypeName>sample string 2</CustomerTypeName>
<CitizenshipCode>sample string 3</CitizenshipCode>
<BusinessName>sample string 4</BusinessName>
<isActive>true</isActive>
<ContactInfoId>08dd2e4b-26e5-9a51-522b-6e3108c3f968</ContactInfoId>
<Phone>sample string 7</Phone>
<Cellphone>sample string 8</Cellphone>
<Email>sample string 9</Email>
<AddressTypeName>sample string 10</AddressTypeName>
<StreetName>sample string 11</StreetName>
<ExternalNumber>sample string 12</ExternalNumber>
<InternalNumber>sample string 13</InternalNumber>
<DistrictName>sample string 14</DistrictName>
<MunicipalityName>sample string 15</MunicipalityName>
<CityName>sample string 16</CityName>
<ZipCode>sample string 17</ZipCode>
<StateName>sample string 18</StateName>
<CountryName>sample string 19</CountryName>
<CustomerCode>sample string 20</CustomerCode>
</customer>
<Payments>
<PaymentApiModel>
<PaymentId>08dd2e4b-26e5-9a51-522b-6e3108c3f969</PaymentId>
<Automatic>true</Automatic>
<PaymentDate>2025-01-06T06:10:46.6484817-06:00</PaymentDate>
<PaymentType>sample string 3</PaymentType>
<PaymentAmount>1</PaymentAmount>
<PaymentMethod>sample string 4</PaymentMethod>
<Comments>sample string 5</Comments>
<PaymentMethodId>1</PaymentMethodId>
<Currency>sample string 6</Currency>
<DocumentId>1</DocumentId>
<StatusREP>sample string 7</StatusREP>
<Status>sample string 8</Status>
</PaymentApiModel>
<PaymentApiModel>
<PaymentId>08dd2e4b-26e5-9a51-522b-6e3108c3f969</PaymentId>
<Automatic>true</Automatic>
<PaymentDate>2025-01-06T06:10:46.6484817-06:00</PaymentDate>
<PaymentType>sample string 3</PaymentType>
<PaymentAmount>1</PaymentAmount>
<PaymentMethod>sample string 4</PaymentMethod>
<Comments>sample string 5</Comments>
<PaymentMethodId>1</PaymentMethodId>
<Currency>sample string 6</Currency>
<DocumentId>1</DocumentId>
<StatusREP>sample string 7</StatusREP>
<Status>sample string 8</Status>
</PaymentApiModel>
</Payments>
<files>
<FilesModelApi>
<FileId>08dd2e4b-26e5-9a51-522b-6e3108c3f96a</FileId>
<FileName>sample string 2</FileName>
<FileContent>sample string 3</FileContent>
<FileTypeName>sample string 4</FileTypeName>
<IsFiscal>true</IsFiscal>
<CreationDate>2025-01-06T06:10:46.6484817-06:00</CreationDate>
</FilesModelApi>
<FilesModelApi>
<FileId>08dd2e4b-26e5-9a51-522b-6e3108c3f96a</FileId>
<FileName>sample string 2</FileName>
<FileContent>sample string 3</FileContent>
<FileTypeName>sample string 4</FileTypeName>
<IsFiscal>true</IsFiscal>
<CreationDate>2025-01-06T06:10:46.6484817-06:00</CreationDate>
</FilesModelApi>
</files>
</data>
</ResponseModelApiOfGetDocumentModelApi>