l. API

Factura de Venta mediante API

1877 Vistas 4

Podrás crear y consultar el comprobante que permite registrar las cantidades y valores de los productos y/o servicios que estás vendiendo en la empresa.

Crear factura de venta

URI http://siigoapi.azure-api.net/siigo/api/v1/Invoice/Save?namespace={namespace}
Parámetros namespace = v1
Método POST
Descripción Crea una factura de venta.

Las facturas en Siigo deben tener los siguientes campos:

1. Encabezado: En estos campos es necesario enviar el tipo de factura a elaborar, la fecha de elaboración del documento, los datos del cliente o tercero que debe estar asociado a un contacto, el centro de costos en caso que aplique, entre otros.

2. Detalle de la factura: En esta sección se adicionan todos los productos y/o servicios; se debe enviar las cantidades y los impuestos a cargo y de retención que puedan aplicar.

3. Formas de pago: En este campo se debe enviar las formas de pago que han sido previamente creadas y las cuales en Tipo estén marcadas como solo cartera o cartera/proveedor.

4. Observaciones: Este campo permite incluir comentarios adicionales los cuales se visualizarán en la impresión o vista preliminar de la factura.

Una factura de venta contiene los siguientes atributos:

Nombre del campo Ejemplo Formato Tamaño Descripción Obligatorio

Header

Id 0 Numérico Identificador de la factura (Parámetro de salida) NO
DocCode 45558 Numérico Identificador del tipo de factura SI
Number 0 Numérico Consecutivo(número) de la factura de venta Si aplica
EmailToSend Null Campo Obsoleto Campo obsoleto NO
DocDate “20200825” Alfanumérico 8 Fecha de la factura. Formato yyyymmdd SI
MoneyCode “COP” Alfanumérico 3 Código de moneda: Ver Tabla NO
ExchangeValue 0 Numérico Valor en moneda extranjera NO
DiscountValue 0 Numérico Valor descuentos NO
VATTotalValue 7246.51 Numérico Valor total de IVA NO
ConsumptionTaxTotalValue 0 Numérico Valor total de Impuesto al consumo NO
TaxDiscTotalValue 4195.35 Numérico Valor total de Retenciones NO
RetVATTotalID -1 Numérico Id reteIVA NO
RetVATTotalPercentage -1 Numérico Porcentaje reteIVA NO
RetVATTotalValue 0 Numérico Valor reteICA NO
RetICATotalID -1 Numérico Id reteICA NO
RetICATotalValue 0 Numérico Valor reteICA NO
RetICATotaPercentage -1 Numérico Porcentaje reteICA NO
SelfWithholdingTaxID -1 Numérico Identificador de la autorretención Si Aplica
AdvancePaymentValue 0 Numérico Valor Copago/Anticipos Si Aplica
TotalValue 41190.7 Numérico TotalValue = Total Neto = TotalBase – RetICATotalValue – RetVATTotalValue + ConsumptionTaxTotalValue – TaxDiscTotalValue + VATTotalValue SI
TotalBase 38139.54 Numérico Subtotal SI
SalesmanIdentification “963852741” Alfanumérico Identificador del vendedor(Usuario con acceso a Siigo Nube) SI
Observations Comentarios de la factura Alfanumérico 1000 Observaciones de la factura NO

Account

IsSocialReason True/False Booleano True si es una Empresa, False si es una persona. SI
FullName “Cuenta Prueba” Alfanumérico 100 Razón social Si es Empresa
FirstName “Cuenta” Alfanumérico 50 Nombres Si es Persona
LastName “Prueba” Alfanumérico 50 Apellidos Si es Persona
IdTypeCode 13 Numérico Tipo identificación: Ver Tabla SI
Identification “964853752” Alfanumérico 50 Identificación SI
CheckDigit 0 Numérico Digito verificación, se genera automáticamente NO
BranchOffice 0 Numérico Sucursal NO
IsVATCompanyType True/False Booleano Tipo de régimen IVA:

True: Responsable de IVA

False: No responsable de IVA

