Documento

Acceso a datos de todos los documentos de a3ERP (compras, ventas y stocks)

Parámetros

Puedes consultar todos los tipos de documentos en el enlace de abajo.

Parámetros

Campos de Documentos

En el siguiente enlace puedes consultar todos los campos de A3.

Llamadas GET

Filtrado

En el siguiente enlace puedes consultar como filtrar esta llamada.

Recuperar todos los datos del documento

get

Te devuelve todos los datos del documento indicado(Consultar parámetros para ver los documentos disponibles).

Ejemplo:

https://servidor:5555/api/documento/PV

Parámetros de ruta

tipostringRequerido

El tipo de documento

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/documento/{tipo} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devuelve un Array Objetos con todos los datos del documento

Sin contenido

Impresión en PDF

get

Se puede solicitar la impresión de un documento en PDF mediante esta llamada, el modelo no es obligatorio pero al no indicarlo tomara por defecto el del cliente o el proveedor.

Ejemplo:

https://servidor:5555/api/documento/PV/impresion/50

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento

modelostringRequerido

El modelo del documento

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/documento/{tipo}/impresion/{id}/modelo/{modelo} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devolverá un Array Objeto con el documento en base64

[
  {
    "documento": "text"
  }
]

Anulación de documento

get

Podemos anular un documento completamente o anular una de sus líneas.

Ejemplo:

https://servidor:5555/api/documento/PV/anular/50/linea/13

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento a anular

numlinstringRequerido

La linea del documento a anular

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/documento/{tipo}/anular/{id}/linea/{numlin} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Se ha anulado correctamente el documento

Sin contenido

Cabeceras de documento

get

Al añadir a la ruta /{id} permite elegir una cabecera de documentos en concreto y no el listado de todos las cabeceras de documento.

Ejemplo:

https://servidor:5555/api/cabeceradocumento/PV/50

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento a anular

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/cabeceradocumento/{tipo}/{id} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devuelve la cabecera de un documento en concreto

Sin contenido

Llamadas POST

Envio de documento por email en PDF

post

Se puede enviar un documento a un correo con los datos proporcionados en un JSON, el modelo no es obligatorio pero al no indicarlo tomara por defecto el del cliente o el proveedor.

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento

modelostringRequerido

El modelo del documento

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo

Respuestas

post

HTTPcURLJavaScriptPython

POST /api/documento/{tipo}/email/{id}/modelo/{modelo} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "json": {
    "para": "text",
    "cc": "text",
    "ccoo": "text",
    "titulo": "text",
    "asunto": "text",
    "texto": "text",
    "cuerpo": "text"
  }
}

200

Correo enviado correctamente

Sin contenido

Body de Envio de documento por email en PDF

Enviar una factura de venta por email

https://servidor:5555/api/documento/FV/email/5767

{
    "para": "[e-mail]",
    "cc": "[e-mail]",
    "cco": "[e-mail]",
    "titulo": "Envio con documento adjunto",
    "asunto": "Envio documento",
    "texto": "Adjunto envío su documento en pdf",
    "cuerpo": "<HTML><HEAD></HEAD><BODY lang=ES> Estimado cliente,<p> Adjunto archivo con documento en formato pdf.<p> La mercanc&#237;a, antes de su salida, ha sido fotografiada. <p> Un saludo,<p> <b> Rosario Pérez<p> rpé[e-mail]<p> JNC Sistemas Inform&#225;ticos<p> </b></font> </BODY></HTML>"
}

Servir documentos

post

Se puede servir a pedido, albarán o factura y también líneas a pedidos o albaranes. Cuando se sirven lineas no se pone el tipo ni el id pues esta informacion va en el json.

Parámetros de ruta

tipostringRequerido

El tipo de documento, si son líneas no hay que ponerlo

servirstringRequerido

servirapedido, serviraalbaran, servirafactura, servirlineasapedido, servirlineasaalbaran

idstringRequerido

El documento a servir, si son líneas no hay que ponerlo

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo

Respuestas

post

HTTPcURLJavaScriptPython

POST /api/documento/{tipo}/{servir}/{id} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "json": {
    "fecha": "text",
    "codigo": "text",
    "tipo": "text",
    "lineas": [
      {
        "tipo": "text",
        "iddocumento": "text",
        "numlin": "text",
        "unidades": "text",
        "lote": "text"
      }
    ]
  }
}

200

Documento servido

Sin contenido

Body de Servir documentos

Servir un albaran

https://servidor:5555/api/documento/AV/servirafactura/55

{
 "fecha": "21/04/2022",
 "codigo": " 1",
 "tipo": "C",
 "lineas":
        [
          {
           "tipo": "O",
           "iddocumento": "166",
           "numlin": "3", 
           "unidades": "3",
           "lote": "L145"
          },
          {
           "tipo": "O",
           "iddocumento": "164",
           "numlin": "4",
           "unidades": "10",
           "feccaduc": "22/04/2022",
           "numserie": "14528798"
          },
          {
           "tipo": "O",
           "iddocumento": "165",
           "numlin": "4",
           "unidades": "2",
           "ubicacion": "A2P3L8"
          }
        ]
}

