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ámetroschevron-right

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)

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av', 'pv')

Respuestas
chevron-right
200

Lista de documentos

application/json
get
/documento/{tipo}

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 tomará por defecto el del cliente o el proveedor.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av', 'pv')

idintegerRequerido

Identificador del documento

modelostringRequerido

Modelo de impresión

Respuestas
chevron-right
200

Estadísticas del documento

application/json
documentostringOpcional
get
/documento/{tipo}/impresion/{id}/modelo/{modelo}

Recuperar la cabecera de un documento

get

Devuelve la cabecera del documento indicado por su tipo e id.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av', 'pv')

idintegerRequerido

Identificador del documento

Respuestas
chevron-right
200

Cabecera del documento

application/json
idpedvintegerOpcional
tipocontstringOpcional
seriestringOpcional
numdocintegerOpcional
codclistringOpcional
nomclistringOpcional
nifclistringOpcional
fechastring · dateOpcional
referenciastringOpcional
basemonedanumberOpcional
totivamonedanumberOpcional
totdocnumberOpcional
situacionstringOpcional
centrocostestringOpcional
centrocoste2stringOpcional
centrocoste3stringOpcional
codrepstringOpcional
codrep2string · nuloOpcional
codrep3string · nuloOpcional
codalmstringOpcional
regivastringOpcional
situaciondetallestringOpcional
docpagstringOpcional
forpagstringOpcional
ivaincluidostringOpcional
numdirintegerOpcional
get
/cabeceradocumento/{tipo}/{id}

Servir documentos

get

Se puede servir a pedido, albarán o factura.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

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

servirstringRequerido

servirapedido, serviraalbaran, servirafactura, serviradeposito

Respuestas
chevron-right
200

documento servido

application/json
Identificador stringOpcional
get
/documento/{tipo}/{servir}/{id}

Impresión de documentos por GUID. Si necesitas un modelo concreto, añade al endpoint /modelo/{modelo}

get

Permite la impresión de documentos públicos utilizando un GUID. El GUID se obtiene del parámetro de las cabeceras API_GUIDDESCARGA.

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

guidstringRequerido

Identificador del documento público

Respuestas
chevron-right
200

documento servido

application/json
DocumentostringOpcional
get
/documento/{tipo}/impresionguid/{guid}

Llamadas POST

Crear un nuevo documento

post

Crea un nuevo documento de compra o venta. En el cuerpo del mensaje se deben indicar los datos del documento en formato JSON. Si es un documento de compra debes añadir código proveedor (codpro). Y en algunos casos como pedido de compra la fecha de entrega (fecentrega)

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

Cuerpo
Respuestas
chevron-right
200

Se ha creado el documento correctamente

application/json
idstringOpcional
post
/documento/{tipo}

Servir lineas

post

Se puede servir líneas a pedido, albarán o factura.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
servirstringRequerido

servirlineasapedido, servirlineasaalbaran, servirlineasadeposito

Cuerpo
fechastringRequeridoExample: 13/06/2025
codigostringRequerido

Código proveedor/cliente

tipostring · enumRequerido

Compra o Venta (C/V)

Valores posibles:
Respuestas
chevron-right
200

documento servido

application/json
Identificador stringOpcional
post
/{servir}

Enviar documento por email en formato PDF

post

Envía un documento por email en formato PDF utilizando el modelo especificado.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av', 'pv')

idintegerRequerido

Identificador del documento

modelostringRequerido

Modelo de impresión para el PDF TODO

Cuerpo
parastringOpcional

Dirección de correo del destinatario

ccstringOpcional

Dirección de correo en copia

ccoostringOpcional

Dirección de correo en copia oculta

titulostringOpcional

Título del correo

asuntostringOpcional

Asunto del correo

textostringOpcional

Texto del correo

cuerpostringOpcional

Cuerpo del correo en formato HTML

Respuestas
chevron-right
200

Documento enviado por email correctamente

Sin contenido

post
/documento/{tipo}/email/{id}/modelo/{modelo}

Sin contenido

chevron-rightBody de Envio de documento por email en PDFhashtag

Enviar una factura de venta por email

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

chevron-rightBody de Servir documentoshashtag

Servir un albaran

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

Vincular adjunto a un documento

post

Podemos vincular un adjunto que nos pasen en un JSON a un documento de compra o venta. El archivo se guardará en la carpata 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.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

Cuerpo
nombrestringOpcional

Nombre del documento

DocumentostringOpcional

Documento en base64

Respuestas
chevron-right
200

Se ha vinculado el documento

application/json
DocumentostringOpcional
post
/documento/{tipo}/vincular/{id}

Vincular adjunto a la línea de un documento

post

Permite vincular un adjunto a la línea de un documento

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

