Diferencia entre revisiones de «API LaFactura.co:Invoice.ms»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 9 ediciones intermedias del mismo usuario)
Línea 87: Línea 87:
 
         "usuarios.ms":[
 
         "usuarios.ms":[
 
             {
 
             {
               "tipoDocumento":"CC",
+
               "tipoDoc":"CC",
               "numeroIdentificacion":"51890041",
+
               "numDoc":"51890041",
 
               "primerApellido":"PEREZ",
 
               "primerApellido":"PEREZ",
 
               "segundoApellido":"PERALTA",
 
               "segundoApellido":"PERALTA",
 
               "primerNombre":"PEPITA",
 
               "primerNombre":"PEPITA",
 
               "otrosNombre":"",
 
               "otrosNombre":"",
               "tipoUsuario":"03"
+
               "tipoUsuario":"03",
              "modalidad":"11",
 
 
               "tipoPlan":"02",
 
               "tipoPlan":"02",
 
               "numeroAutorizacion":"202020",
 
               "numeroAutorizacion":"202020",
               "poliza":"ABZ-212122",
+
               "numeroPoliza":"ABZ-212122",
 
               "elaboradoPor":"PEPE CARDONA"
 
               "elaboradoPor":"PEPE CARDONA"
 
             },
 
             },
Línea 107: Línea 106:
 
               "primerNombre":"PEPITO",
 
               "primerNombre":"PEPITO",
 
               "otrosNombre":"",
 
               "otrosNombre":"",
               "tipoUsuario":"01"
+
               "tipoUsuario":"01",
              "modalidad":"11",
 
 
               "tipoPlan":"01",
 
               "tipoPlan":"01",
 
               "numeroAutorizacion":"A202020",
 
               "numeroAutorizacion":"A202020",
               "poliza":"ABZ-212112",
+
               "numeroPoliza":"ABZ-212112",
 
               "elaboradoPor":"PEPE CARDONA"
 
               "elaboradoPor":"PEPE CARDONA"
 
             }
 
             }
 
         ],
 
         ],
         "interoperatividad.ms":{
+
         "adjuntos.ms":{
 
             "direccion":{
 
             "direccion":{
 
               "URL": "https:/ejemplo.archivos.com"
 
               "URL": "https:/ejemplo.archivos.com"
Línea 125: Línea 123:
 
=====Explicacion=====
 
=====Explicacion=====
 
----
 
----
 
Se está solicitando la creación de una factura por un total de $134.240 Pesos, para el cliente Pepito Perez y Compañía SA, con:<br><br>
 
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)<br>
 
 
Item 2:
 
* 1 Hora de servicio sin IVA por un valor de $20.000<br>
 
 
Totales:
 
* El total antes de impuestos es de $116.000<br>
 
* Los impuestos son: $ 18.240<br>
 
 
* El total en factura en: $ 134.240<br><br/>
 
 
Adicionalmente en el correo enviado al cliente va un boton de "PAGAR", que lleva a un link.
 
(Esta opción NO está disponible para todos los clientes)
 
  
 
=====Campos=====
 
=====Campos=====
Línea 160: Línea 140:
 
| paymentType || Tipo de pago<br><small>Efectivo->1 / Credito->2<br/>Por omisión el sistema supone Credito -> "2"</small> || cadena || NO
 
| paymentType || Tipo de pago<br><small>Efectivo->1 / Credito->2<br/>Por omisión el sistema supone Credito -> "2"</small> || cadena || NO
 
|-
 
|-
| paymentCode || Medio de pago<br/>Por omisión supone Instrumento No Definido -> "1"<br/><small>[[API_LaFactura.co:Tabla_Tipos_Medios_Pago|consultar tabla]]</small></small> || cadena || NO
+
| paymentCode || Modalidades de Pago (Version M.S.)<br/><small>[[API_LaFactura.co:Tabla_Modalidades_De_Pago.ms|consultar tabla]]</small></small> || cadena || NO
 
|-
 
|-
 
| note1 || Valor de la factura en letras || cadena || SI
 
| note1 || Valor de la factura en letras || cadena || SI
Línea 170: Línea 150:
 
| note4 || Nota para ser agregada en la factura || cadena || NO
 
| note4 || Nota para ser agregada en la factura || cadena || NO
 
|-
 
|-
| exchangeRate || Tasas de cambio<small><br>(Solo se requiere cuando se trata de una moneda diferente al Peso Colombiano)<br>Ir a: [[API_laFactura.co:exchangeRate|exchangeRate]]</small> || objeto || NO
+
| period || Período de facturacion || objeto || SI
 
|-
 
|-
 
| customer || Datos del cliente<br><small>Ir a: [[API_laFactura.co:customer|customer]]</small> || objeto || SI
 
| customer || Datos del cliente<br><small>Ir a: [[API_laFactura.co:customer|customer]]</small> || objeto || SI
Línea 178: Línea 158:
 
| items || Líneas de la factura<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || SI
 
| items || Líneas de la factura<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || SI
 
|-
 
|-
| additional || Objeto con elementos complementarios<small><br>Relaciona elementos específicos para algunos clientes especiales</small> || objeto || SI
+
| additional || Objeto con elementos complementarios para el sector salud<small><br><b>Objetos:</b><br>[[API_LaFactura.co:usuarios.ms|usuarios.ms]]<br/>adjuntos.ms</small> || objeto || SI
  
 
|}
 
|}

Revisión actual del 17:42 6 nov 2020

Objeto:invoice.ms

Es el objeto raiz, del sistema de envio de facturas con complementos del ministerio de salud de nuestra API, es importante respetar todos los elementos aquí contemplados.

Ejemplo
 {
   "invoice.ms":
   {
     "rangeKey":"219832728",
     "issueDate":"20200317",
     "issueTime":"100521",
     "dueDate" : "20200417",
     "paymentType" : "2",
     "paymentCode"  : "1",
     "note1" : "CIENTO TREINTA Y CUATRO MIL DOSCIENTOS CUARENTA PESOS",
     "note2" : "Esta es una nota en la factura",
     "period": {
          "startDate":"20200201",
          "startTime":"010000",
          "endDate":"20200228",
          "endTime":"010000"
     },
     "customer" : {
          "additionalAccountID":"1",
          "name":"Pepito Perez y Compania S.A.",
          "countryName":"Colombia",
          "countryCode":"CO",
          "city":"Bogotá D.C.",
          "countryEntity":"11",
          "countrySubentity":"11001",
          "addressLine":"Av 25 No. 8-47",
          "documentNumber":"900900651",
          "documentType":"31",
          "telephone":"3112196952",
          "email":"[email protected]",
          "emailStyle":"2"
     },
     "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",
           "standard": "999",
           "agency": "990",
           "code": "1000",
           "allowance":[
                {
                  "charge":"false",
                  "reasonCode":"11",
                  "description":"Es un super descuento por hoy",
                  "baseAmount":"100000.00",
                  "amount":"4000.00",
                  "percent":"4.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",
           "standard": "999",
           "agency": "990",
           "code": "1001"
         }
      ]
   },
   "additional":{
        "usuarios.ms":[
           {
             "tipoDoc":"CC",
             "numDoc":"51890041",
             "primerApellido":"PEREZ",
             "segundoApellido":"PERALTA",
             "primerNombre":"PEPITA",
             "otrosNombre":"",
             "tipoUsuario":"03",
             "tipoPlan":"02",
             "numeroAutorizacion":"202020",
             "numeroPoliza":"ABZ-212122",
             "elaboradoPor":"PEPE CARDONA"
           },
           {
             "tipoDocumento":"CC",
             "numeroIdentificacion":"51890042",
             "primerApellido":"PEREZ",
             "segundoApellido":"PERALTA",
             "primerNombre":"PEPITO",
             "otrosNombre":"",
             "tipoUsuario":"01",
             "tipoPlan":"01",
             "numeroAutorizacion":"A202020",
             "numeroPoliza":"ABZ-212112",
             "elaboradoPor":"PEPE CARDONA"
           }
        ],
        "adjuntos.ms":{
           "direccion":{
              "URL": "https:/ejemplo.archivos.com"
           }
         }     
     }
 }
Explicacion

Campos

Parámetro Descripción Tipo Obligatorio
rangeKey Identificador único, del rango de facturación a ser usado
Esta valor es el resultado del servicio: Obtener Rangos
cadena SI
issueDate Fecha de la factura
(YYYYMMDD) Ejemplo: 20200321
cadena SI
issueTime Hora de facturacion
(HHMMSS) Ejemplo: 175430
cadena SI
dueDate Fecha de vencimiento
(YYYYMMDD) Ejemplo: 20200421
cadena SI
paymentType Tipo de pago
Efectivo->1 / Credito->2
Por omisión el sistema supone Credito -> "2"
cadena NO
paymentCode Modalidades de Pago (Version M.S.)
consultar tabla
cadena NO
note1 Valor de la factura en letras cadena SI
note2 Nota para ser agregada en la factura cadena NO
note3 Nota para ser agregada en la factura cadena NO
note4 Nota para ser agregada en la factura cadena NO
period Período de facturacion objeto SI
customer Datos del cliente
Ir a: customer
objeto SI
amounts Totales del documento
Ir a: amounts
objeto SI
items Líneas de la factura
(Debe existir almenos una)
Ir a: items
objeto SI
additional Objeto con elementos complementarios para el sector salud
Objetos:
usuarios.ms
adjuntos.ms
objeto SI
Resultados

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

 {
   "invoiceResult":{
       "status":{
          "code":200,
          "text":"Operación realizada con exito"
       },
       "documento":{
          "type":"Factura",
          "mode":"Creation",
          "tascode":"fc-54984309jtr0ret90jjrg",
          "document":"FC-2092092",
          "CUFE":"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.