Remesas | A3ERP API

Consultar todas las remesas

get

Obtiene un listado de todas las remesas existentes.

Respuestas

200

Listado de remesas obtenido correctamente.

application/json

Respuestaobject

401

No autorizado

get

GET /api/cartera/remesas HTTP/1.1
Host: api.appcloud.es
Accept: */*

{}

Consultar remesa por ID

get

Obtiene los detalles de una remesa especifica mediante su ID.

Parámetros de ruta

idstringRequerido

ID de la remesa

Respuestas

200

Detalles de la remesa

application/json

Respuestaobject

401

No autorizado

404

Remesa no encontrada

get

GET /api/cartera/remesas/{id} HTTP/1.1
Host: api.appcloud.es
Accept: */*

{}

Consultar remesas por filtro

get

Obtiene un listado de remesas que cumplen con el filtro especificado.

Parámetros de ruta

filtrostringRequerido

Filtro para aplicar en la busqueda de remesas

Respuestas

200

Listado de remesas filtradas

application/json

Respuestaobject

get

GET /api/cartera/remesas/filtro/{filtro} HTTP/1.1
Host: api.appcloud.es
Accept: */*

200

Listado de remesas filtradas

{}

Consultar remesas ordenadas

get

Obtiene un listado de remesas ordenadas según el criterio especificado.

Parámetros de ruta

orderstringRequerido

Criterio de ordenamiento para las remesas

Respuestas

200

Listado de remesas ordenadas

application/json

Respuestaobject

get

GET /api/cartera/remesas/order/{order} HTTP/1.1
Host: api.appcloud.es
Accept: */*

200

Listado de remesas ordenadas

{}

Consultar remesas filtradas y ordenadas

get

Obtiene un listado de remesas que cumplen con el filtro especificado y estan ordenadas segun el criterio dado.

Parámetros de ruta

filtrostringRequerido

Filtro para aplicar en la búsqueda de remesas

orderstringRequerido

Criterio de ordenamiento para las remesas

Respuestas

200

Listado de remesas filtradas y ordenadas

application/json

Respuestaobject

get

GET /api/cartera/remesas/filtro/{filtro}/order/{order} HTTP/1.1
Host: api.appcloud.es
Accept: */*

200

Listado de remesas filtradas y ordenadas

{}

Crear una nueva remesa

post

Crea una nueva remesa indicando los efectos que formaran parte de la misma.

Cuerpo

escobrostring · enumOpcionalValores posibles:

descuestring · enumOpcionalValores posibles:

fechastring · dateOpcionalExample: 05/09/2023

codbanstringOpcionalExample: 1

codmonstringOpcionalExample: EURO

tipocontstringOpcionalExample: 1

tipomandatostring · enumOpcionalValores posibles:

Respuestas

201

Remesa creada correctamente

400

Datos de entrada incorrectos

401

No autorizado

post

POST /api/cartera/remesas/crear HTTP/1.1
Host: api.appcloud.es
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "escobro": "T",
  "descue": "T",
  "fecha": "05/09/2023",
  "codban": "1",
  "codmon": "EURO",
  "tipocont": "1",
  "tipomandato": "B2B",
  "Efectos": [
    {
      "NumCartera": "text",
      "NumVencimiento": "text"
    }
  ]
}

Sin contenido

Añadir Efectos a una Remesa

post

Endpoint para añadir nuevos efectos a una remesa ya existente

Parámetros de ruta

numremesastringRequerido

Numero de la remesa a la que se añadiran efectos

Cuerpo

Respuestas

200

Efectos añadidos correctamente a la remesa

application/json

400

Datos de entrada incorrectos

401

No autorizado

404

Remesa no encontrada

post

POST /api/cartera/remesas/anadeefectos/{numremesa} HTTP/1.1
Host: api.appcloud.es
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "Efectos": [
    {
      "NumCartera": "text",
      "NumVencimiento": "text"
    }
  ]
}

{
  "message": "Efectos añadidos correctamente."
}

Eliminar efectos de una remesa existente

post

Elimina efectos específicos de una remesa, asegurandose de que la remesa no quede sin efectos.

Parámetros de ruta

numremesastringRequerido

Numero de la remesa de la cual se eliminaran efectos

Cuerpo

Respuestas

200

Efectos eliminados correctamente de la remesa

application/json

400

Solicitud incorrecta, por ejemplo, intentar dejar la remesa sin efectos

401

No autorizado

404

Remesa no encontrada

post

POST /api/cartera/remesas/eliminaefectos/{numremesa} HTTP/1.1
Host: api.appcloud.es
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "Efectos": [
    {
      "NumCartera": "text",
      "NumVencimiento": "text"
    }
  ]
}

{
  "message": "Efectos eliminados correctamente."
}