Endpoint Proveedores
Lista de proveedores
Method: GET URI: /api/v1/proveedores
Este endpoint permite obtener un listado de proveedores según los parámetros de búsqueda y ordenación.
Request
- Headers
- Content-Type: application/json
- token: <string>
- secret:<string>
- Params
- sort_column: campo por el que ordenar. Podrá ser: codigo, razon_social o razon_fiscal. Por defecto será codigo.
- sort_type: indica el si la ordenación es ascendente o descendente. Podrá ser: asc o desc. Por defecto será asc.
- paginate_by: número de registros a mostrar. El mínimo será 1 y el máximo 100. Por defecto serán 10.
- page: número de página a mostrar. Por defecto será 1.
- codigo: valor a buscar en el campo codigo. La búsqueda se hará de forma exacta.
- razon_fiscal: valor a buscar en el campo razon_fiscal. La búsqueda se hará con un contiene.
- razon_social: valor a buscar en el campo razon_social. La búsqueda se hará con un contiene.
- nif: valor a buscar en el campo documento. La búsqueda se hará de forma exacta.
Response 1: 200: existen datos
{
"status": 200,
"page": 1,
"paginate_by": 10,
"records": 1000,
"data": [
{
"id": 1,
"codigo": "001",
"razon_fiscal": "proveedor uno",
"razon_social": "proveedor uno",
"nif": "12345678Z"
},
{
"id": 2,
"codigo": "002",
"razon_fiscal": "proveedor dos",
"razon_social": "proveedor dos",
"nif": "11111111A"
}
]
}
Response 2: 200: no existen datos
{
"status": 200,
"page": 1,
"paginate_by": 10,
"records": 0,
"data": []
}
Response 3: 400: petición errónea
{
"status": 400,
"error": "Error en la Petición"
}
Response 4: 402: petición no autorizada
{
"status": 402,
"error": "No autorizado"
}
Prueba la API de tu instalación aquí
Detalle de proveedor
Method: GET URI: /api/v1/proveedores
Este endpoint permite obtener el detalle del proveedor cuyo id coincide con el parámetro suministrado.
Request
- Headers
- Content-Type: application/json
- token: <string>
- secret:<string>
- Params
- id: identificador del proveedor a mostrar.
Response 1: 200: existen datos
{
"status": 200,
"data": {
"id": 10,
"codigo": "010",
"razon_fiscal": "Proveedor diez",
"razon_social": "Proveedor diez",
"documento": "12345678Z",
"pais": "España",
"provincia": "Huelva",
"municipio": "Punta Umbría",
"direccion": "Calle Ancha",
"numero": "5",
"codigo_postal": "21100",
"nucleo": "Punta Umbría",
"bloque": null,
"planta": null,
"puerta": null,
"letra": null,
"otros": null,
"email": null,
"telefono": "959333333",
"fax": "959333333",
"descuento": 10.00,
"tipo_iva": {
"id": 1,
"iva": 21.00,
"re": 5.20
},
"modalidad_fiscal": {
"id": 0,
"nombre": "Régimen General"
},
"regimen_fiscal": {
"id": 0,
"nombre": "Iva"
},
"forma_pago": {
"id": 30,
"nombre": "Transferencia a 30 días"
},
"irpf": 0.00,
"clave_precepcion": null,
"cta_contable": "400000010",
"cta_contable_anticipo": "408000010",
"cta_contable_cartera": "401000010",
"cta_contable_gastos": "600000000",
"dia_pago_1": 10,
"dia_pago_2": null,
"observaciones": "observaciones del cliente",
"contactos": [
{
"id": 1,
"nombre": "Juan",
"email": "juan@email.com",
"telefono": "959404040",
"cargo": "Contable",
"departamento": "Financiero"
},
...
],
"cuentas_bancarias": [
{
"id": 1,
"iban": "ES8701289846382194853513",
"bic": "BKBKESMMXXX",
"activa": 1,
"defecto": 1
},
...
]
}
}
Response 2: 404: no existen datos
{
"status": 404,
"error": "Proveedor no existe"
}
Response 3: 400: petición errónea
{
"status": 400,
"error": "Error en la Petición"
}
Response 4: 402: petición no autorizada
{
"status": 402,
"error": "No autorizado"
}
Prueba la API de tu instalación aquí