POST GetDocumentStatusWithPci

Consulta el estado, de un documento enviado por medio del servicio

Request Information

URI Parameters

None.

Body Parameters

Tipo, prefijo y número de documento

DocumentStatusWithPci
NameDescriptionTypeAdditional information
pci

PCI del documento

string

Required
documentPrefixAndNumber

Prefijo y número del documento. Ej: SETP123 Se ignorarán los campos prefix y number

string

Required
fileTypeCode

Tipo de documento 1. Factura 2. Nota de crédito 3. Nota de débito

integer

Range: inclusive between 1 and 5
prefix

Prefijo del documento

string

Optional
number

Número del documento

string

Optional

Request Formats

application/json, text/json

Sample: 
{
  "pci": "sample string 1",
  "documentPrefixAndNumber": "sample string 2",
  "fileTypeCode": 3,
  "prefix": "sample string 4",
  "number": "sample string 5"
}

application/xml, text/xml

Sample: 
<DocumentStatusWithPci xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models.Requests.File">
  <documentPrefixAndNumber xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">sample string 2</documentPrefixAndNumber>
  <fileTypeCode xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">3</fileTypeCode>
  <number xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">sample string 5</number>
  <prefix xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">sample string 4</prefix>
  <pci>sample string 1</pci>
</DocumentStatusWithPci>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Estado del documento

StatusResponse
NameDescriptionTypeAdditional information
fileTypeCodeId

1: factura 2: nota de crédito 3: nota de débito

integer

Optional
cufe

CUFE o CUDE del documento generado.

string

Optional
prefix

Prefijo del documento generado.

string

Optional
number

Número del documento generado.

string

Optional
relatedDocumentPrefix

Indica el prefijo del documento referenciado, en caso de que haya sido contingencia del facturador

string

Optional
relatedDocumentNumber

Indica el número del documento referenciado, en caso de que haya sido contingencia del facturador

string

Optional
issueDate

Fecha de emisión del documento generado.

date

Optional
acquirer

Adquirente del documento generado.

Acquirer

Optional
supplier

Proveedor del documento generado.

Supplier

Optional
total

Total del documento generado.

decimal number

Optional
subtotal

Subtotal del documento generado.

decimal number

Optional
taxTotal

Total de impuestos del documento generado.

decimal number

Optional
ivaTotal

Total de impuestos IVA del documento generado.

decimal number

Optional
isXmlGenerated

Indica si el XML ya ha sido generado.

boolean

Optional
xmlGenerationDate

Fecha de generación del XML, si aplica.

date

Optional
xmlSendingDate

Fecha de envío del XML, si aplica.

date

Optional
isPdfGenerated

Indica si el PDF ya ha sido generado.

boolean

Optional
pdfGenerationDate

Fecha de generación del PDF.

date

Optional
pdfSendingDate

Fecha de envío del PDF.

date

Optional
isAcceptedByTheClient

Indica si el documento fue aceptado/rechazado por el adquirente. Null, si el cliente no ha realizado ninguna acción

boolean

Optional
clientStatus

Indica si el documento fue aceptado/rechazado por el adquirente.

string

Optional
dianRejectedCauseCode

Indica el código de rechazado por el adquirente.

string

Optional
dianRejectedCauseName

Indica nombre del rechazo por el adquirente.

string

Optional
clientReasons

Razones de rechazo por parte del adquiriente. Si aplica. ENVIADO, APROBADO, RECHAZADO

string

Optional
dianStatus

Indica el estado de la DIAN. RECIBIDO EXITOSO VALIDANDO FALLIDO ERROR SIN INFORMACION

string

Optional
dianReasons

Razones, notificaciones o rechazos de la DIAN

string

Optional
isContingency

Indica si un documento se generó en contingencia

boolean

Optional
documentManagementDate

Fecha de gestion(Aprobacion/Rechazo) del documento

date

Optional
isAutoApproved

Indica si un documento se generó en contingencia

boolean

Optional
acquirerStatusDate

Fecha de modificación por parte del adquirente

date

Optional
dianVerificationDate

Fecha de verificación por parte de la Dian

date

Optional
acquirerSendingDate

Fecha de envio del adquiriente

date

Optional
note

Nota para ser visualizada en la representación gráfica

string

Optional

Response Formats

application/json, text/json