SI
City Ciudad: Ver Tabla SI
CountryCode “CO” Alfanumérico Código País SI
StateCode “11” Alfanumérico Código Estado SI
CityCode “11001” Alfanumérico Código Ciudad SI
Address “Dirección Tercero” Alfanumérico 250 Dirección SI
Phone Teléfono SI
Indicative 1 Numérico 10 Indicativo NO
Number 6884539 10 Número SI
Extention 1244 10 Extensión NO

Contact

Code 1 Numérico Código del contacto
Phone1 Teléfono oficina SI
Indicative 1 Numérico 10 Indicativo NO
Number 6334750 Numérico 10 Número SI
Extention 1235 Numérico 10 Extensión NO
Mobile Teléfono móvil NO
Indicative 1 Numérico 10 Indicativo NO
Number 3458392049 Numérico 10 Número SI
Extention 0 Numérico 10 Extensión NO
Email contact@prueba.com Alfanumérico 100 Correo electrónico contacto SI
FirstName Contacto Alfanumérico 50 Nombres SI
LastName Prueba Alfanumérico 50 Apellidos SI
IsPrincipal True/False Booleano True si es Contacto Principal SI
Gender 1 Numérico Valor 0 si es Femenino, 1 si es Maculino NO
BirthDate “20200314” Alfanumérico 8 Fecha de nacimiento. Formato yyyymmdd NO
CostCenterCode Null Alfanumérico Centro de costo Si aplica
SubCostCenterCode Null Alfanumérico Subcentro de costo Si aplica

Items

ProductCode “Item-1” Alfanumérico Código del producto SI
Description “Descripción producto” Alfanumérico Descripción del producto SI
GrossValue 38139.54 Numérico GrossValue = UnitValue * Quantity SI
BaseValue 38139.54 Numérico BaseValue = GrossValue – DiscountValue SI
Quantity 2 Numérico Cantidad SI
UnitValue 19069.77 Numérico Valor unitario SI
DiscountValue 0 Numérico Valor de descuento NO
DiscountPercentage 0 Numérico Porcentaje de descuento NO
TaxAddName “IVA 19%” Alfanumérico Impuesto como el IVA o impuesto al consumo Si aplica
TaxAddId 3440 Numérico Id del impuesto Si aplica
TaxAddValue 7246.51 Numérico Valor del impuesto Si aplica
TaxAddPercentage 19 Numérico Porcentaje del impuesto Si aplica
TaxDiscountName “Retefuente 11%” Alfanumérico Impuesto como la Retención en la Fuente Si aplica
TaxDiscountId 3446 Numérico Id del impuesto Si aplica
TaxDiscountValue 4195.35 Numérico Valor del impuesto Si aplica
TaxDiscountPercentage 11 Numérico Porcentaje del impuesto Si aplica
TotalValue 41190.7 Numérico TotalValue = BaseValue + TaxAddValue + TaxAdd2Value – TaxDiscountValue SI
ProductSubType 0 Campo obsoleto NO
TaxAdd2Name “” Alfanumérico Impuesto como el IVA o impuesto al consumo Si aplica
TaxAdd2Id -1 Numérico Id del impuesto Si aplica
TaxAdd2Value 0 Numérico Valor del impuesto Si aplica
TaxAdd2Percentage 0 Numérico Porcentaje del impuesto Si aplica
WareHouseCode Null Alfanumérico Código de Bodega Si aplica
SalesmanIdentification Null Alfanumérico Identificación del vendedor Si aplica

Payments

PaymentMeansCode 2035 Numérico ID del medio de pago SI
Value 41190.7 Numérico Valor asociado al medio de pago SI
DueDate “20201231” Alfanumérico Fecha pago cuota Para medios de pago Crédito

(DueType=1)

DueQuote 0 Numérico Número cuota

Consideraciones:

* Si no se envían retenciones o impuestos se debe enviar (-1) en el identificador.

* Para los campos retención RetVATTotalPercentage, RetICATotaPercentage también se envía (-1) si no se maneja.

Configuración de factura de venta

La configuración de la factura permite definir aquellos parámetros que son necesarios y se tendrán en cuenta al momento de elaborar y enviar el documento.

Para configurar los parámetros de una factura de venta es necesario ingresar al ícono del engranaje  que corresponde a Configuración – Transacciones – Comprobantes – Facturas.

