Documentación API FacturasWeb

Descargar como pdf o txt
Descargar como pdf o txt
Está en la página 1de 34

2018

DOCUMENTO DE
ESPECIFICACIÓN API
FACTURAS WEB

INTEGRACIÓN VÍA API


VERSIÓN 1.0

FACTURAS WEB | https://facturasweb.co


DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Contenido
MANUAL DE IMPLENTACIÓN API ........................................................................................................... 3
MÉTODOS .............................................................................................................................................. 3
1. Login........................................................................................................................................... 3
Request .......................................................................................................................................... 3
Parámetros .................................................................................................................................... 3
Response ........................................................................................................................................ 3
2. Insertar Factura.......................................................................................................................... 3
Request .......................................................................................................................................... 3
Parámetros .................................................................................................................................... 4
Response ........................................................................................................................................ 4
Ejemplos......................................................................................................................................... 5
3. Insertar Nota Débito .................................................................................................................. 7
Request .......................................................................................................................................... 7
Parámetros .................................................................................................................................... 7
Response ........................................................................................................................................ 8
Ejemplos......................................................................................................................................... 8
4. Insertar Nota Crédito ................................................................................................................. 9
Request .......................................................................................................................................... 9
Parámetros .................................................................................................................................. 10
Response ...................................................................................................................................... 10
Ejemplos....................................................................................................................................... 11
5. Obtener estado de un documento .......................................................................................... 12
Request ........................................................................................................................................ 12
Parámetros .................................................................................................................................. 12
Response ...................................................................................................................................... 12
Ejemplos....................................................................................................................................... 13
6. Insertar adjunto ....................................................................................................................... 13

1
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Request ........................................................................................................................................ 13
Parámetros .................................................................................................................................. 13
Response ...................................................................................................................................... 13
Ejemplos....................................................................................................................................... 14
7. Obtener XML del documento .................................................................................................. 15
Request ........................................................................................................................................ 15
Parámetros .................................................................................................................................. 15
Response ...................................................................................................................................... 15
Ejemplos....................................................................................................................................... 16
8. Obtener Dummy JSON (Factura) ............................................................................................. 22
Request ........................................................................................................................................ 23
Parámetros .................................................................................................................................. 23
Response ...................................................................................................................................... 23
Ejemplos....................................................................................................................................... 23
9. Diccionario de campos ............................................................................................................. 25
Insertar Factura............................................................................................................................ 25
Insertar Nota Crédito ................................................................................................................... 28
Insertar Nota Débito .................................................................................................................... 29
Obtener estado de documento ................................................................................................... 30
Obtener XML del documento ...................................................................................................... 30
Obtener Dummy factura .............................................................................................................. 31
10. Listados de códigos .............................................................................................................. 31

2
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

MANUAL DE IMPLENTACIÓN API

El presente documento describe los métodos de integración via API con el sistema de FacturasWeb
para emitir facturación electrónica con la DIAN.

MÉTODOS

1. Login

Permite al usuario obtener un token de autenticación que tiene una vigencia de 24 horas y se
utilizará para todas las consultas posteriores.

Request
Método URL
POST https://facturaswebapi.azurewebsites.net/api/web/factura/Login

Parámetros
Tipo Nombre Valores
POST username string
POST password string

Response
Status Response
200 “token”
400 “Unauthorized”

2. Insertar Factura

Ingresa una prefactura en la plataforma.

Request
Método URL
POST https://facturaswebapi.azurewebsites.net/api/web/factura/Insertar/{token}/{SchemaId}/{IdNumber}/{TemplateId}

3
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM schemaId string
URL_PARAM IdNumber String
URL_PARAM TemplateId String
BODY Model Json(invoice)
REQUEST FILE Attachment File (Optional)

