Diferencia entre revisiones de «API LaFactura.co:CreditNote»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 46 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
==Objeto:creditNote==
+
==Objeto:creditNote (Nota Crédito/ Documento Ajuste Soporte)==
Es el objeto raiz, del sistema de envio de Notas Crédito de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.
+
Es el objeto raiz, del sistema de envio de Notas Crédito y Documento Ajuste Soporte de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.
 +
<br/><br/><i>*Importante: Tenemos un método muy sencillo y corto para hacer '''Anulaciones de Factura - Documento Ajuste Soporte''': [[API_LaFactura.co:Anular_Factura|Anular Factura / Documento Ajuste Soporte]]</i>
 +
<br><br>
 +
    Ingreso:   
 +
    <nowiki>https://***.tas-la.com/facturacion.v30/creditNote/</nowiki>
 +
    <b>(solicita tu usuario y contraseña +57-601-7466664)</b>
 +
<br>
 
=====Ejemplo=====
 
=====Ejemplo=====
 
+
----
 
   {
 
   {
 
     "creditNote":
 
     "creditNote":
 
     {
 
     {
       "rangeKey":"219832728",
+
       "prefix":"NCR",
 
       "tascode":"fc-2198920483woepqpwqoie32728",
 
       "tascode":"fc-2198920483woepqpwqoie32728",
 +
      "intID":"98239",
 
       "issueDate":"20200317",
 
       "issueDate":"20200317",
 
       "issueTime":"100521",
 
       "issueTime":"100521",
 +
      "discrepancyCode":"1",
 
       "note1" : "CIENTO TREINTA Y CUATRO MIL DOSCIENTOS CUARENTA PESOS",
 
       "note1" : "CIENTO TREINTA Y CUATRO MIL DOSCIENTOS CUARENTA PESOS",
       "note2" : "Este es el motivo de cancelación",
+
       "note2" : "Devolucion parcial por el servicio prestado",
 
       "amounts":{
 
       "amounts":{
 
           "totalAmount":"120000.00",
 
           "totalAmount":"120000.00",
Línea 27: Línea 35:
 
             "brand":"LF",
 
             "brand":"LF",
 
             "model":"Soporte",
 
             "model":"Soporte",
            "standard": "999",
 
            "agency": "990",
 
 
             "code": "1000",
 
             "code": "1000",
 
             "allowance":[
 
             "allowance":[
Línea 36: Línea 42:
 
                   "description":"Es un super descuento por hoy",
 
                   "description":"Es un super descuento por hoy",
 
                   "baseAmount":"100000.00",
 
                   "baseAmount":"100000.00",
                   "amount":"4000.00",
+
                   "amount":"4000.00"
                  "percent":"4.00"
 
 
                 }                     
 
                 }                     
 
             ],
 
             ],
Línea 55: Línea 60:
 
             "brand":"LF",
 
             "brand":"LF",
 
             "model":"Serv1",
 
             "model":"Serv1",
            "standard": "999",
 
            "agency": "990",
 
 
             "code": "1001"
 
             "code": "1001"
 
           }
 
           }
Línea 66: Línea 69:
 
----
 
----
  
Se está solicitando la creación de una factura por una Nota Crédito por el total de $134.240 Pesos, relacionada con una factura que tiene de tascode: fc-2198920483woepqpwqoie32728 con:<br><br>
+
Se está solicitando la creación de una Nota Crédito por el total de $134.240 Pesos, relacionada con una factura que tiene de tascode: fc-2198920483woepqpwqoie32728 con:<br><br>
 
Item 1:  
 
Item 1:  
 
* 5 Horas de soporte remoto con un costo unitario de $20.000, para un total de $100.000
 
* 5 Horas de soporte remoto con un costo unitario de $20.000, para un total de $100.000
Línea 79: Línea 82:
 
* Los impuestos son: $ 18.240<br>
 
* Los impuestos son: $ 18.240<br>
 
   
 
   
* El total en factura en: $ 134.240<br><br/>
+
* El total de la Nota crédito: $ 134.240<br><br/>
  
 
=====Campos=====
 
=====Campos=====
Línea 85: Línea 88:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Parámetro !! Descripción !! Tipo !! Obligatorio
+
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
|-
 
|-
| rangeKey || Identificador único, del rango de facturación a ser usado<br><small>(Tomado de nuestro sistema)</small>|| cadena || SI
+
| prefix || Prefijo del rango de Notas Crédito / Documento Soporte que deseas utilizar.<br><small>La lista de disponibles la puedes consultar con el servicio: [[API_LaFactura.co:Rangos_Facturacion|Obtener Rangos]]</small>|| cadena || SI || v3.0
 
|-
 
|-
| issueDate || Fecha de la factura<br><small>(YYYYMMDD) Ejemplo: 20200321</small> || cadena || SI
+
| tascode || Identificador de la factura / Documento Soporte a la que hace relación en nuestro sistema|| cadena || SI || v3.0
 
|-
 
|-
| issueTime || Hora de facturacion<br><small>(HHMMSS) Ejemplo: 175430</small> || cadena || SI
+
| intID || Identificador único del documento en tu Base de datos|| cadena || SI || v3.0
 
|-
 
|-
| note1 || Valor de la factura en letras || cadena || SI
+
| issueDate || Fecha del documento<br><small>(YYYYMMDD) Ejemplo: 20200321</small> || cadena || SI || v3.0
 
|-
 
|-
| note2 || Motivo la nota crédito emitida || cadena || SI
+
| issueTime || Hora del documento<br><small>(HHMMSS) Ejemplo: 175430</small> || cadena || SI || v3.0
 
|-
 
|-
| note3 || Nota para ser agregada en la factura || cadena || NO
+
| discrepancyCode || Código del motivo de la discrepancia<br><small>1 -> Devolucion parcial de bienes y/o no aceptacion parcial del servicio<br/>2-> Anulacion de factura electronica<br/>3-> Rebaja o descuento parcial o total<br/>4-> Ajuste de precio<br/>5 -> Otros</small> || cadena || SI || v3.0
 
|-
 
|-
| note4 || Nota para ser agregada en la factura || cadena || NO
+
| note1 || Valor del documento en letras || cadena || SI || v3.0
 
|-
 
|-
| amounts || Totales del documento<br><small>Ir a: [[API_laFactura.co:amounts|amounts]]</small> || objeto || SI
+
| note2 || Motivo la nota crédito emitida || cadena || SI || v3.0
 
|-
 
|-
| items || Líneas de la Nota Crédito<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || SI
+
| note3 || Nota para ser agregada en el documento || cadena || NO || v3.0
 +
|-
 +
| note4 || Nota para ser agregada en el documento || cadena || NO || v3.0
 +
|-
 +
| whTaxes || Retenciones efectuadas al documento (para NO autoretenedores)<br><small>Ir a: [[API_laFactura.co:whTaxes|whTaxes]]</small> || objeto || NO || v3.0
 +
|-
 +
| amounts || Totales del documento<br><small>Ir a: [[API_laFactura.co:amounts|amounts]]</small> || objeto || SI || v3.0
 +
|-
 +
| items || Líneas del documento<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || SI || v3.0
 +
|-
 +
| additional || Objeto con elementos complementarios<small><br>Relaciona elementos específicos para algunos clientes especiales<br/><b>Objetos:</b><br/>[[API_LaFactura.co:documento.gn|documento_gn]] <b>(Requerido para usuarios que manejan su consecutivo de notas cŕedito)</b></small>|| objeto || NO || v3.0
 
|}
 
|}
 +
 +
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span>
 +
