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