Sample: 
{
  "fileTypeCodeId": 1,
  "cufe": "sample string 2",
  "prefix": "sample string 3",
  "number": "sample string 4",
  "relatedDocumentPrefix": "sample string 5",
  "relatedDocumentNumber": "sample string 6",
  "issueDate": "2024-04-28T14:29:54.5996775-05:00",
  "acquirer": {
    "documentTypeCode": "sample string 1",
    "documentNumber": "sample string 2",
    "verificationDigit": "sample string 3",
    "name": "sample string 4",
    "address": "sample string 5",
    "telephone": "sample string 6",
    "technologicalProviderNIT": "sample string 7",
    "juridicalOrganizationCode": "sample string 8",
    "regimenTypeCode": "sample string 9",
    "tributaryDetail": "sample string 10",
    "fiscalResponsabilities": [
      "sample string 1",
      "sample string 2"
    ],
    "contacts": [
      {
        "documentTypeCode": "sample string 1",
        "documentNumber": "sample string 2",
        "email": "sample string 3",
        "fullName": "sample string 4",
        "address": "sample string 5",
        "phoneNumber": "sample string 6",
        "cellphoneNumber": "sample string 7",
        "sendInvoice": true,
        "contract": "sample string 9",
        "position": "sample string 10",
        "active": true
      },
      {
        "documentTypeCode": "sample string 1",
        "documentNumber": "sample string 2",
        "email": "sample string 3",
        "fullName": "sample string 4",
        "address": "sample string 5",
        "phoneNumber": "sample string 6",
        "cellphoneNumber": "sample string 7",
        "sendInvoice": true,
        "contract": "sample string 9",
        "position": "sample string 10",
        "active": true
      }
    ],
    "merchantRegisters": [
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      },
      {
        "value": "sample string 1",
        "cityCode": "sample string 2",
        "departmentCode": "sample string 3",
        "active": true
      }
    ],
    "fiscalLocation": {
      "countryCode": "sample string 1",
      "state": "sample string 2",
      "city": "sample string 3",
      "postalZone": "sample string 4",
      "address": "sample string 5"
    },
    "physicalLocation": [
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      },
      {
        "countryCode": "sample string 1",
        "state": "sample string 2",
        "city": "sample string 3",
        "postalZone": "sample string 4",
        "address": "sample string 5"
      }
    ],
    "active": true
  },
  "supplier": {
    "fullName": "sample string 1",
    "documentNumber": "sample string 2",
    "documentTypeCode": "sample string 3",
    "code": "sample string 4",
    "juridicalOrganizationCode": "sample string 5",
    "regimenTypeCode": "sample string 6",
    "tributaryDetail": "sample string 7",
    "users": [
      {
        "FullName": "sample string 1",
        "Email": "sample string 2",
        "PhoneNumber": "sample string 3"
      },
      {
        "FullName": "sample string 1",
        "Email": "sample string 2",
        "PhoneNumber": "sample string 3"
      }
    ],
    "fiscalLocation": {
      "countryCode": "sample string 1",
      "state": "sample string 2",
      "city": "sample string 3",
      "postalZone": "sample string 4",
      "address": "sample string 5"
    },
    "Email": "sample string 8",
    "PhoneNumber": "sample string 9",
    "DocumentNumberCheck": "sample string 10",
    "physicalLocation": {
      "countryCode": "sample string 1",
      "state": "sample string 2",
      "city": "sample string 3",
      "postalZone": "sample string 4",
      "address": "sample string 5"
    },
    "active": true
  },
  "total": 1.0,
  "subtotal": 1.0,
  "taxTotal": 1.0,
  "ivaTotal": 1.0,
  "isXmlGenerated": true,
  "xmlGenerationDate": "2024-04-28T14:29:54.6152881-05:00",
  "xmlSendingDate": "2024-04-28T14:29:54.6152881-05:00",
  "isPdfGenerated": true,
  "pdfGenerationDate": "2024-04-28T14:29:54.6152881-05:00",
  "pdfSendingDate": "2024-04-28T14:29:54.6152881-05:00",
  "isAcceptedByTheClient": true,
  "clientStatus": "sample string 10",
  "dianRejectedCauseCode": "sample string 11",
  "dianRejectedCauseName": "sample string 12",
  "clientReasons": "sample string 13",
  "dianStatus": "sample string 14",
  "dianReasons": "sample string 15",
  "isContingency": true,
  "documentManagementDate": "2024-04-28T14:29:54.6152881-05:00",
  "isAutoApproved": true,
  "acquirerStatusDate": "2024-04-28T14:29:54.6152881-05:00",
  "dianVerificationDate": "2024-04-28T14:29:54.6152881-05:00",
  "acquirerSendingDate": "2024-04-28T14:29:54.6152881-05:00",
  "note": "sample string 17"
}

application/xml, text/xml