----
 +
* Ahora se requiere el discrepancyCode<br/>
 +
* Se agregó el intID, que funciona igual que en invoice<br/>
 +
* emailStyle se eliminó <br/>
 +
* los objetos de amounts e items, fueron ampliados y mejorados <br/>
 +
<br/>
  
 
=====Resultados=====
 
=====Resultados=====
Línea 116: Línea 137:
 
           "text":"Operación realizada con exito"
 
           "text":"Operación realizada con exito"
 
         },
 
         },
         "documento":{
+
         "document":{
           "type":"Factura",
+
           "type":"Credit Note",
 
           "mode":"Creation",
 
           "mode":"Creation",
           "tascode":"fc-54984309jtr0ret90jjrg",
+
           "tascode":"fc-2198920483woepqpwqoie32728",
           "document":"FC-2092092",
+
          "referal":"nc-54984309jtr0ret90jjrg"
           "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094",
+
           "document":"NCR-0000002",
 +
           "CUDE":"43059843095203948093248093483048039248093403298409328490348903483094",
 
           "process":0
 
           "process":0
 
         }
 
         }
Línea 133: Línea 155:
  
 
==Objetos empleados==
 
==Objetos empleados==
*[[API_laFactura.co:exchangeRate|exchangeRate]] (Tasas - Para ventas en Dólares)
 