lineaintegerRequerido

Identificador de la línea a vincular

Cuerpo
nombrestringOpcional

Nombre del documento

descripcionstringOpcional

Descripción del documento

DocumentostringOpcional

Documento en base64

Respuestas
chevron-right
200

Se ha vinculado la línea al documento

application/json
DocumentostringOpcional
post
/documento/{tipo}/vincularlinea/${linea}
chevron-rightBody de Vincular archivos a un documentohashtag

Vincular un contrato a una factura

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

Anular un documento

post

Anular un documento completo identificándolo por su id.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

Respuestas
chevron-right
200

Se ha anulado la línea del documento

application/json
DocumentostringOpcional
post
/documento/{tipo}/anular/{id}

Anular todas las líneas de un documento

post

En un documento con varias líneas, se puede anular una línea

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento público

numlinintegerRequerido

Identificador de la línea a anular

Respuestas
chevron-right
200

Se ha anulado la línea del documento

application/json
DocumentostringOpcional
post
/documento/{tipo}/anular/{id}/linea/{numlin}

Anular varias unidades de línea

post

Anular varias unidades de línea en un documento

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

numlinintegerRequerido

Identificador de la línea a anular

unidadesintegerRequerido

Unidades a anular de la línea

Respuestas
chevron-right
200

Se han anulado correctamente las unidades de la línea.

application/json
DocumentostringOpcional
post
/documento/{tipo}/anular/{id}/linea/{numlin}/unidades/{unidades}
chevron-rightBody de Alta de nuevo documentohashtag

Alta de un traspaso

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

Llamadas PUT

Actualizar un documento existente

put

Actualiza un documento de compra o venta existente.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

Cuerpo
Respuestas
chevron-right
200

Se ha actualizado el documento correctamente

application/json
idstringOpcional
put
/documento/{tipo}/{id}

Crear nuevas líneas en un documento existente

put

Nuevo endpoint para poder crear nuevas líneas en un documento ya existente

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

Cuerpo
Respuestas
chevron-right
200

Se ha eliminado la linea de componente de el deposito de venta

application/json
idstringOpcional
put
/documento/{tipo}/nuevaslineas/{id}

Añadir nuevo detalle de línea

put

Añadir un nuevo detalle a la línea de un documento.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

numlinintegerRequerido

Número de la línea, no es el identificador (camp. numlin)

Cuerpo
UnidadesstringOpcional

Es importante actualizar este número para que coincida con el total de unidades del detalle

Respuestas
chevron-right
200

Se ha actualizado el detalle.

application/json
DocumentostringOpcional
put
/documento/{tipo}/nuevosdetalleslinea/iddocumento/{id}/numlin/{numlin}

Añadir nuevos componentes a una línea

put

Añade componentes a la línea de un documento. Para que un artículo tenga componentes, es necesario que en su estructura se indique que es KIT.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

numlinintegerRequerido

Número de la línea, no es el identificador (camp. numlin)

Cuerpo
Respuestas
chevron-right
200

Se han actualizado los componentes .

application/json
DocumentostringOpcional
put
/documento/{tipo}/nuevoscomponenteslinea/iddocumento/{id}/numlin/{numlin}
chevron-rightBody de Modificar un documentohashtag

Modificar un pedido

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

Llamadas DELETE

Eliminación de documentos

delete

Elimina un documento identificándolo por su tipo e id.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv', 'av')

idintegerRequerido

Identificador del documento

Respuestas
chevron-right
200

Se ha eliminado el documento correctamente

Sin contenido

delete
/documento/{tipo}/{id}

Sin contenido

Eliminación de lineas de documentos

delete

Elimina la línea de un documento identificándola por el id del documento y el idlin de la línea.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv')

idintegerRequerido

Identificador del documento

numlinintegerRequerido

Identificador de la línea a borrar

Respuestas
chevron-right
200

Se ha eliminado la linea de el deposito de venta

Sin contenido

delete
/documento/{tipo}/{id}/linea/{numlin}

Sin contenido

Para eliminar componentes de la línea

delete

Elimina un componente de una línea de un documento identificándola por el id del documento y el Idlin de la línea.

Autorizaciones
AuthorizationstringRequerido

Utiliza un token JWT para autenticarte. El token debe ser enviado en el encabezado Authorization

Parámetros de ruta
tipostringRequerido

Tipo de documento (e.g., 'dv', 'fv')

idintegerRequerido

Identificador del documento

numlinintegerRequerido

Identificador de la línea a borrar

Respuestas
chevron-right
200

Se ha eliminado la linea de componente de el deposito de venta

Sin contenido

delete
/documento/{tipo}/{id}/componentelinea/{numlin}

Sin contenido

Última actualización