Sample: 
<StatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIRestUBL21.Models">
  <acquirer>
    <active>true</active>
    <address>sample string 5</address>
    <contacts>
      <Contact>
        <active>true</active>
        <address>sample string 5</address>
        <cellphoneNumber>sample string 7</cellphoneNumber>
        <contract>sample string 9</contract>
        <documentNumber>sample string 2</documentNumber>
        <documentTypeCode>sample string 1</documentTypeCode>
        <email>sample string 3</email>
        <fullName>sample string 4</fullName>
        <phoneNumber>sample string 6</phoneNumber>
        <position>sample string 10</position>
        <sendInvoice>true</sendInvoice>
      </Contact>
      <Contact>
        <active>true</active>
        <address>sample string 5</address>
        <cellphoneNumber>sample string 7</cellphoneNumber>
        <contract>sample string 9</contract>
        <documentNumber>sample string 2</documentNumber>
        <documentTypeCode>sample string 1</documentTypeCode>
        <email>sample string 3</email>
        <fullName>sample string 4</fullName>
        <phoneNumber>sample string 6</phoneNumber>
        <position>sample string 10</position>
        <sendInvoice>true</sendInvoice>
      </Contact>
    </contacts>
    <documentNumber>sample string 2</documentNumber>
    <documentTypeCode>sample string 1</documentTypeCode>
    <fiscalLocation>
      <address>sample string 5</address>
      <city>sample string 3</city>
      <countryCode>sample string 1</countryCode>
      <postalZone>sample string 4</postalZone>
      <state>sample string 2</state>
    </fiscalLocation>
    <fiscalResponsabilities xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </fiscalResponsabilities>
    <juridicalOrganizationCode>sample string 8</juridicalOrganizationCode>
    <merchantRegisters>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
      <MerchantRegister>
        <active>true</active>
        <cityCode>sample string 2</cityCode>
        <departmentCode>sample string 3</departmentCode>
        <value>sample string 1</value>
      </MerchantRegister>
    </merchantRegisters>
    <name>sample string 4</name>
    <physicalLocation>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
      <Location>
        <address>sample string 5</address>
        <city>sample string 3</city>
        <countryCode>sample string 1</countryCode>
        <postalZone>sample string 4</postalZone>
        <state>sample string 2</state>
      </Location>
    </physicalLocation>
    <regimenTypeCode>sample string 9</regimenTypeCode>
    <technologicalProviderNIT>sample string 7</technologicalProviderNIT>
    <telephone>sample string 6</telephone>
    <tributaryDetail>sample string 10</tributaryDetail>
    <verificationDigit>sample string 3</verificationDigit>
  </acquirer>
  <acquirerSendingDate>2024-04-28T14:29:54.6152881-05:00</acquirerSendingDate>
  <acquirerStatusDate>2024-04-28T14:29:54.6152881-05:00</acquirerStatusDate>
  <clientReasons>sample string 13</clientReasons>
  <clientStatus>sample string 10</clientStatus>
  <cufe>sample string 2</cufe>
  <dianReasons>sample string 15</dianReasons>
  <dianRejectedCauseCode>sample string 11</dianRejectedCauseCode>
  <dianRejectedCauseName>sample string 12</dianRejectedCauseName>
  <dianStatus>sample string 14</dianStatus>
  <dianVerificationDate>2024-04-28T14:29:54.6152881-05:00</dianVerificationDate>
  <documentManagementDate>2024-04-28T14:29:54.6152881-05:00</documentManagementDate>
  <fileTypeCodeId>1</fileTypeCodeId>
  <isAcceptedByTheClient>true</isAcceptedByTheClient>
  <isAutoApproved>true</isAutoApproved>
  <isContingency>true</isContingency>
  <isPdfGenerated>true</isPdfGenerated>
  <isXmlGenerated>true</isXmlGenerated>
  <issueDate>2024-04-28T14:29:54.5996775-05:00</issueDate>
  <ivaTotal>1</ivaTotal>
  <note>sample string 17</note>
  <number>sample string 4</number>
  <pdfGenerationDate>2024-04-28T14:29:54.6152881-05:00</pdfGenerationDate>
  <pdfSendingDate>2024-04-28T14:29:54.6152881-05:00</pdfSendingDate>
  <prefix>sample string 3</prefix>
  <relatedDocumentNumber>sample string 6</relatedDocumentNumber>
  <relatedDocumentPrefix>sample string 5</relatedDocumentPrefix>
  <subtotal>1</subtotal>
  <supplier>
    <DocumentNumberCheck>sample string 10</DocumentNumberCheck>
    <Email>sample string 8</Email>
    <PhoneNumber>sample string 9</PhoneNumber>
    <active>true</active>
    <code>sample string 4</code>
    <documentNumber>sample string 2</documentNumber>
    <documentTypeCode>sample string 3</documentTypeCode>
    <fiscalLocation>
      <address>sample string 5</address>
      <city>sample string 3</city>
      <countryCode>sample string 1</countryCode>
      <postalZone>sample string 4</postalZone>
      <state>sample string 2</state>
    </fiscalLocation>
    <fullName>sample string 1</fullName>
    <juridicalOrganizationCode>sample string 5</juridicalOrganizationCode>
    <physicalLocation>
      <address>sample string 5</address>
      <city>sample string 3</city>
      <countryCode>sample string 1</countryCode>
      <postalZone>sample string 4</postalZone>
      <state>sample string 2</state>
    </physicalLocation>
    <regimenTypeCode>sample string 6</regimenTypeCode>
    <tributaryDetail>sample string 7</tributaryDetail>
    <users>
      <SupplierUser>
        <Email>sample string 2</Email>
        <FullName>sample string 1</FullName>
        <PhoneNumber>sample string 3</PhoneNumber>
      </SupplierUser>
      <SupplierUser>
        <Email>sample string 2</Email>
        <FullName>sample string 1</FullName>
        <PhoneNumber>sample string 3</PhoneNumber>
      </SupplierUser>
    </users>
  </supplier>
  <taxTotal>1</taxTotal>
  <total>1</total>
  <xmlGenerationDate>2024-04-28T14:29:54.6152881-05:00</xmlGenerationDate>
  <xmlSendingDate>2024-04-28T14:29:54.6152881-05:00</xmlSendingDate>
</StatusResponse>