*[[API_laFactura.co:customer|customer]] (Cliente)
 
 
*[[API_laFactura.co:amounts|amounts]] (Montos)
 
*[[API_laFactura.co:amounts|amounts]] (Montos)
 
*[[API_laFactura.co:items|items]] (Lineas de la factura)
 
*[[API_laFactura.co:items|items]] (Lineas de la factura)
Línea 140: Línea 160:
 
==Usado por==
 
==Usado por==
 
Los siguientes recursos:
 
Los siguientes recursos:
* [[API_LaFactura.co:Generar_Factura|Generar Factura]]
+
* [[API_LaFactura.co:Generar_Nota_Credito|Generar Nota Crédito]]
  
 
==Temas complementarios==
 
==Temas complementarios==
* [[API_LaFactura.co:Facturacion|Facturación]]
+
* [[API_LaFactura.co:NotaCredito|Nota Crédito]]
  
 
==Enlaces==
 
==Enlaces==

Revisión actual del 16:31 18 sep 2024

Objeto:creditNote (Nota Crédito/ Documento Ajuste Soporte)

Es el objeto raiz, del sistema de envio de Notas Crédito y Documento Ajuste Soporte de nuestra API, es importante respetar todos los elementos aquí contemplados.

*Importante: Tenemos un método muy sencillo y corto para hacer Anulaciones de Factura - Documento Ajuste Soporte: Anular Factura / Documento Ajuste Soporte

    Ingreso:     
    https://***.tas-la.com/facturacion.v30/creditNote/
    (solicita tu usuario y contraseña +57-601-7466664)


Ejemplo

 {
   "creditNote":
   {
     "prefix":"NCR",
     "tascode":"fc-2198920483woepqpwqoie32728",
     "intID":"98239",
     "issueDate":"20200317",
     "issueTime":"100521",
     "discrepancyCode":"1",
     "note1" : "CIENTO TREINTA Y CUATRO MIL DOSCIENTOS CUARENTA PESOS",
     "note2" : "Devolucion parcial por el servicio prestado",
     "amounts":{
          "totalAmount":"120000.00",
          "discountAmount":"4000.00",
          "extraAmount":"0.00",
          "taxAmount":"18240.00",
          "payAmount":"134240.00"
     },
     "items":[
         {
           "quantity":"5.00",
           "unitPrice":"20000.00",
           "total":"96000.00",
           "description":"Horas de soporte remoto",
           "brand":"LF",
           "model":"Soporte",
           "code": "1000",
           "allowance":[
                {
                  "charge":"false",
                  "reasonCode":"11",
                  "description":"Es un super descuento por hoy",
                  "baseAmount":"100000.00",
                  "amount":"4000.00"
                }                    
           ],
           "taxes":[
                {
                  "ID":"01",
                  "taxAmount":"18240.00",
                  "percent":"19.00"
                }
            ]
         },
         {
           "quantity":"1.00",
           "unitPrice":"20000.00",
           "total":"20000.00",
           "description":"Servicio sin IVA",
           "brand":"LF",
           "model":"Serv1",
           "code": "1001"
         }
      ]
   }
 }