Response
Status Response
200 “DocumentId”
400 “El número de factura ya existe”
400 “Error en el servidor remoto: (401) No autorizado.”
400 {"error":" El tipo de documento del cliente es obligatorio”}
400 {"error":" El tipo de documento del cliente debe ser numérico”}
400 {"error":"El número de identificación del cliente es obligatorio”}
400 {"error":"El tipo de régimen tributario del cliente es obligatorio”}
400 {"error":"El tipo de régimen tributario del cliente debe ser numérico”}
400 {"error":"El tipo de persona asociado al cliente es obligatorio”}
400 {"error":"El tipo de persona asociado al cliente debe ser numérico”}
400 {"error":"La razón social del cliente es obligatoria si el tipo de persona es ‘Jurídica’”}
400 {"error":"El primer nombre del cliente es obligatorio si el tipo de persona es ‘Natural’”}
400 {"error":"El primer apellido del cliente es obligatorio si el tipo de persona es ‘Natural’”}
400 {"error":"El primer apellido del cliente es obligatorio si el tipo de persona es ‘Natural’”}
400 {"error":"La ciudad del cliente es obligatoria”}
400 {"error":"El código de la ciudad debe ser numérico”}
400 {"error":"La dirección del cliente es obligatoria”}
400 {"error":"El teléfono del cliente debe ser numérico”}
400 {"error":"El número de resolución es obligatorio”}
400 {"error":" - El número de prefactura (ID generado por el software del Emisor) es
obligatorio”}
400 {"error":"El número de días de vencimiento de la factura debe ser numérico”}
400 {"error":"El código del prod/serv es obligatorio”}
400 {"error":"El nombre del prod/serv es obligatorio”}
400 {"error":"El precio unitario del prod/serv con código <<código>> debe ser obligatorio”}
400 {"error":" El precio unitario del prod/serv con código <<código>> debe ser numérico”}
400 {"error":" El valor total de la línea del prod/serv con código <<código>> debe ser
obligatorio”}

4
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

400 {"error":"El valor total de la línea del prod/serv con código <<código>> debe ser
numérico”}
400 {"error":"El campo "clase Impuesto" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados”}
400 {"error":"El campo "Tipo" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados”}
400 {"error":"El campo "Porcentaje" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados”}
400 {"error":"El porcentaje del impuesto/retención debe ser numérico”}
Status Response
200 “DocumentId”
400 “El número de factura ya existe”
400 “Error en el servidor remoto: (401) No autorizado.”

Token
Token de autenticación (Revisar Login).

Model
Corresponde al JSON de la factura a insertar.

SchemaID
Tipo de documento de la empresa sobre la cual se va a realizar el procedimiento

IDNumber
Numero de documento de la empresa sobre la cual se va a realizar el procedimiento

TemplateID
Código del tipo de plantilla que contendrá la factura. Si no se entrega este parámetro, el sistema
entenderá que es una plantilla genérica.

Attachment
Documento adjunto

IMPORTANTE: en caso de no conocer la estructura Json de la plantilla a utilizar, cosulte el método


“Get Dummy Invoice” para obtener dicha estructura.

Ejemplos
Tipo Ejemplo
Request {
"Customer_Information": {
"IdentificationType": 13,
"Identification": 1235,
"DV": 0,
"PartyTaxLevelCode": 2,
"PersonTypeID": 1,

5
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

"RegistrationName": "Prueba API",


"PersonFirstName": null,
"PersonMiddleName": null,
"PersonFamilyName": null,
"PersonFamilyName2": null,
"CityID": 12688,
"AddressLine": "Calle 45",
"Telephone": 3655555,
"Email": "andres_vargasapi@mail.com",
"WebSiteURI":"www.api.com"
},
"Authorization_Information": {
"InvoiceAuthorizationNumber": 2154878788,
"PreinvoiceNumber": 548848487,
"DaysOff": 30
},
"Item_Information": [
{
"ItemCode": 45551,
"Name": "Pantalla",
"Quantity": 1,
"Price": 3500,
"Amount": 3500,
"MeasureUnitCode": null,
"AdditionalItemPropertyList": null
"TaxesInformation": [
{
"Id": 1,
"TaxEvidenceIndicator": false,
"Percent": 19,
"TaxableAmount": 100,
"TaxAmount": 1000
}
],
}
],
"TaxesInformation": [
{
"Id": 0,
"TaxEvidenceIndicator": false,
"Percent": 0,
"TaxableAmount": 0,
"TaxAmount": 0
}
],
"Payment_Summary": {
"PaymentTypeID": 10,
"PaymentMethodNote": "Nada en especial",
"CurrencyCode": "COP"
},
"Payment_Information": {
"LineExtensionAmount": 3500,
"TaxExclusiveAmount": 3500,
"PayableAmount": 3500

6
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

},
"Invoice_Note": {
"Note": null
}
}
Response {
"DocumentId": <Document_id>
}

3. Insertar Nota Débito

Ingresa una nota débito en la plataforma.

Request
Método URL
POST https://facturaswebapi.azurewebsites.net/api/web/notas/Debito/Insertar/{token}/{SchemaId}/{IdNumber}

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM schemaId string
URL_PARAM IdNumber String
BODY Model Json(debit note)
REQUEST FILE Attachment File (Optional)

Token
Token de autenticación (Revisar Login).

Model
Corresponde al JSON de la factura a insertar.

SchemaID
Tipo de documento de la empresa sobre la cual se va a realizar el procedimiento

IDNumber
Numero de documento de la empresa sobre la cual se va a realizar el procedimiento

Attachment
Documento adjunto

7
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Response
Status Response
200 “DocumentId”
400 “Error en el servidor remoto: (401) No autorizado.”
400 {"error":"El CUFE asociado a la factura es obligatorio"}
400 {"error":"El número de nota es obligatorio"}
400 {"error":"El concepto de nota es obligatorio"}
400 {"error":"El concepto de la nota debe ser numérico"}
400 {"error":"El porcentaje de intereses debe ser numérico"}
400 {"error":"El precio unitario real debe ser numérico"}
400 {"error":"El precio unitario real debe ser numérico"}
400 {"error":"El valor de la línea debe ser numérico"}
400 {"error":"El campo "clase Impuesto" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El CUFE asociado a la factura es obligatorio"}

400 {"error":"El campo "Tipo" debe ser diligenciado si otros campos del Impuesto/Retención
han sido diligenciados"}
400 {"error":"El campo "Porcentaje" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El porcentaje del impuesto/retención debe ser numérico"}
400 {"error":"El campo "Valor Gravable" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El valor gravable del impuesto/retención debe ser numérico"}
400 {"error":"El campo "Valor Impuesto/Retención" debe ser diligenciado si otros campos
del Impuesto/Retención han sido diligenciados"}
400 {"error":"El valor del impuesto/retención debe ser numérico"}
400 {"error":"El subtotal de la nota es obligatorio"}
400 {"error":"El subtotal de la nota debe ser numérico"}
400 {"error":"El total de los impuestos es obligatorio"}
400 {"error":"El total de los impuestos debe ser numérico"}
400 {"error":"El total de la nota es obligatorio"}
400 {"error":"El total de la nota debe ser numérico"}
400 {"error":"La razón de la creación de la nota es obligatoria"}
500 {"error":"Lo sentimos se ha presentado un problema."}

Ejemplos
Tipo Ejemplo
Request {
"Invoice_Information": {
"Cufe": “1b306235a2582c86660a0f38121439dfb73d6a12”

8
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

},
"Note_Information": {
"Id": 21458,
"ResponseCode":4,
"Discount": 0,
"Interest": 0
},
"Item_Information": [
{
"ItemCode": 21848,
"QuantityBack": 0,
"Price": 3200,
"Amount": 3200
}
],
"Taxes_Information": [
{
"Id": 0,
"TaxEvidenceIndicator": false,
"Percent": 0,
"TaxableAmount": 0,
"TaxAmount": 0
}
],
"Payment_Summary": {
"LineExtensionAmount": 0,
"TaxExclusiveAmount": 0,
"PayableAmount": 0
},
"Note_Concept": {
"Note": null
}
}
Response {
"DocumentId": <Document_id>
}

4. Insertar Nota Crédito

Ingresa una nota crédito en la plataforma.

Request
Método URL
POST https://facturaswebapi.azurewebsites.net/api/web/notas/Credito/Insertar/{token}/{SchemaId}/{Id
Number}

9
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM schemaId string
URL_PARAM IdNumber String
BODY Model Json(credit note)
REQUEST FILE Attachment File (Optional)

Token
Token de autenticación (Revisar Login).

Model
Corresponde al JSON de la factura a insertar.

SchemaID
Tipo de documento de la empresa sobre la cual se va a realizar el procedimiento

IDNumber
Numero de documento de la empresa sobre la cual se va a realizar el procedimiento

Attachment
Documento adjunto

Response
Status Response
200 “DocumentId”
400 “Error en el servidor remoto: (401) No autorizado.”
400 {"error":"El CUFE asociado a la factura es obligatorio"}
400 {"error":"El número de nota es obligatorio"}
400 {"error":"El concepto de nota es obligatorio"}
400 {"error":"El concepto de la nota debe ser numérico"}
400 {"error":"El porcentaje de intereses debe ser numérico"}
400 {"error":"El precio unitario real debe ser numérico"}
400 {"error":"El precio unitario real debe ser numérico"}
400 {"error":"El valor de la línea debe ser numérico"}
400 {"error":"El campo "clase Impuesto" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El CUFE asociado a la factura es obligatorio"}

400 {"error":"El campo "Tipo" debe ser diligenciado si otros campos del Impuesto/Retención
han sido diligenciados"}

10
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

400 {"error":"El campo "Porcentaje" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El porcentaje del impuesto/retención debe ser numérico"}
400 {"error":"El campo "Valor Gravable" debe ser diligenciado si otros campos del
Impuesto/Retención han sido diligenciados"}
400 {"error":"El valor gravable del impuesto/retención debe ser numérico"}
400 {"error":"El campo "Valor Impuesto/Retención" debe ser diligenciado si otros campos
del Impuesto/Retención han sido diligenciados"}
400 {"error":"El valor del impuesto/retención debe ser numérico"}
400 {"error":"El subtotal de la nota es obligatorio"}
400 {"error":"El subtotal de la nota debe ser numérico"}
400 {"error":"El total de los impuestos es obligatorio"}
400 {"error":"El total de los impuestos debe ser numérico"}
400 {"error":"El total de la nota es obligatorio"}
400 {"error":"El total de la nota debe ser numérico"}
400 {"error":"La razón de la creación de la nota es obligatoria"}
500 {"error":"Lo sentimos se ha presentado un problema."}

Ejemplos
Tipo Ejemplo
Request
{
"Invoice_Information": {
"Cufe": "1b306235a2582c86660a0f38121439dfb73d6a12"
},
"Note_Information": {
"Id": 21458,
"ResponseCode": 4,
"Discount": 0,
"Interest": 0
},
"Item_Information": [
{
"ItemCode": 21848,
"QuantityBack": 0,
"Price": 3200,
"Amount": 3200
}
],
"Taxes_Information": [
{
"Id": 0,
"TaxEvidenceIndicator": false,
"Percent": 0,
"TaxableAmount": 0,
"TaxAmount": 0
}

11
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

],
"Payment_Summary": {
"LineExtensionAmount": 3200,
"TaxExclusiveAmount": 3200,
"PayableAmount": 3200
},
"Note_Concept": {
"Note": "Para pagar en otro lado"
}
}
Response {
"DocumentId": <Document_id>
}

5. Obtener estado de un documento

Obtiene la información del estado de un documento electrónico (factura o nota)

Request
Método URL
GET https://facturaswebapi.azurewebsites.net/api/web/factura/ConsultarDocumento/{token}/{documen
tId}/{documentType}

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM documentId String
URL_PARAM documentType String

Response
Status Response
200 “Document info”
400 “Unauthorized”
400 {"error":" El número de identificación del documento electrónico es obligatorio
"}
400 {"error":" El tipo de documento electrónico es obligatorio"}
400 {"error":" El tipo de documento electrónico debe ser numérico"}
500 {"error":"Lo sentimos se ha presentado un problema."}

12
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Ejemplos
Tipo Ejemplo
Request {
"DocumentId":15564,
"DocumentType":1
}
Response {
"DocumentStatus": Emitido,
"StatusDate": 2017/01/01 – 13:57:50,
"CUFE": ed296ca29ce9e886b2b6b3f2d6ea189eca1ebba1 <<este campo se entregará en el
response cuando se trate de una Factura que esté emitida>>,
"InvoiceNumber": 5566 <<este campo se entregará cuando se trate de una factura que esté
emitida>>,
"NoteNumber": NC123 <<este campo se entregará cuando se trate de una Nota>>,
"CustomerParty": Almacenes Éxito,
"CustomerPartyID": NIT - 880956889,
"PayableAmount": 300.000,
}

6. Insertar adjunto

Inserta un adjunto o una representación gráfica de una factura

Request
Método URL
POST https://facturaswebapi.azurewebsites.net/api/web/factura/InsertarAdjunto/{token}/{SchemaId}/{Id
Number}/{DocumentUUID}

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM SchemaId String
URL_PARAM IDNumber String
URL_PARAM DocumentUUID String
BODY Model JSON (attachments)

Response
Status Response
200 “ok”
400 “Unauthorized”
500 {"error":"Lo sentimos se ha presentado un problema."}

13
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Token
Token de autenticación (Revisar Login).

SchemaID
Tipo de documento de la empresa sobre la cual se va a realizar el procedimiento

IDNumber
Número de documento de la empresa sobre la cual se va a realizar el procedimiento

DocumentUUID
Identificación del documento electrónico.

Ejemplos
Tipo Ejemplo
Request {
“Attach”: [
{
“FileName”: “FactuasApi123.TXT”,
“TypeFile”: “10”
},
{
“FileName”: “FactuasApi123.TXT”,
“TypeFile”: “3”
},
{
“FileName”: “FactuasApi123.TXT”,
“TypeFile”: “2”
},
{
“FileName”: “FactuasApi123.TXT”,
“TypeFile”: “7”
},
{
“FileName”: “FactuasApi123.TXT”,
“TypeFile”: “1”
}
]
}

Type Descripción Extensión


File
1 Documento PDF .pdf
2 Representación Grafica .pdf
3 Documento de Imagen JPG .jpg
4 Documento de Imagen PNG .png
5 Documento compreso ZIP .zip
6 Documento compreso RAR .rar
7 Documento de Excel XLSX .xlsx

14
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

8 Documento de Excel XLS .xls


9 Documento de Excel CSV .csv
10 Documento de Texto TXT .txt
11 Documento de Word DOCX .docx
12 Documento estructura XML .xml
14 Documento estructura JSON .json

7. Obtener XML del documento

Obtiene la información del documento en formato XML

Request
Método URL
GET https://facturaswebapi.azurewebsites.net/api/web/factura/ObtenerDocumento/{token}/{SchemaId}
/{IDNumber}/{documentId}/{documentType}

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM SchemaId String
URL_PARAM IDNumber String
URL_PARAM documentId String
URL_PARAM documentType String

Response
Status Response
200 “Document info”
400 “Unauthorized”
400 {"error":" Debe suministrar el tipo de identificación de la compañía”}
400 {"error":" El tipo de identificación de la compañía es inválido. Los tipos de documento
disponibles son: Registro Civil(11), Tarjeta de Identidad(12), Cédula Ciudadanía(13),
Tarjeta Extranjería(21), Cédula Extranjería(22), NIT(31), Pasaporte(41), Documento
Identificación Extranjero(42)”}
400 {"error":" Debe suministrar el número de identificación de la compañía”}
400 {"error":"El tipo de documento suministrado es inválido. Los tipos de documento
disponibles son: Factura(1), Nota Crédito(2), Nota Débito(3)”}
400 {"error":"Debe suministrar el identificador único de documento”}
400 {"error":"El identificador único de documento debe ser un GUID válido”}

15
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

400 {"error":" <<factura, nota débito o nota crédito>> <<Documentid>> no existe.”}


400 {"error":"No se encontró XML asociado a <<factura, nota débito o nota crédito>>
<<Documentid>>”}
500 {"error":"Lo sentimos se ha presentado un problema."}

Token
Token de autenticación (Revisar Login).

SchemaID
Tipo de documento de la empresa sobre la cual se va a realizar el procedimiento

IDNumber
Número de documento de la empresa sobre la cual se va a realizar el procedimiento

DocumentType
Tipo de documento electrónico (Factura, Nota Crédito o Nota Débito) del cual se quiere obtener el
XML.

DocumentID
Identificación del documento electrónico del cual se quiere obtener el XML.

Ejemplos
Tipo Ejemplo
Reque {
"DocumentId":15564,
st
"DocumentType":1
}
Respo {
nse "XMLresult": “<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fe:Invoice xmlns:fe="http://www.dian.gov.co/contratos/facturaelectronica/v1"
xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
xmlns:clm54217="urn:un:unece:uncefact:codelist:specification:54217:2001"
xmlns:clm66411="urn:un:unece:uncefact:codelist:specification:66411:2001"
xmlns:clmIANAMIMEMediaType="urn:un:unece:uncefact:codelist:specification:IANAMIMEMediaType:2003"
xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2"
xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2"
xmlns:sts="http://www.dian.gov.co/contratos/facturaelectronica/v1/Structures"
xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.dian.gov.co/contratos/facturaelectronica/v1 ../xsd/DIAN_UBL.xsd
urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2
../../ubl2/common/UnqualifiedDataTypeSchemaModule-2.0.xsd
urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2 ../../ubl2/common/UBL-
QualifiedDatatypes-2.0.xsd">

16
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

<ext:UBLExtensions>
<ext:UBLExtension>
<ext:ExtensionContent>
<sts:DianExtensions>
<sts:InvoiceControl>
<sts:InvoiceAuthorization>469910</sts:InvoiceAuthorization>
<sts:AuthorizationPeriod>
<cbc:StartDate>2013-12-15</cbc:StartDate>
<cbc:EndDate>2015-12-15</cbc:EndDate>
</sts:AuthorizationPeriod>
<sts:AuthorizedInvoices>
<sts:Prefix>459</sts:Prefix>
<sts:From>10280906</sts:From>
<sts:To>19999999</sts:To>
</sts:AuthorizedInvoices>
</sts:InvoiceControl>
<sts:InvoiceSource>
<cbc:IdentificationCode listAgencyID="6" listAgencyName="United Nations Economic Commission for
Europe" listSchemeURI="urn:oasis:names:specification:ubl:codelist:gc:CountryIdentificationCode-
2.0">CO</cbc:IdentificationCode>
</sts:InvoiceSource>
<sts:SoftwareProvider>
<sts:ProviderID schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de Impuestos y Aduanas
Nacionales)">700085371</sts:ProviderID>
<sts:SoftwareID schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de Impuestos y
Aduanas Nacionales)">f79992f5-983e-40d0-8049-094f081211da</sts:SoftwareID>
</sts:SoftwareProvider>
<sts:SoftwareSecurityCode schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de
Impuestos y Aduanas
Nacionales)">8295dcd6334a8d64d8495efdfddaaa1237020e6e0be5a4c3356c9502b4bc88740e2661a899ddff
5b5a3b0350a98e5d36</sts:SoftwareSecurityCode>
</sts:DianExtensions>
</ext:ExtensionContent>
</ext:UBLExtension>
<ext:UBLExtension>
<ext:ExtensionContent>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Id="xmldsig-e7b5d982-29c7-4169-a97e-
526173f354ef">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
<ds:Reference Id="xmldsig-e7b5d982-29c7-4169-a97e-526173f354ef-ref0" URI="">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>rYj33os8GzcfvFntClVf0caUYHc=</ds:DigestValue>
</ds:Reference>
<ds:Reference URI="#xmldsig-87d128b5-aa31-4f0b-8e45-3d9cfa0eec26-keyinfo">
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>0iE/FGZgLfbnV9DhUaDBBVPjn44=</ds:DigestValue>
</ds:Reference>

17
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

<ds:Reference Type="http://uri.etsi.org/01903#SignedProperties" URI="#xmldsig-e7b5d982-29c7-4169-


a97e-526173f354ef-signedprops">
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>e8gxYZKNKVmcwlOqMXD1CGczdVo=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue Id="xmldsig-e7b5d982-29c7-4169-a97e-526173f354ef-sigvalue">
R6yO9YoAtEbnots6kbvR85bxZOCocUKVG97KJ+jRbMFEfxEdb3lG8jx6c2NnRCXxoL9B8cnCg2Vq
H4FpXVthHXtYvDZGUIm3GmrwLZHD4MT2d6ktNHvyVNkKAg6JmwJ1UbC8SItWsDyeB3bOX/yEYEFy
CsF730iW7acPEofVZbDMOV01oZ6dK4iIqf30DztxXMNu/Z2RWPcu6OLdo9jJzaGqMZxLK8DmCnaw
w2kBujXZflagoS1irgKXftK/5+yiAe2YcV640B6YyAJiAyeKrYIFRvW91jyZYhdZPnnD9THGptis
ir7d8XLhr0MViIzUf1fLPdjyfldFbAz7sOVPLg==
</ds:SignatureValue>
<ds:KeyInfo Id="xmldsig-87d128b5-aa31-4f0b-8e45-3d9cfa0eec26-keyinfo">
<ds:X509Data>
<ds:X509Certificate>
MIIILDCCBhSgAwIBAgIIfq9P6xyRMBEwDQYJKoZIhvcNAQELBQAwgbQxIzAhBgkqhkiG9w0BCQEW
FGluZm9AYW5kZXNzY2QuY29tLmNvMSMwIQYDVQQDExpDQSBBTkRFUyBTQ0QgUy5BLiBDbGFzZSBJ
STEwMC4GA1UECxMnRGl2aXNpb24gZGUgY2VydGlmaWNhY2lvbiBlbnRpZGFkIGZpbmFsMRMwEQYD
VQQKEwpBbmRlcyBTQ0QuMRQwEgYDVQQHEwtCb2dvdGEgRC5DLjELMAkGA1UEBhMCQ08wHhcNMTMw
NDE2MjIyMzUwWhcNMTYwODEzMjIyMzUwWjCCASQxHTAbBgNVBAkTFENhbGxlIEZhbHNhIE5vIDEy
IDM0MT0wOwYJKoZIhvcNAQkBFi5wZXJzb25hX25hdHVyYWxfcHJ1ZWJhc0BlbXByZXNhcGFyYXBy
dWViYXMuY29tMRswGQYDVQQDExJVc3VhcmlvIGRlIFBydWViYXMxETAPBgNVBAUTCDExMTExMTEx
MV0wWwYDVQQLE1RDZXJ0aWZpY2FkbyBQZXJzb25hIG5hdHVyYWwgRW1pdGlkbyBwb3IgQW5kZXMg
U0NEIEF2LiBDYXJyZXJhIDQ1IE5vIDEwMyAtIDM0IE9GLiAyMDUxFDASBgNVBAcTC0J1Y2FyYW1h
bmdhMRIwEAYDVQQIEwlTYW50YW5kZXIxCzAJBgNVBAYTAkNPMIIBIjANBgkqhkiG9w0BAQEFAAOC
AQ8AMIIBCgKCAQEAuVkIDKtLVyEQhVGvaaJZXq6YU1yLC0VQEptM7mUfwR849CW+pGeFsWlkvaNJ
PiKZHajDrd2EWs7LMowLkBMhS0vwV9cH7G65GcLbvs5pc7ZtUt5Fq7vTmk0RXp1fjh+mbKkR/SdG
a/fYxf8zVYhYSUbYNfFwvN5ZzAkj+V1GflpPostK8CkR5jMdRdNPkQQpCUMwV9M3FvZiLWBKHXQi
kYm5Ed3suR2a6G8nWTosu8zbRLVXlmBG81tGL2oBemMfePMU3thNHVn2T9vNp1tJPwyB9+npU0qe
4kZvyu3/xMB1a28ZgZ7fDNYhuDQ6/DYdCoBVFbrvWCAuVSJcC+RpEQIDAQABo4ICzTCCAskwHQYD
VR0OBBYEFAaSNjJJPImFjE/cyw4JVdqO+VcRMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUqEu0
9AuntlvUoCiFEJ0EEzPEp/cwggHFBgNVHSAEggG8MIIBuDCCAbQGDSsGAQQBgfRIAQIBAQIwggGh
MIIBWgYIKwYBBQUHAgIwggFMHoIBSABMAGEAIAB1AHQAaQBsAGkAegBhAGMAaQDzAG4AIABkAGUA
IABlAHMAdABlACAAYwBlAHIAdABpAGYAaQBjAGEAZABvACAAZQBzAHQAYQAgAHMAdQBqAGUAdABh
ACAAYQAgAGwAYQBzACAAUABvAGwA7QB0AGkAYwBhAHMAIABkAGUAIABDAGUAcgB0AGkAZgBpAGMA
YQBkAG8AIABkAGUAIABQAGUAcgBzAG8AbgBhACAATgBhAHQAdQByAGEAbAAgACgAUABDACkAIAB5
ACAAUAByAOEAYwB0AGkAYwBhAHMAIABkAGUAIABDAGUAcgB0AGkAZgBpAGMAYQBjAGkA8wBuACAA
KABEAFAAQwApACAAZQBzAHQAYQBiAGwAZQBjAGkAZABhAHMAIABwAG8AcgAgAEEAbgBkAGUAcwAg
AFMAQwBEAC4wQQYIKwYBBQUHAgEWNWh0dHA6Ly93d3cuYW5kZXNzY2QuY29tLmNvL2RvY3MvRFBD
X0FuZGVzU0NEX1YxLjQucGRmMEYGA1UdHwQ/MD0wO6A5oDeGNWh0dHA6Ly93d3cuYW5kZXNzY2Qu
Y29tLmNvL2luY2x1ZGVzL2dldENlcnQucGhwP2NybD0xMA4GA1UdDwEB/wQEAwIF4DAdBgNVHSUE
FjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwOQYDVR0RBDIwMIEucGVyc29uYV9uYXR1cmFsX3BydWVi
YXNAZW1wcmVzYXBhcmFwcnVlYmFzLmNvbTANBgkqhkiG9w0BAQsFAAOCAgEAwvPxwHKtiywYT/BU
X2Anq3fzwD57ooMPewnSQXJs1pSuVbJSjmakdjKmJngwpaSx6z+LOB4PniP4BRdygxA3RSuFtlQo
RbYv8FqMvoUzHJLPO+DH6SZklDyMcanFiAPuMGSvjMZVfeLjH+2Ut1/iM/kipRnevNDqVxjj9xZs
rOoSWSuOv+r5pQE4A3G74lZD30iHS702g0ylNjgVNhdCnolHeoli6qYWBTORV9yIIzSml9ALkSeN
Sg92tSF+GDdquIfiI1U2q5iuD7jnrGF5mgaF/D9iznDPyCXCrBsjbIV8wnqPKUWqas3llg2onb0A
Ly8G7dROHgKjwlYHgVz0ohnovOowFL/Zi73imEOULeVd+KxjH7MfSd1IQlQ6qI2GhUPdSya6k9cf
0VJyC1cFkfQCZWNNTh5HRSiDO+3Pd0EnOILdQsi2cayR3GQ7RGIqTnIHcEnfTL7VWEEGxizN4nah
TMa4yuGxguREw7nTcNGHI/M2uW1Ko5PvcGevSATDwyxK2FPB9ARw0wFXz7uQ9seadcfKJNFMBNwi
dLSPjkTTh1G72wJRfU+1GBSBB826QyLGkXmqraO8NmYEztG/wEk2ISI17ozcbKUGW+0NixajqHAs

18
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

iDL9ealTnOxdr+HhkzOSpuZM/deICh40N5fwEt6ZDCeNb/Eji41SRaTqlCI=
</ds:X509Certificate>
</ds:X509Data>
</ds:KeyInfo>
<ds:Object>
<xades:QualifyingProperties xmlns:xades="http://uri.etsi.org/01903/v1.3.2#"
xmlns:xades141="http://uri.etsi.org/01903/v1.4.1#" Target="#xmldsig-e7b5d982-29c7-4169-a97e-
526173f354ef">
<xades:SignedProperties Id="xmldsig-e7b5d982-29c7-4169-a97e-526173f354ef-signedprops">
<xades:SignedSignatureProperties>
<xades:SigningTime>2015-07-20T22:34:26.229-05:00</xades:SigningTime>
<xades:SigningCertificate>
<xades:Cert>
<xades:CertDigest>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>2el6MfWvYsvEaa/TV513a7tVK0g=</ds:DigestValue>
</xades:CertDigest>
<xades:IssuerSerial>
<ds:X509IssuerName>C=CO,L=Bogota D.C.,O=Andes SCD.,OU=Division de certificacion entidad final,CN=CA
ANDES SCD S.A. Clase
II,1.2.840.113549.1.9.1=#1614696e666f40616e6465737363642e636f6d2e636f</ds:X509IssuerName>
<ds:X509SerialNumber>9128602840918470673</ds:X509SerialNumber>
</xades:IssuerSerial>
</xades:Cert>
<xades:Cert>
<xades:CertDigest>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>YGJTXnOzmebG2Mc6A/QapNi1PRA=</ds:DigestValue>
</xades:CertDigest>
<xades:IssuerSerial>
<ds:X509IssuerName>C=CO,L=Bogota D.C.,O=Andes SCD,OU=Division de certificacion,CN=ROOT CA ANDES
SCD
S.A.,1.2.840.113549.1.9.1=#1614696e666f40616e6465737363642e636f6d2e636f</ds:X509IssuerName>
<ds:X509SerialNumber>7958418607150926283</ds:X509SerialNumber>
</xades:IssuerSerial>
</xades:Cert>
<xades:Cert>
<xades:CertDigest>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>6EVr7OINyc49AgvNkie19xul55c=</ds:DigestValue>
</xades:CertDigest>
<xades:IssuerSerial>
<ds:X509IssuerName>C=CO,L=Bogota D.C.,O=Andes SCD,OU=Division de certificacion,CN=ROOT CA ANDES
SCD
S.A.,1.2.840.113549.1.9.1=#1614696e666f40616e6465737363642e636f6d2e636f</ds:X509IssuerName>
<ds:X509SerialNumber>3248112716520923666</ds:X509SerialNumber>
</xades:IssuerSerial>
</xades:Cert>
</xades:SigningCertificate>
<xades:SignaturePolicyIdentifier>
<xades:SignaturePolicyId>
<xades:SigPolicyId>

19
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

<xades:Identifier>http://www.facturae.es/politica_de_firma_formato_facturae/politica_de_firma_formato
_facturae_v3_1.pdf</xades:Identifier>
</xades:SigPolicyId>
<xades:SigPolicyHash>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>Ohixl6upD6av8N7pEvDABhEL6hM=</ds:DigestValue>
</xades:SigPolicyHash>
</xades:SignaturePolicyId>
</xades:SignaturePolicyIdentifier>
<xades:SignerRole>
<xades:ClaimedRoles>
<xades:ClaimedRole>supplier</xades:ClaimedRole>
</xades:ClaimedRoles>
</xades:SignerRole>
</xades:SignedSignatureProperties>
</xades:SignedProperties>
</xades:QualifyingProperties>
</ds:Object>
</ds:Signature>
</ext:ExtensionContent>
</ext:UBLExtension>
</ext:UBLExtensions>
<cbc:UBLVersionID>UBL 2.0</cbc:UBLVersionID>
<cbc:ProfileID>DIAN 1.0</cbc:ProfileID>
<cbc:ID>45910281428</cbc:ID>
<cbc:UUID schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de Impuestos y Aduanas
Nacionales)">4ae0869bcc9044db987aecbe976187fd3ba0937c</cbc:UUID>
<cbc:IssueDate>2015-07-20</cbc:IssueDate>
<cbc:IssueTime>00:00:00</cbc:IssueTime>
<cbc:InvoiceTypeCode listAgencyID="195" listAgencyName="CO, DIAN (Direccion de Impuestos y Aduanas
Nacionales)"
listSchemeURI="http://www.dian.gov.co/contratos/facturaelectronica/v1/InvoiceType">1</cbc:InvoiceType
Code>
<cbc:Note>
Factura de venta
</cbc:Note>
<cbc:DocumentCurrencyCode>COP</cbc:DocumentCurrencyCode>
<fe:AccountingSupplierParty>
<cbc:AdditionalAccountID>1</cbc:AdditionalAccountID>
<fe:Party>
<cac:PartyIdentification>
<cbc:ID schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de Impuestos y Aduanas
Nacionales)" schemeID="31">700085371</cbc:ID>
</cac:PartyIdentification>
<cac:PartyName>
<cbc:Name>PJ - 700085371 - Adquiriente FE</cbc:Name>
</cac:PartyName>
<fe:PhysicalLocation>
<fe:Address>
<cbc:Department>Bolivar</cbc:Department>
<cbc:CitySubdivisionName>Centro</cbc:CitySubdivisionName>
<cbc:CityName>Pasa Caballos</cbc:CityName>

20
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

<cac:AddressLine>
<cbc:Line> carrera 8 Nº 6C - 60</cbc:Line>
</cac:AddressLine>
<cac:Country>
<cbc:IdentificationCode>CO</cbc:IdentificationCode>
</cac:Country>
</fe:Address>
</fe:PhysicalLocation>
<fe:PartyTaxScheme>
<cbc:TaxLevelCode>0</cbc:TaxLevelCode>
<cac:TaxScheme/>
</fe:PartyTaxScheme>
<fe:PartyLegalEntity>
<cbc:RegistrationName>PJ - 700085371</cbc:RegistrationName>
</fe:PartyLegalEntity>
</fe:Party>
</fe:AccountingSupplierParty>
<fe:AccountingCustomerParty>
<cbc:AdditionalAccountID>2</cbc:AdditionalAccountID>
<fe:Party>
<cac:PartyIdentification>
<cbc:ID schemeAgencyID="195" schemeAgencyName="CO, DIAN (Direccion de Impuestos y Aduanas
Nacionales)" schemeID="22">11222333</cbc:ID>
</cac:PartyIdentification>

<fe:PhysicalLocation>
<fe:Address>
<cbc:Department>Huila</cbc:Department>
<cbc:CitySubdivisionName>Centro</cbc:CitySubdivisionName>
<cbc:CityName>Aipe</cbc:CityName>
<cac:AddressLine>
<cbc:Line> carrera 8 Nº 6C - 40</cbc:Line>
</cac:AddressLine>
<cac:Country>
<cbc:IdentificationCode>CO</cbc:IdentificationCode>
</cac:Country>
</fe:Address>
</fe:PhysicalLocation>
<fe:PartyTaxScheme>
<cbc:TaxLevelCode>0</cbc:TaxLevelCode>
<cac:TaxScheme/>
</fe:PartyTaxScheme>
<fe:Person>
<cbc:FirstName>Primer-N</cbc:FirstName>
<cbc:FamilyName>Apellido-11222333</cbc:FamilyName>
<cbc:MiddleName>Segundo-N</cbc:MiddleName>
</fe:Person>
</fe:Party>
</fe:AccountingCustomerParty>
<fe:TaxTotal>
<cbc:TaxAmount currencyID="COP">15540.48</cbc:TaxAmount>
<cbc:TaxEvidenceIndicator>false</cbc:TaxEvidenceIndicator>

21
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

<fe:TaxSubtotal>
<cbc:TaxableAmount currencyID="COP">97128</cbc:TaxableAmount>
<cbc:TaxAmount currencyID="COP">15540.48</cbc:TaxAmount>
<cbc:Percent>16</cbc:Percent>
<cac:TaxCategory>
<cac:TaxScheme>
<cbc:ID>01</cbc:ID>
</cac:TaxScheme>
</cac:TaxCategory>
</fe:TaxSubtotal>
</fe:TaxTotal>
<fe:TaxTotal>
<cbc:TaxAmount currencyID="COP">4021.09</cbc:TaxAmount>
<cbc:TaxEvidenceIndicator>false</cbc:TaxEvidenceIndicator>
<fe:TaxSubtotal>
<cbc:TaxableAmount currencyID="COP">97128</cbc:TaxableAmount>
<cbc:TaxAmount currencyID="COP">4021.09</cbc:TaxAmount>
<cbc:Percent>4.14</cbc:Percent>
<cac:TaxCategory>
<cac:TaxScheme>
<cbc:ID>03</cbc:ID>
</cac:TaxScheme>
</cac:TaxCategory>
</fe:TaxSubtotal>
</fe:TaxTotal>
<fe:LegalMonetaryTotal>
<cbc:LineExtensionAmount currencyID="COP">97128</cbc:LineExtensionAmount>
<cbc:TaxExclusiveAmount currencyID="COP">19561.57</cbc:TaxExclusiveAmount>
<cbc:PayableAmount currencyID="COP">116689.57</cbc:PayableAmount>
</fe:LegalMonetaryTotal>
<fe:InvoiceLine>
<cbc:ID>1</cbc:ID>
<cbc:InvoicedQuantity>456</cbc:InvoicedQuantity>
<cbc:LineExtensionAmount currencyID="COP">97128</cbc:LineExtensionAmount>
<fe:Item>
<cbc:Description>Línea-1 45910281428 fos0001_700085371_f7999_R469910-459-27223</cbc:Description>
</fe:Item>
<fe:Price>
<cbc:PriceAmount currencyID="COP">213</cbc:PriceAmount>
</fe:Price>
</fe:InvoiceLine>
</fe:Invoice>”
}

8. Obtener Dummy JSON (Factura)

Obtiene la estructura JSON de una factura con una plantilla determinada

22
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Request
Método URL
GET https://facturaswebapi.azurewebsites.net/api/web/factura/ObtenerDummy/{token}/{SchemaId}/{ID
Number}/{TemplateID}

Parámetros
Tipo Nombre Valores
URL_PARAM token string
URL_PARAM SchemaId String
URL_PARAM IDNumber String
URL_PARAM TemplateID String

Token
Token de autenticación (Revisar Login).

SchemaID
Tipo de identificación de la empresa.

IDNumber
Número de identificación de la empresa.

TemplateID
Código de identificación de la plantilla a obtener.

Response
Status Response
200 “Document info”
400 “Unauthorized”
500 {"error":"Lo sentimos se ha presentado un problema."}

Ejemplos
Tipo Ejemplo
Response {
"Customer_Information": {
"IdentificationType": 0,
"Identification": null,
"DV": 0,
"PartyTaxLevelCode": 0,
"PersonTypeID": 0,
"RegistrationName": null,
"PersonFirstName": null,
"PersonMiddleName": null,
"PersonFamilyName": null,

23
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

"PersonFamilyName2": null,
"CityID": 0,
"AddressLine": null,
"Telephone": null,
"Email": null,
"WebSiteURI": null
},
"Authorization_Information": {
"InvoiceAuthorizationNumber": 0,
"PreinvoiceNumber": 0,
"DaysOff": 0
},
"Item_Information": [
{
"ItemCode": null,
"Name": null,
"Quantity": 0,
"Price": 0,
"Amount": 0,
"MeasureUnitCode": null,
"TaxesInformation": [
{
"Id": 0,
"TaxEvidenceIndicator": false,
"Percent": 0,
"TaxableAmount": 0,
"TaxAmount": 0
}
],
"AdditionalItemPropertyList": null,
"AdditionalFields": [
{
"Name": "Color Producto",
"Value": "Value"
}
]
}
],
"TaxesInformation": [
{
"Id": 0,
"TaxEvidenceIndicator": false,
"Percent": 0,
"TaxableAmount": 0,
"TaxAmount": 0
}
],
"Payment_Summary": {
"PaymentTypeID": 0,
"PaymentMethodNote": null,
"CurrencyCode": null
},
"Payment_Information": {
"LineExtensionAmount": 0,

24
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

"TaxExclusiveAmount": 0,
"PayableAmount": 0
},
"Invoice_Note": {
"Note": null
},
"Additional_Fields": [
{
"ReferenceName": "Detalles de pago",
"Name": "Tipo Pago",
"Value": "Value"
}
]
}
IMPORTANTE: para construir una factura exitosa se deberá enviar la misma estructura
entregada por el dummy ajustando el valor “Value” de los campos adicionales
(“Additional_Fields”) con la información que debe tener el campo referenciado.
“ReferenceName” es el módulo (dentro de la Representación Gráfica) al cual hace
parte el campo y “Name” es el nombre del campo (dentro de la Representación
Gráfica). También es importante aclarar que el arreglo que “Additional_Fields” que se
encuentra dentro de “Item_Information” son campos adicionales dentro de la tabla de
productos/servicios de la factura, y el arreglo “Additional_Fields” por fuera de
“Item_Information”, hace referencia a los campos adicional generales de la factura.

9. Diccionario de campos
Insertar Factura
Nombre Descripción
Información Cliente
IdentificationType Tipo de identificación del cliente asociado a la factura electrónica
(ver listado de códigos). Obligatorio
Identification Número de identificación del cliente asociado a la factura
electrónica. Obligatorio
DV Dígito de verificación del documento. Condicional (Obligatorio
cuando el tipo de documento es “NIT”).
PartyTaxLevelCode Régimen tributario del cliente asociado a la factura electrónica
(ver listado de códigos). Obligatorio
PersonTypeID Tipo persona del cliente asociado a la factura electrónica (ver
listado de códigos). Obligatorio
RegistrationName Razón social del cliente asociado a la factura electrónica.
Condicional (Este campo se debe completar cuando el tipo de
persona es “Jurídica”)

25
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

PersonFirstName Primer nombre del cliente asociado a la factura electrónica.


Condicional (Este campo se debe completar cuando el tipo de
persona es “Natural”)
PersonMiddleName Segundo nombre del cliente asociado a la factura electrónica.
Condicional (Este campo es opcional cuando el tipo de persona
es “Natural”)
PersonFamilyName Primer apellido del cliente asociado a la factura electrónica.
Condicional (Este campo se debe completar cuando el tipo de
persona es “Natural”)
PersonFamilyName2 Segundo apellido del cliente asociado a la factura electrónica.
Condicional (Este campo es opcional cuando el tipo de persona
es “Natural”)
CityID Código de identificación de la ciudad del cliente asociado a la
factura electrónica. Obligatorio (Ver listados de códigos)
AddressLine Dirección del cliente asociado a la factura electrónica. Obligatorio
Telephone Teléfono del cliente asociado a la factura electrónica. Opcional
Email Correo electrónico del cliente asociado a la factura electr+onica.
Opcional
WebSiteURI Dirección URL de la página web asociada al cliente de la factura
electrónica. Opcional
Información Resolución
InvoiceAuthorizationNumber Número de la resolución a utilizar para la factura en creación.
Obligatorio
PreinvoiceNumber Número prefactura (Númeración interna de la empresa que está
generando la factura). Obligatorio
ExpirationDays Número de días de vencimiento de la factura electrónica en
construcción. Tener en cuenta que los días reportados serán días
calendario. Si no se reporta el campo se entenderá por defecto
30 días calendario (un mes). Opcional
Información Ítem
ItemCode Código de identificación del ítem a facturar. Obligatorio
Name Nombre o descripción del ítem a facturar. Obligatorio
Quantity Cantidad de ítems a facturar. Obligatorio
Price Precio unitario del ítem a facturar. Obligatorio
Amount Valor de la línea (precio unitario X cantidad). Obligatorio
MeasureUnitCode Unidad de medida del ítem a facturar (ver listados de
códigos). Opcional
AdditionalItemPropertyList Tag utilizado para reportar las propiedades adicionales de los
ítems a facturar. Esta tag no tiene ningún valor, es un tag padre.
Opcional
Name Nombre de la propiedad adicional del ítem a facturar. Ejemplo:
Color, Talla, etc. Opcional

26
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Value Valor de la propiedad adicional del ítem a facturar. Ejemplo: Azul,


XL, etc. Opcional
TaxesInformation Tag padre que agrupa la información de los impuestos y
retenciones aplicables al ítem. Para los ítems solo se puede
reportar IVA, Impoconsumo y Retefuente. Opcional
Id Id de la clase de impuesto a reportar para el ítem. (ver listados de
códigos). Condicional (obligatorio si se completa algún tag del
elemento “TaxesInformation”)
TaxEvidenceIndicator Booleano para determinar si el impuesto es un impuesto o una
retención. (false = Impuesto y true = Retención) Condicional
(obligatorio si se completa algún tag del elemento
“TaxesInformation”)
Percent Porcentaje aplicable del impuesto/retención. Condicional
(obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxableAmount Valor gravable (valor al cual se aplicará el impuesto/retención).
Valor calculado de la operación “Valor Unitario” * “Cantidad” del
ítem. Condicional (obligatorio si se completa algún tag del
elemento “TaxesInformation”)
TaxAmount Valor del impuesto/retención aplicable al ítem. Resultado de la
operación “Valor gravable” * “Porcentaje Impuesto/Retención”.
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
Información Impuestos y Retenciones (resumen de impuestos y retenciones)

Id Id de la clase de impuesto a reportar. (ver listados de códigos).


Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxEvidenceIndicator Booleano para determinar si el impuesto es un impuesto o una
retención. (false = Impuesto y true = Retención). Condicional
(obligatorio si se completa algún tag del elemento
“TaxesInformation”)
Percent Porcentaje aplicable del impuesto/retención. Condicional
(obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxableAmount Valor gravable (valor al cual se aplicará el impuesto/retención).
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxAmount Valor del impuesto/retención a facturar. Condicional (obligatorio
si se completa algún tag del elemento “TaxesInformation”)
Información del Método de Pago y Moneda

27
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

PaymentTypeID Método de pago aplicable a la factura. (ver listados de códigos.


Obligatorio
PaymentMethodNote Nota de instrucción del pago aplicable a la factura. Opcional
CurrencyCode Tipo de moneda aplicable a la factura. Opcional
Información del Resumen de Pago
LineExtensionAmount Subtotal de la factura. Obligatorio
TaxExclusiveAmount Valor de los impuestos aplicables a la factura. Obligatorio
PayableAmount Valor total a pagar de la factura. Obligatorio
Observaciones Factura
Note Observaciones aplicables a la factura. Opcional

Insertar Nota Crédito


Nombre Descripción
Información Factura
CUFE Código Único de Facturación Electrónica (CUFE) de la factura asociada a
la nota en construcción. Obligatorio
Información Nota
ID Número de la nota en construcción (generado por el sistema de
facturación del emisor). Obligatorio
ResponseCode Concepto de la nota crédito en construcción. Ver listados de códigos.
Obligatorio
Discount Porcentaje del descuento aplicable a la factura a través de la nota
crédito. Condicional (debe completarse si el concepto de la nota es por
“Descuento Comercial”)
Información Ítem
ItemCode Código del ítem a acreditar. Debe coincidir con el código reportado en la
factura. Obligatorio
QuantityBack Cantidad de vuelta del ítem facturado. Esta cantidad debe ser igual o
inferior a la cantidad facturada. Condicional (debe completarse si el
concepto de la nota es por “Devolución Prod/Serv”)
Price Precio unitario real del ítem a acreditar. Este valor debe ser inferior al
precio unitario facturado. Obligatorio
Amount Valor de la línea (valor a acreditar por ítem). Obligatorio
Información Impuestos y Retenciones
Id Id de la clase de impuesto a reportar. (ver listados de códigos).
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxEvidenceIndicator Booleano para determinar si el impuesto es un impuesto una retención.
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)

28
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Percent Porcentaje aplicable del impuesto/retención. Condicional (obligatorio si


se completa algún tag del elemento “TaxesInformation”)
TaxableAmount Valor gravable (valor al cual se aplicará el impuesto/retención).
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxAmount Valor del impuesto/retención a acreditar. Condicional (obligatorio si se
completa algún tag del elemento “TaxesInformation”)
Información del Resumen de Pago
LineExtensionAmount Subtotal de la nota crédito. Obligatorio
TaxExclusiveAmount Total Impuestos de la nota crédito en creación. Obligatorio
PayableAmount Total de la nota crédito en construcción. Obligatorio
Razón de la nota
Note Razón de la generación de la nota crédito. Obligatorio

Insertar Nota Débito


Nombre Descripción
Información Factura
CUFE Código Único de Facturación Electrónica (CUFE) de la factura asociada a
la nota en construcción. Obligatorio
Información Nota
ID Número de la nota en construcción (generado por el sistema de
facturación del emisor). Obligatorio
ResponseCode Concepto de la nota débito en construcción. Ver listados de códigos.
Obligatorio
Discount Porcentaje del descuento aplicable a la factura a través de la nota
débito. Condicional (debe completarse si el concepto de la nota es por
“Descuento Comercial”)
Información Ítem
ItemCode Código del ítem a acreditar. Debe coincidir con el código reportado en la
factura. Obligatorio
QuantityBack Cantidad de vuelta del ítem facturado. Esta cantidad debe ser igual o
inferior a la cantidad facturada. Condicional (debe completarse si el
concepto de la nota es por “Devolución Prod/Serv”)
Price Precio unitario real del ítem a acreditar. Este valor debe ser inferior al
precio unitario facturado. Obligatorio
Amount Valor de la línea (valor a acreditar por ítem). Obligatorio
Información Impuestos y Retenciones
Id Id de la clase de impuesto a reportar. (ver listados de códigos).
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)

29
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

TaxEvidenceIndicatorBooleano para determinar si el impuesto es un impuesto una retención.


Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
Percent Porcentaje aplicable del impuesto/retención. Condicional (obligatorio si
se completa algún tag del elemento “TaxesInformation”)
TaxableAmount Valor gravable (valor al cual se aplicará el impuesto/retención).
Condicional (obligatorio si se completa algún tag del elemento
“TaxesInformation”)
TaxAmount Valor del impuesto/retención a acreditar. Condicional (obligatorio si se
completa algún tag del elemento “TaxesInformation”)
Información del Resumen de Pago
LineExtensionAmount Subtotal de la nota débito. Obligatorio
TaxExclusiveAmount Total Impuestos de la nota débito en creación. Obligatorio
PayableAmount Total de la nota débito en construcción. Obligatorio
Razón de la nota
Note Razón de la generación de la nota débito. Obligatorio

Obtener estado de documento


Nombre Descripción
DocumentId Código único de la identificación del documento entregado en las respuestas
de los métodos de inserción de documentos.
DocumentType Tipo de documento electrónico a consultar. (ver listados de códigos)
DocumentStatus Concepto de la nota débito en construcción. Ver listados de códigos.
StatusDate Fecha y hora en la que cambio al último estado referenciado
(DocumentStatus)
CUFE Código Único de Facturación Electrónica. Este campo se entregará
únicamente cuando se trate de una factura emitida.
InvoiceNumber Es el número consumido de la resolución de numeración para la factura
consultada. Este campo se entregará únicamente cuando se trate de una
factura emitida.
NoteNumber Número de la nota consultada. Recordar que este número es asignado por el
emisor al momento de generar la nota.
CustomerParty Razón social o nombres del cliente asociado al documento electrónico
consultado.
CustomerPartyID Número y tipo de identificación del cliente asociado al documento
electrónico consultado.
PayableAmount Valor total del documento electrónico consultado.

Obtener XML del documento


Nombre Descripción

30
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

DocumentId Código único de la identificación del documento entregado en las respuestas de


los métodos de inserción de documentos.
DocumentType Tipo de documento electrónico a obtener (XML). (ver listados de códigos)

Obtener Dummy factura


Nombre Descripción
Additional_Fields Conjunto de campos adicionales a la factura estándar para la plantilla
especificada
ReferenceName Nombre del módulo al cual pertenece el campo en la Representación Gráfica.
Name Nombre del campo adicional
Value Campo para capturar el valor del campo adicional

10. Listados de códigos

Listado códigos de conceptos de nota

Notas Crédito
Concepto Código
Devolución de parte de 1
los bienes; no aceptación
de partes del servicio
Rebaja en precio de 3
producto o servicio
Descuento Comercial 4
Otros 6

Notas Débito
Concepto Código
Intereses 1
Gastos por Cobrar 2
Cambio del valor 3

Listado códigos de forma de pago

Forma de Pago Código


Efectivo 10
Cheque 20
Transferencia 41
Bancaria
Consignación 42
Bancaria

31
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Listado códigos de tipos de documento de identificación

Tipo Documentos Código


Registro Civil 11
Tarjeta de Identidad 12
Cédula Ciudadanía 13
Tarjeta Extranjería 21
Cédula Extranjería 22
NIT 31
Pasaporte 41
Documento 42
Identificación
Extrajero

Listado códigos de tipo de régimen tributario

Régimen Tributario Código


Simple 0
Común 2

Listado códigos de tipo de persona

Tipo Persona Código


Jurídica 1
Natural 2

Listado códigos de clase de Impuesto/Retención

Impuesto Código
IVA 01
Impoconsumo 02
ICA 03
Retefuente 04

Listado códigos de tipo de impuesto/retención

32
DOCUMENTO DE ESPECIFICACIÓN API FACTURAS WEB

Boleano Código
Impuesto/Retención
Impuesto False
Retención True

33

También podría gustarte