Al ingresar a esta opción el sistema permite crear nuevos tipos de comprobante “Factura de venta” y se visualizan los comprobantes que ya se encuentran definidos en el programa, esta configuración dependerá de las características tributarias y contables de tu empresa.

Identificador del tipo de factura (DocCode)

1. En la configuración de factura de venta puedes obtener el identificado directamente en la URL.

Ingresa al ícono del engranaje  que corresponde a Configuración – Transacciones – Comprobantes – Facturas.

2. Mediante el endpoint ERPDocumentTypes:

URI http://siigoapi.azure-api.net/siigo/api/v1/ERPDocumentTypes/GetByCode?docClass={docClass}&docCode={docCode}&namespace={namespace}
Parámetros docClass = FV, docCode = Código del comprobante, namespace = v1
Método GET
Descripción Permite obtener la información de un tipo de comprobante. (Las consultas en Siigo API retornan 10 registros por página)

Identificación del vendedor (SalesmanIdentification)

El vendedor es un usuario registrado en Siigo Nube, puedes obtener la identificación de las siguientes maneras:

1. Mediante el endpoint Users

URI http://siigoapi.azure-api.net/siigo/api/v1/Users/GetAll?numberPage={numberPage}&namespace={namespace}
Parámetros numberPage = Valor desde 0, namespace = v1
Método GET
Descripción Permite obtener la información de un usuario. (Las consultas en Siigo API retornan 10 registros por página)

2. Para generar el reporte se debe acceder por Reportes – Más reportes – Nómina / Usuarios – Reportes de Sistema – Administración de usuario.

El sistema muestra cada uno de los usuarios que se encuentran creados en el sistema.

Al dar clic en el nombre del usuario podrás visualizar el perfil y obtener la identificación.

Para elaborar facturas de venta desde Siigo Nube, en la página principal con el icono  seleccionar la opción Ventas – Factura de venta.

Formas de pago (PaymentMeansCode)

Puedes consultar las formas de pago mediante el endpoint PaymentMeans

URI http://siigoapi.azure-api.net/siigo/api/v1/PaymentMeans/GetAll?numberPage={numberPage}&namespace={namespace}
Parámetros numberPage = Valor desde 0, namespace = v1
Método GET
Descripción Permite obtener una colección con todos los medios de pago registrados. (Las consultas en Siigo API retornan 10 registros por página)

Se debe tener en cuenta que el parámetro Type indica el tipo que puede ser cartera o proveedor, para la factura de venta se deben utilizar sólo las que estén marcadas como cartera (Type = 0) o cartera/proveedor (Type = 2) y IsSystem = false. Esto asegura que no se envíen medios de pago que no correspondan para factura de venta o que sean del sistema.

Para pagos que manejan vencimiento, validar parámetro DueType = 1.

Para configurar las formas de pago en Siigo Nube ingresar al ícono del engranaje  que corresponde a Configuración – Transacciones – Catálogos – Formas de pago.

Impuestos (TaxAddId, TaxDiscountId)

Puedes consultar los Impuestos mediante el endpoint Taxes

URI http://siigoapi.azure-api.net/siigo/api/v1/Taxes/GetAll?numberPage={numberPage}&namespace={namespace}
Parámetros numberPage = Valor desde 0, namespace = v1
Método GET
Descripción Permite obtener una colección con todos los impuestos registrados. (Las consultas en Siigo API retornan 10 registros por página)

 

¿Fue útil?

Deja un comentario
*
*