Explicacion

Se está solicitando la creación de una Nota Crédito por el total de $134.240 Pesos, relacionada con una factura que tiene de tascode: fc-2198920483woepqpwqoie32728 con:

Item 1:

  • 5 Horas de soporte remoto con un costo unitario de $20.000, para un total de $100.000
  • A estas 5 horas se les hizo un descuento del 4% ($4.000), para un total de $96.000
  • Se le aplicó el IVA al valor de la línea ($18.240)

Item 2:

  • 1 Hora de servicio sin IVA por un valor de $20.000

Totales:

  • El total antes de impuestos es de $116.000
  • Los impuestos son: $ 18.240
  • El total de la Nota crédito: $ 134.240

Campos

Parámetro Descripción Tipo Obligatorio API
prefix Prefijo del rango de Notas Crédito / Documento Soporte que deseas utilizar.
La lista de disponibles la puedes consultar con el servicio: Obtener Rangos
cadena SI v3.0
tascode Identificador de la factura / Documento Soporte a la que hace relación en nuestro sistema cadena SI v3.0
intID Identificador único del documento en tu Base de datos cadena SI v3.0
issueDate Fecha del documento
(YYYYMMDD) Ejemplo: 20200321
cadena SI v3.0
issueTime Hora del documento
(HHMMSS) Ejemplo: 175430
cadena SI v3.0
discrepancyCode Código del motivo de la discrepancia
1 -> Devolucion parcial de bienes y/o no aceptacion parcial del servicio
2-> Anulacion de factura electronica
3-> Rebaja o descuento parcial o total
4-> Ajuste de precio
5 -> Otros
cadena SI v3.0
note1 Valor del documento en letras cadena SI v3.0
note2 Motivo la nota crédito emitida cadena SI v3.0
note3 Nota para ser agregada en el documento cadena NO v3.0
note4 Nota para ser agregada en el documento cadena NO v3.0
whTaxes Retenciones efectuadas al documento (para NO autoretenedores)
Ir a: whTaxes
objeto NO v3.0
amounts Totales del documento
Ir a: amounts
objeto SI v3.0
items Líneas del documento
(Debe existir almenos una)
Ir a: items
objeto SI v3.0
additional Objeto con elementos complementarios
Relaciona elementos específicos para algunos clientes especiales
Objetos:
documento_gn (Requerido para usuarios que manejan su consecutivo de notas cŕedito)
objeto NO v3.0

Notas para migrantes de API v2.0 a v3.0:


  • Ahora se requiere el discrepancyCode
  • Se agregó el intID, que funciona igual que en invoice
  • emailStyle se eliminó
  • los objetos de amounts e items, fueron ampliados y mejorados


Resultados

Devuelve un objeto invoiceResult con el resultado de la operación

 {
   "invoiceResult":{
       "status":{
          "code":200,
          "text":"Operación realizada con exito"
       },
       "document":{
          "type":"Credit Note",
          "mode":"Creation",
          "tascode":"fc-2198920483woepqpwqoie32728",
          "referal":"nc-54984309jtr0ret90jjrg"
          "document":"NCR-0000002",
          "CUDE":"43059843095203948093248093483048039248093403298409328490348903483094",
          "process":0
       }
   }
 }
A tener presente

  • El resultado incluye el campo "tascode", que es el codigo único interno en nuestro sistema e identifica el documento. Es requerido para cualquier acción posterior sobre este documento. (Es importante conservarlo)
  • No se debe considerar un documento como válido por la DIAN, hasta que el resultado de una verificación del documento, muestre a process con: 2

Objetos empleados

Usado por

Los siguientes recursos:

Temas complementarios

Enlaces

Importante

Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.