Campos base
Section titled “Campos base”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| type_document_id | number | Si | Tipo de documento, para nómina electrónica siempre sera id 1 |
| prefix | string | Si | Prefijo de la factura |
| number | number | Si | Número de factura |
| date | date | Si | Fecha de emisión (YYYY-MM-DD) |
| time | time | Si | Hora de emisión (HH:MM:SS) |
| resolution_number | number | Si | Número de resolución |
| sendmail | number | Si | Esta propiedad permite definir si se enviará de forma automatica el correo al cliente |
| sendmailtome | number | Si | Esta propiedad permite definir si se enviará de forma automatica el documento al correo del emisor, recibe true o false |
| email_cc_list | number | No | Permite definir un lista de email a los que será enviado un documento de forma simultanea |
| notes | string | No | Nota libre de la factura electrónica |
| disable_confirmation_text | boolean | No | Activa el texto de confirmación informando al cliente a que correo debe enviar el soporte de pago de la factura, recibe true o false |
| establishment_name | string | No | Nombre del establecimiento |
| establishment_address | string | No | Dirección del establecimiento |
| establishment_phone | string | No | Teléfono del establecimiento |
| establishment_email | string | No | Email del establecimiento |
| establishment_municipality | string | No | Municipio del establecimiento |
| seze | string | No | Permite indicar si una empresa pertenece al regimen seze (Zonas Económicas y Sociales Especiales), así como el año actual en el PDF. Ley 1955 de 2019. |
| html_header | string | No | Permite incluir una nota en la cabezera del documento con diseño personalizado en html. |
| html_buttons | string | No | Permite incluir botones personalizable con url dentro del documento pdf de la factura. |
| html_footer | string | No | Permite incluir una nota en el footer del documento con diseño personalizado en html. |
| head_note | string | No | Permite incluir una nota en la cabezera del documento. |
| foot_note | string | No | Permite incluir una nota en pie de página del documento. |
| noteAIU | string | No | Permite ingresar una descripción del documento o detalles del contrato, en caso de factura AIU es obligatoria. |
| annexes | array | No | Esta funcionalidad permite enviar archivos adjuntos con el correo de la factura. Acepta multiples formatos de archivos |
| annexes[document] | base64 | Si | El documento a enviar el formato base64 |
| annexes[extension] | string | Si | Las extenciones se deben enviar sin punto (pdf, doc, xls, ppt, png, jpg, gif) |
Valores totales de la factura
Section titled “Valores totales de la factura”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| legal_monetary_totals | array | Si | Grupo de campos para información relacionadas con los valores totales aplicables a la factura |
| legal_monetary_totals[line_extension_amount] | float | Si | Total valor bruto: corresponde a la suma de los valores brutos de las líneas de la factura |
| legal_monetary_totals[tax_exclusive_amount] | float | Si | Total Valor Base Imponible: Base imponible para el cálculo de los tributos (La suma de las bases de todas lineas con impuestos) |
| legal_monetary_totals[tax_inclusive_amount] | float | Si | Total de Valor Bruto de todas las lineas más tributos menos los descuentos (Productos con impuestos, más productos sin impuestos, más los impuestos, menos los descuentos) |
| legal_monetary_totals[allowance_total_amount] | float | No | Descuento Total: Suma de todos los descuentos aplicados a nivel de la factura |
| legal_monetary_totals[charge_total_amount] | float | No | Cargo Total, Suma de todos los cargos aplicados a nivel de la factura |
| legal_monetary_totals[pre_paid_amount] | float | No | Valor total de anticipos aplicados a la factura |
| legal_monetary_totals[payable_amount] | float | Si | Valor a pagar de la factura, valor total de ítems (incluyendo cargos y descuentos a nivel de ítems) + valor tributos + valor cargos – valor descuentos. |
Forma de pago
Section titled “Forma de pago”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| payment_form | array | Si | En la propiedad payment_form se debe enviar el metodo y forma de pago |
| payment_form[payment_form_id] | number | Si | Identificador de las formas de pago (Ver tabla Formas de pago) |
| payment_form[payment_method_id] | number | Si | Identificador de los metodos de pago (Ver tabla Metodos de pago) |
| payment_form[payment_due_date] | date | Si | deberá informar la fecha de pago. Es obligatorio cuando el método de pago es a crédito |
| payment_form[duration_measure] | number | Si | informará la cantidad de días de plazo en caso que sea venta a crédito. Es obligatorio cuando el método de pago es a crédito |
Información del cliente
Section titled “Información del cliente”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| customer | array | Si | En la propiedad customer se deben enviar los datos del cliente. |
| customer[type_document_identification_id] | number | Si | identificador del tipo de documento de identificación (Ver tabla Tipos de Documentos de Identificación) |
| customer[identification_number] | string | Si | Corresponde al nit o cedula del cliente en caso de ser cedula no se utiliza la propiedad dv |
| customer[dv] | number | No | en esta propiedad se debe enviar el digito de vertificación cuando sea nit el documento |
| customer[name] | string | Si | En esta propiedad se debe enviar el nombre o razón social del cliente |
| customer[email] | string | Si | debe ir el email al cual será enviada la factura del cliente |
| customer[phone] | string | No | corresponde al teléfono del cliente |
| customer[address] | string | No | Corresponde a la dirección del cliente |
| customer[merchant_registration] | string | No | se deberá enviar el número de matricula mercantil o en su defecto 0000000 |
| customer[type_organization_id] | number | No | identificador del tipo de organización (Ver tabla Tipos de Organizaciones) |
| customer[municipality_id] | number | No | identificador del municipio (Ver tabla Municipios) |
| customer[type_regime_id] | number | No | identificador del régimen (Ver tabla Régimen) |
| customer[type_liability_id] | number | No | identificador del tipo de responsabilidad (Ver tabla Tipos de Responsabilidades) |
| customer[tax_id] | number | No | identificador del tipo de impuesto (Ver tabla de Impuestos) |
Campos por línea de factura
Section titled “Campos por línea de factura”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| invoice_lines | array | Si | Grupo de campos para información relacionadas las lineas del documento o items a facturar. |
| invoice_lines[unit_measure_id] | number | Si | identificador de las unidades de medidas (Ver tabla Unidades de Medidas) |
| invoice_lines[invoiced_quantity] | number | Si | Cantidad del producto o servicio |
| invoice_lines[free_of_charge_indicator] | boolean | Si | Indica que el elemento es un Cargo y no un descuento |
| invoice_lines[allowance_charges] | array | Si | Ver expliación de los descuentos generales tiene el mismo funcionamiento pero a nivel productos o servicios |
| invoice_lines[description] | string | Si | Descripción del producto o servicio |
| invoice_lines[notes] | string | No | Texto libre para añadir información adicional al artículo. |
| invoice_lines[code] | string | Si | Código asignado al producto por el cliente. |
| invoice_lines[type_item_identification_id] | number | Si | Indentificador de tipo de producto (Ver tabla Tipos de Productos) |
| invoice_lines[price_amount] | float | Si | Valor de la linea de la factura |
| invoice_lines[base_quantity] | float | Si | Es la cantidad por la que se multiplicará el valor para obtener el total de la linea |
| invoice_lines[agentparty] | number | No | Indica el número de identificación del mandate |
| invoice_lines[agentparty_dv] | number | No | Intica el digito de vertificación del mandate |
Campos sector transporte
Section titled “Campos sector transporte”| invoice_lines[is_RNDC] | boolean | Si | Indica si el producto es de RNDC(Registro Nacional Despacho de Carga) |
|---|---|---|---|
| invoice_lines[RNDC_consignment_number] | number | Si | Corresponde al número de radicado de la remesa |
| invoice_lines[internal_consignment_number] | string | Si | Corresponde al consecutivo de la remesa |
| invoice_lines[value_consignment] | float | Si | Valor del pago |
| invoice_lines[descrunit_measure_consignment_id] | number | Si | Id de la unidad de medida de la mercancia transportada (Ver tabla Unidad de Medidas) |
| invoice_lines[quantity_consignment] | number | Si | Corresponde a la cantidad transportada |
Campos sector salud
Section titled “Campos sector salud”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| health_fields | array | No | Campos correspondientes al sector salud. |
| health_fields[invoice_period_start_date] | date | Si | Indica la fecha de inicio del periodo de facturación |
| health_fields[invoice_period_end_date] | date | Si | Indica la fecha de fin del periodo de facturación |
| health_fields[health_type_operation_id] | number | Si | Indica el tipo de operación en salud |
| health_fields[print_users_info_to_pdf] | boolean | Si | Indica si se debe imprimir la información del usuario en el PDF |
| health_fields[users_info] | array | Si | Indica los datos del paciente atendido |
Campos impuestos
Section titled “Campos impuestos”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| tax_totals | array | No | Grupo de campos para información relacionadas con los tributos (Impuestos). |
| tax_totals[tax_id] | number | Si | identificador del tributo (Ver tabla Impuestos) |
| tax_totals[tax_amount] | float | Si | Valor del tributo (impuesto) |
| tax_totals[percent] | float | Si | Tarifa del tributo |
| tax_totals[taxable_amount] | float | Si | base Imponible sobre la que se calcula el valor del tributo (La suma de los line_extension_amount de productos con impuestos) |
Campos de descuentos
Section titled “Campos de descuentos”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| allowance_charges | array | No | En esta propiedad se informan descuentos o cargos a nivel de factura, es decir descuentos o cargos que no afectan las bases gravables. Los descuentos o cargos que afectan bases gravables se informan a nivel de ítem. |
| allowance_charges[charge_indicator] | boolean | Si | indica si es un cargo o un descuento, true para cargo, false para descuento |
| allowance_charges[discount_id] | number | Si | Identificador perteneciente al tipo de descuento (Ver tabla Descuentos) |
| allowance_charges[amount] | float | Si | Es el valor de descuento |
| allowance_charges[allowance_charge_reason] | string | Si | Texto libre para informar de la razón del descuento (Obligatorio de informar si es descuento a nivel de factura) |
Campos de exportación
Section titled “Campos de exportación”| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| k_supplement | array | No | En esta propiedad se informan los datos de la factura de exportación |
| k_supplement[responsible_incharge] | string | Si | Datos del responsable de la carga |
| k_supplement[departure_place] | string | Si | Lugar de salida de la carga |
| k_supplement[conveyance] | string | Si | Medio de transporte |
| k_supplement[transport_document_type] | string | Si | Tipo de documento de transporte |
| k_supplement[transport_document_number] | string | Si | Número de documento de transporte |
| k_supplement[transporter_processor] | string | Si | Nombre de transportador o tramitador |
| k_supplement[merchandise_origin_country] | string | Si | País de origen de la mercancía |
| k_supplement[payment_means] | string | Si | Terminos de pago de la mercancía |
| k_supplement[insurance_carrier] | string | Si | Aseguradora |
| k_supplement[observations] | string | Si | Observaciones |
| k_supplement[FctConvCop] | string | Si | Valor bruto antes de tributos |
| k_supplement[MonedaCop] | string | Si | Nombre de la moneda |
| k_supplement[SubTotalCop] | string | Si | Subtotal |
| k_supplement[DescuentoDetalleCop] | string | Si | Campo para informar el total de los descuentos |
| k_supplement[RecargoDetalleCop] | string | Si | Campo para informar el total de los recargos |
| k_supplement[TotalBrutoFacturaCop] | string | Si | Campo para informar el total bruto |
| k_supplement[TotIncCop] | string | Si | Campo para informar el total INC |
| k_supplement[TotBolCop] | string | Si | Campo para informar el total Impuesto a la bolsa |
| k_supplement[ImpOtroCop] | string | Si | Campo para informar el total otros impuestos |
| k_supplement[MntImpCop] | string | Si | Campo para informar el imt |
| k_supplement[TotalNetoFacturaCop] | string | Si | Total neto de la factura |
| k_supplement[MntDctoCop] | string | Si | Total descuento en pesos |
| k_supplement[MntRcgoCop] | string | Si | Recargo en pesos |
| k_supplement[VlrPagarCop] | string | Si | Valor a pagar en pesos |
| k_supplement[ReteFueCop] | string | Si | Valor retefuente en pesos |
| k_supplement[ReteIvaCop] | string | Si | Valor reteiva en pesos |
| k_supplement[ReteIcaCop] | string | Si | Valor reteica en pesos |
| k_supplement[TotAnticiposCop] | string | Si | Valor anticipo en pesos |