6 Comments
  • buenos días, ya logre crear la factura desde el API pero no me viaja a la DIAN y no me genera el codigo CUFE. que debo hacer? porque si crea la factura con el consecutivo bueno y todo pero no viaja a la DIAN, me podrian ayudar por favor, gracias.

    si necesitan mas datos me dicen porfa

    nuevamente gracias.

    28 octubre, 2020 at 3:52 pm
  • Esteban Ortiz says:

    Hola buen día,
    Me podrían ayudar con la siguiente duda.

    Se tiene una integración hacia facturación electrónica mediante una API donde se toma el Identificador del tipo de factura (DocCode), se toma por la empresa, pero el cliente tiene múltiples registros configurados para cada uno de sus establecimientos.

    Es esto posible o solo debe configurarse un registro?
    En caso de manejar múltiples comprobantes, la integración debe permitir configurar N códigos de tipo de factura y/o manejarlo por establecimiento, en vez de por empresa?

    De ante mano, muchas gracias.

    21 octubre, 2020 at 10:40 am
    • Ingrid Vasquez says:

      Buen día Esteban, te relaciono el link que explica los procesos que se pueden realizar en la Siigo API https://siigonube.portaldeclientes.siigo.com/basedeconocimiento/alcance-siigo-api/, uno de ellos es la integración de las facturas de venta, si te refieres con múltiples registros a varios ítems de productos y/o servicios si es posible realizarlo en el programa o si haces referencia a otro tipo de registros para revisar tu caso te pedimos comunicarte a nuestras líneas de call center y si es posible crear varios tipos de factura en Siigo nube.

      22 octubre, 2020 at 8:26 am
  • Carlos Alberto Ortiz Losada says:

    Hola, buen Día
    Estoy realizando un registro de factura mediante la API suministrada por Siigo, sin embargo he tenido un problema, es el siguiente en el JSON que agregan, como hago para pasarle dos productos
    Ejemplo:
    POST: http://siigoapi.azure-api.net/siigo/api/v1/Invoice/Save?namespace=v1
    “Items”: [
    {
    “ProductCode”: “A-31817894330483”,
    “Description”: “Descripción producto”,
    “GrossValue”: 38139.54,
    “BaseValue”: 38139.54,
    “Quantity”: 2,
    “UnitValue”: 19069.77,
    “DiscountValue”: 0,
    “DiscountPercentage”: 0,
    “TaxAddName”: “IVA 19%”,
    “TaxAddId”: 3440,
    “TaxAddValue”: 7246.51,
    “TaxAddPercentage”: 19,
    “TaxDiscountName”: “Retefuente 11%”,
    “TaxDiscountId”: 3446,
    “TaxDiscountValue”: 4195.35,
    “TaxDiscountPercentage”: 11,
    “TotalValue”: 41190.7,
    “ProductSubType”: 0,
    “TaxAdd2Name”: “”,
    “TaxAdd2Id”: -1,
    “TaxAdd2Value”: 0,
    “TaxAdd2Percentage”: 0,
    “WareHouseCode”: null,
    “SalesmanIdentification”: “1065877103”
    },
    {
    “ProductCode”: “A-31817895411827”,
    “Description”: “Descripción producto 2”,
    “GrossValue”: 38139.54,
    “BaseValue”: 38139.54,
    “Quantity”: 2,
    “UnitValue”: 19069.77,
    “DiscountValue”: 0,
    “DiscountPercentage”: 0,
    “TaxAddName”: “IVA 19%”,
    “TaxAddId”: 3440,
    “TaxAddValue”: 7246.51,
    “TaxAddPercentage”: 19,
    “TaxDiscountName”: “Retefuente 11%”,
    “TaxDiscountId”: 3446,
    “TaxDiscountValue”: 4195.35,
    “TaxDiscountPercentage”: 11,
    “TotalValue”: 41190.7,
    “ProductSubType”: 0,
    “TaxAdd2Name”: “”,
    “TaxAdd2Id”: -1,
    “TaxAdd2Value”: 0,
    “TaxAdd2Percentage”: 0,
    “WareHouseCode”: null,
    “SalesmanIdentification”: “1065877103”
    }
    ]
    De esta manera es válido, debido a que me presenta un error: “Error Siigo AcEntry Error Code Siigo: 110, Comprobante descuadrado, existen diferencias entre debito y credito”
    Me gustaria saber el motivo real de ese error
    Gracias y espero pronta respuesta

    6 octubre, 2020 at 5:28 am
    • Ingrid Vasquez says:

      Buen día Carlos, Este error es de la API y el sistema lo retorna de esa forma porque es en la base de datos, te recomiendo revisar que la información este diligenciada correctamente y completa, sin embargo, para una revisión más detallada de tu caso te pedimos comunicarte a nuestras líneas de call center.

      6 octubre, 2020 at 8:17 am