Vincular archivos a un documento

post

Podemos vincular un archivo que nos pasen en un JSON a un documento de compra o venta. El archivo se guardará en la carpeta de vínculos indicada en el config.ini con el nombre y la extensión que le pasemos en el campo nombre, lo cual determinará el tipo de archivo.

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento al que quieres vincular un archivo

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo

Respuestas

post

HTTPcURLJavaScriptPython

POST /api/documento/{tipo}/vincular/{id} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "json": {
    "nombre": "text",
    "documento": "text"
  }
}

200

Vinculado correctamente {Tipo de documento}

Sin contenido

Body de Vincular archivos a un documento

Vincular un contrato a una factura

https://servidor:5555/api/documento/FV/vincular/89

{
    "nombre": "contrato.pdf",
    "documento": "Contrato de compra venta"
}

Alta de nuevo documento

post

Podemos dar de alta un nuevo documento añadiendo un JSON con todos los parámetros del tipo de documento seleccionado.

Parámetros de ruta

tipostringRequerido

El tipo de documento

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo

Respuestas

post

HTTPcURLJavaScriptPython

POST /api/documento/{tipo} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "json": {
    "codalment": "text",
    "codalmsal": "text",
    "fecha": "text",
    "motivo": "text",
    "ico_codcli": "text",
    "ico_centro_coste": "text",
    "ico_envuelo": "text",
    "lineas": [
      {
        "codalment": "text",
        "codalmsal": "text",
        "codart": "text",
        "unidades": "text",
        "detalle": [
          {
            "unidades": "text",
            "feccaduc": "text",
            "ubicacionSal": "text",
            "ubicacionent": "text",
            "numserie": "text"
          }
        ]
      }
    ]
  }
}

200

Se ha creado el {tipo de documento}

{
  "nombre codigo documento": "text"
}

Body de Alta de nuevo documento

Alta de un traspaso

https://servidor:5555/api/documento/TR

[
{
  "codalment": "       2",
  "codalmsal": "       1",
  "fecha": "15/07/2022",
  "motivo": "Alta de traspaso 1",
  "lineas": [
    {
      "codalment": "       2",
      "codalmsal": "       1",
      "codart": "RF",
      "unidades": 2,
      "detalle": [
        {
          "unidades": "1",
          "feccaduc": "30/12/1899",
          "ubicacionsal": "P1E1A2",
          "ubicacionent": "T4",
          "numserie": "RMNU73HKNV"
        },
        {
          "unidades": "1",
          "feccaduc": "30/12/1899",
          "ubicacionsal": "P1E1A2",
          "ubicacioneent": "T4",
          "numserie": "3332KBG5GH"
        }
      ]
    },
    {
      "codalment": "       2",
      "codalmsal": "       1",
      "codart": "LR",
      "unidades": 4,
      "detalle": [
        {
          "unidades": "4",
          "feccaduc": "30/12/1899",
          "ubicacionsal": "P1E1A1",
          "ubicacionent": "T4"
        }
      ]
    },
    {
      "codalment": "       2",
      "codalmsal": "       1",
      "codart": "              1",
      "unidades": 1,
      "detalle": [
        {
          "unidades": "1",
          "feccaduc": "30/12/1899",
          "ubicacionsal": "P1E2A2",
          "ubicacionent": "T4",
          "numserie": "R8E5J4T8MC"
        }
      ]
    }
  ]
}
]

Llamadas PUT

Modificar un documento

put

Podemos modificar un documento añadiendo un JSON con los parámetros correspondientes, no hay ningún parámetro requerido.

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento que quieres modificar

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo

Respuestas

put

HTTPcURLJavaScriptPython

PUT /api/documento/{tipo}/{id} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "json": {
    "fecha": "text",
    "codcli": "text",
    "serie": "text",
    "codalm": "text",
    "fecentrega": "text",
    "lineas": [
      {
        "numlinped": "text",
        "codart": "text",
        "unidades": "text",
        "prcmoneda": "text",
        "desc1": "text"
      }
    ]
  }
}

200

Se ha actualizado el {documento}

{
  "nombre codigo de documento": "text"
}

Body de Modificar un documento

Modificar un pedido

https://servidor:5555/api/documento/PV/65

[
    {
    "fecha": "01/09/2021",
     "codcli": "12",
     "serie": "2022",
     "codalm": " 1",
     "fecentrega": "02/09/2021",
     "lineas":[
            { "numlinped": "1",
              "codart": "3",
              "unidades": "4",
              "prcmoneda": "33",
              "desc1": "10"
            },
            { "numlinped": "2",
              "codart": "4C",
              "unidades": "5",
              "prcmoneda": "24",
              "desc1": "15"
            }
            ]
    }
]

Llamadas DELETE

Eliminación de un documento

delete

Ejemplo:

https://servidor:5555/api/documento/PV/50

Parámetros de ruta

tipostringRequerido

El tipo de documento

idstringRequerido

El identificador del documento que quieres modificar

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

delete

HTTPcURLJavaScriptPython

DELETE /api/documento/{tipo}/{id} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Eliminacion de documento satisfactoria

Sin contenido