API REST de Bleno

Conecte con Bleno los formularios de su web, portales de solicitudes, relojes de fichaje o su propio software: cree clientes, proyectos y solicitudes, consulte presupuestos y facturas y transfiera registros de horas.

Versión 1.0.0

La referencia de la API de abajo se genera a partir de la especificación. La especificación JSON describe los campos en alemán.

Autenticación

API REST para clientes, proyectos, solicitudes, presupuestos/facturas, registros de horas y webhooks de una empresa en Bleno.

Autenticación con clave API (Authorization: Bearer bleno_…). Cada clave lleva scopes por recurso (read/write); si falta un scope, la respuesta es 403.

Límite de peticiones: 60 llamadas por clave cada 60 segundos; por encima, 429 con Retry-After.

Los administradores crean una clave en «Einstellungen → API & Webhooks» (Ajustes) y eligen allí los scopes. La clave se muestra una sola vez. Los datos de otras empresas nunca son accesibles: los ID de otra empresa devuelven 404 igual que los desconocidos y, usados como filtro, una lista vacía.

La descripción legible por máquinas para generadores de código y herramientas de API: Especificación OpenAPI (JSON, descripciones en alemán)

curl https://bleno.de/api/v1/customers \
  -H "Authorization: Bearer bleno_…"
Scopes
ÁmbitoLecturaEscritura
Clientescustomers:readcustomers:write
Proyectosprojects:readprojects:write
Solicitudesleads:readleads:write
Documentosdocuments:readdocuments:write
Registros de horastime_entries:readtime_entries:write
Webhookswebhooks:readwebhooks:write

Clientes

Consultar, crear y modificar los clientes de la empresa.

GET/api/v1/customers

Listar clientes

Por páginas; los clientes archivados solo con include_archived=true.

Scope necesario: customers:read.

Scope: customers:read

Parámetros
CampoTipoObligatorioNotas
limit(query)integernoPor defecto: 50 · mín. 1 · máx. 100
offset(query)integernoPor defecto: 0 · mín. 0
include_archived(query)"true" | "false"noPor defecto: "false"

Respuestas

  • 200 Lista de clientes.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobject[]sí
data[].idstring (uuid)sí
data[].customer_numberstring | nullsí
data[].customer_type"company" | "private"sí
data[].salutation"herr" | "frau" | nullsí
data[].company_namestring | nullsí
data[].first_namestring | nullsí
data[].last_namestring | nullsí
data[].display_namestringsí
data[].emailstring | nullsí
data[].phonestring | nullsí
data[].mobile_phonestring | nullsí
data[].faxstring | nullsí
data[].address_streetstring | nullsí
data[].address_zipstring | nullsí
data[].address_citystring | nullsí
data[].tax_idstring | nullsí
data[].notesstring | nullsí
data[].is_archivedbooleansí
data[].created_atstringsí
data[].updated_atstring | nullsí
paginationobjectsí
pagination.limitintegersí
pagination.offsetintegersí
pagination.totalintegersí
POST/api/v1/customers

Crear un cliente

Sin customer_type: con razón social, una empresa; si no, un particular. Campos obligatorios como en el formulario de clientes.

Scope necesario: customers:write.

Scope: customers:write

Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
customer_type"company" | "private"no
salutation"herr" | "frau" | nullno
company_namestring | nullnocomo máximo 200 caracteres
first_namestring | nullnocomo máximo 100 caracteres
last_namestring | nullnocomo máximo 100 caracteres
emailstring (email) | "" | cualquiera | nullno
customer_numberstring | nullnocomo máximo 50 caracteres
phonestring | nullnocomo máximo 50 caracteres
mobile_phonestring | nullnocomo máximo 50 caracteres
faxstring | nullnocomo máximo 50 caracteres
address_streetstring | nullnocomo máximo 200 caracteres
address_zipstring | nullnocomo máximo 20 caracteres
address_citystring | nullnocomo máximo 100 caracteres
tax_idstring | nullnocomo máximo 50 caracteres
notesstring | nullnocomo máximo 5000 caracteres

Respuestas

  • 201 Cliente creado.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 409 Conflicto, p. ej. número de cliente o de proyecto duplicado o un registro de horas ya facturado.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 201
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.customer_numberstring | nullsí
data.customer_type"company" | "private"sí
data.salutation"herr" | "frau" | nullsí
data.company_namestring | nullsí
data.first_namestring | nullsí
data.last_namestring | nullsí
data.display_namestringsí
data.emailstring | nullsí
data.phonestring | nullsí
data.mobile_phonestring | nullsí
data.faxstring | nullsí
data.address_streetstring | nullsí
data.address_zipstring | nullsí
data.address_citystring | nullsí
data.tax_idstring | nullsí
data.notesstring | nullsí
data.is_archivedbooleansí
data.created_atstringsí
data.updated_atstring | nullsí
GET/api/v1/customers/{id}

Consultar un cliente

Scope necesario: customers:read.

Scope: customers:read

Parámetros
CampoTipoObligatorioNotas
id(ruta)string (uuid)sí

Respuestas

  • 200 Cliente.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.customer_numberstring | nullsí
data.customer_type"company" | "private"sí
data.salutation"herr" | "frau" | nullsí
data.company_namestring | nullsí
data.first_namestring | nullsí
data.last_namestring | nullsí
data.display_namestringsí
data.emailstring | nullsí
data.phonestring | nullsí
data.mobile_phonestring | nullsí
data.faxstring | nullsí
data.address_streetstring | nullsí
data.address_zipstring | nullsí
data.address_citystring | nullsí
data.tax_idstring | nullsí
data.notesstring | nullsí
data.is_archivedbooleansí
data.created_atstringsí
data.updated_atstring | nullsí
PATCH/api/v1/customers/{id}

Modificar un cliente

Solo cambian los campos enviados; null vacía un campo.

Scope necesario: customers:write.

Scope: customers:write

Parámetros
CampoTipoObligatorioNotas
id(ruta)string (uuid)sí
Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
customer_type"company" | "private"no
salutation"herr" | "frau" | nullno
company_namestring | nullnocomo máximo 200 caracteres
first_namestring | nullnocomo máximo 100 caracteres
last_namestring | nullnocomo máximo 100 caracteres
emailstring (email) | "" | cualquiera | nullno
customer_numberstring | nullnocomo máximo 50 caracteres
phonestring | nullnocomo máximo 50 caracteres
mobile_phonestring | nullnocomo máximo 50 caracteres
faxstring | nullnocomo máximo 50 caracteres
address_streetstring | nullnocomo máximo 200 caracteres
address_zipstring | nullnocomo máximo 20 caracteres
address_citystring | nullnocomo máximo 100 caracteres
tax_idstring | nullnocomo máximo 50 caracteres
notesstring | nullnocomo máximo 5000 caracteres

Respuestas

  • 200 Cliente modificado.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 409 Conflicto, p. ej. número de cliente o de proyecto duplicado o un registro de horas ya facturado.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.customer_numberstring | nullsí
data.customer_type"company" | "private"sí
data.salutation"herr" | "frau" | nullsí
data.company_namestring | nullsí
data.first_namestring | nullsí
data.last_namestring | nullsí
data.display_namestringsí
data.emailstring | nullsí
data.phonestring | nullsí
data.mobile_phonestring | nullsí
data.faxstring | nullsí
data.address_streetstring | nullsí
data.address_zipstring | nullsí
data.address_citystring | nullsí
data.tax_idstring | nullsí
data.notesstring | nullsí
data.is_archivedbooleansí
data.created_atstringsí
data.updated_atstring | nullsí

Proyectos

Consultar y crear proyectos.

GET/api/v1/projects

Listar proyectos

Todos los proyectos no archivados con cliente y estado, ordenados por nombre.

Scope necesario: projects:read.

Scope: projects:read

Respuestas

  • 200 Lista de proyectos.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
projectsobject[]sí
projects[].idstring (uuid)sí
projects[].namestringsí
projects[].status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sí
projects[].customerobject | nullsí
projects[].customer.idstring (uuid)sí
projects[].customer.namestringsí
POST/api/v1/projects

Crear un proyecto

Si la empresa usa números de proyecto automáticos, Bleno asigna el número siguiente cuando no se envía ninguno.

Scope necesario: projects:write.

Scope: projects:write

Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
namestringsíal menos 1 caracteres · como máximo 200 caracteres
customer_idstring (uuid)sí
descriptionstring | nullnocomo máximo 5000 caracteres
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"no
project_type"fixed_fee" | "time_and_materials" | "non_billable"no
project_numberstring | nullnocomo máximo 60 caracteres
start_datestring | nullnoPatrón ^\d{4}-\d{2}-\d{2}$
end_datestring | nullnoPatrón ^\d{4}-\d{2}-\d{2}$
address_streetstring | nullnocomo máximo 200 caracteres
address_zipstring | nullnocomo máximo 20 caracteres
address_citystring | nullnocomo máximo 100 caracteres

Respuestas

  • 201 Proyecto creado.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 409 Conflicto, p. ej. número de cliente o de proyecto duplicado o un registro de horas ya facturado.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 201
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.namestringsí
data.project_numberstring | nullsí
data.status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sí
data.project_type"fixed_fee" | "time_and_materials" | "non_billable" | nullsí
data.customer_idstring (uuid)sí
data.descriptionstring | nullsí
data.start_datestring | nullsí
data.end_datestring | nullsí
data.address_streetstring | nullsí
data.address_zipstring | nullsí
data.address_citystring | nullsí
data.created_atstringsí

Solicitudes

Crear solicitudes desde formularios web y portales.

POST/api/v1/leads

Crear una solicitud

Para formularios web y portales de solicitudes. Las solicitudes nuevas empiezan con el estado new y el origen website.

Scope necesario: leads:write.

Scope: leads:write

Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
namestringsíal menos 1 caracteres · como máximo 200 caracteres
emailstring (email) | "" | cualquiera | nullno
phonestring | nullnocomo máximo 50 caracteres
notesstring | nullnocomo máximo 5000 caracteres
customer_idstring (uuid) | nullno
external_referencestring | nullnocomo máximo 200 caracteres

Respuestas

  • 201 Solicitud creada.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 201
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.namestringsí
data.emailstring | nullsí
data.phonestring | nullsí
data.notesstring | nullsí
data.status"new" | "contacted" | "quote_sent" | "won" | "lost"sí
data.source"whatsapp" | "voice" | "test" | "website" | nullsí
data.customer_idstring (uuid) | nullsí
data.project_idstring (uuid) | nullsí
data.external_referencestring | nullsí
data.created_atstringsí

Documentos

Consultar presupuestos y facturas con estado, importes y enlace al PDF.

GET/api/v1/documents

Listar presupuestos y facturas

Filtrable por tipo, estado, cliente y proyecto. La lista no contiene enlaces a PDF.

Scope necesario: documents:read.

Scope: documents:read

Parámetros
CampoTipoObligatorioNotas
limit(query)integernoPor defecto: 50 · mín. 1 · máx. 100
offset(query)integernoPor defecto: 0 · mín. 0
type(query)"quote" | "invoice"no
status(query)"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"no
customer_id(query)string (uuid)no
project_id(query)string (uuid)no

Respuestas

  • 200 Lista de documentos.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobject[]sí
data[].idstring (uuid)sí
data[].numberstring | nullsí
data[].type"quote" | "invoice"sí
data[].invoice_kind"partial" | "final" | nullsí
data[].status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sí
data[].datestring | nullsí
data[].due_datestring | nullsí
data[].currencystringsí
data[].net_amountnumber | nullsí
data[].tax_ratenumber | nullsí
data[].tax_amountnumber | nullsí
data[].gross_amountnumber | nullsí
data[].customer_idstring (uuid) | nullsí
data[].project_idstring (uuid) | nullsí
data[].has_pdfbooleansí
data[].created_atstringsí
data[].updated_atstring | nullsí
paginationobjectsí
pagination.limitintegersí
pagination.offsetintegersí
pagination.totalintegersí
GET/api/v1/documents/{id}

Consultar un presupuesto o una factura

Con enlace al PDF: de duración limitada, y al abrirlo Bleno pide el código postal del cliente.

Scope necesario: documents:read.

Scope: documents:read

Parámetros
CampoTipoObligatorioNotas
id(ruta)string (uuid)sí

Respuestas

  • 200 Documento.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.numberstring | nullsí
data.type"quote" | "invoice"sí
data.invoice_kind"partial" | "final" | nullsí
data.status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sí
data.datestring | nullsí
data.due_datestring | nullsí
data.currencystringsí
data.net_amountnumber | nullsí
data.tax_ratenumber | nullsí
data.tax_amountnumber | nullsí
data.gross_amountnumber | nullsí
data.customer_idstring (uuid) | nullsí
data.project_idstring (uuid) | nullsí
data.has_pdfbooleansí
data.created_atstringsí
data.updated_atstring | nullsí
data.pdfobject | nullsí
data.pdf.urlstring (uri)sí
data.pdf.expires_atstringsí
data.pdf.requires_postal_codetruesí

Registros de horas

Consultar registros de horas y transferirlos desde terminales o sistemas externos.

GET/api/v1/time-entries

Listar registros de horas

Registros del periodo de from a to, opcionalmente de un solo empleado.

Scope necesario: time_entries:read.

Scope: time_entries:read

Parámetros
CampoTipoObligatorioNotas
from(query)stringsíPatrón ^\d{4}-\d{2}-\d{2}$
to(query)stringsíPatrón ^\d{4}-\d{2}-\d{2}$
user_id(query)string (uuid)no
limit(query)integernoLos valores superiores a 500 se limitan a 500. · Por defecto: 200 · mín. 1 · máx. 500
offset(query)integernoPor defecto: 0 · mín. 0

Respuestas

  • 200 Registros de horas.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
entriesobject[]sí
entries[].idstring (uuid)sí
entries[].user_idstring (uuid) | nullsí
entries[].project_idstring (uuid)sí
entries[].datestringsí
entries[].start_timestring | nullsí
entries[].end_timestring | nullsí
entries[].break_minutesintegersí
entries[].duration_minutesintegersí
entries[].work_type"arbeiten" | "laden" | "fahren" | "pause"sí
entries[].descriptionstring | nullsí
entries[].is_billableboolean | nullsí
entries[].status"pending" | "approved" | "rejected" | "invoiced"sí
entries[].external_sourcestring | nullsí
entries[].external_idstring | nullsí
entries[].projectobject | nullsí
entries[].project.idstring (uuid)sí
entries[].project.namestringsí
has_morebooleansí
POST/api/v1/time-entries

Transferir un registro de horas

O bien duration_minutes, o bien start_time y end_time. Con external_source y external_id, una nueva llamada actualiza el mismo registro en lugar de crear un segundo. La aprobación la decide la empresa.

Scope necesario: time_entries:write.

Scope: time_entries:write

Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
user_idstring (uuid)sí
project_idstring (uuid)sí
datestringsíPatrón ^\d{4}-\d{2}-\d{2}$
work_type"arbeiten" | "laden" | "fahren" | "pause"noPor defecto: "arbeiten"
start_timestringnoPatrón ^\d{1,2}:\d{2}$
end_timestringnoPatrón ^\d{1,2}:\d{2}$
break_minutesnumbernomín. 0
duration_minutesnumbernomín. 0 · máx. 1440
descriptionstringno
is_billablebooleanno
external_sourcestringno
external_idstringno

Respuestas

  • 200 Registro existente del mismo origen actualizado.
  • 201 Registro de horas creado (`created`); con un origen conocido, 200 con `updated`.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 409 Conflicto, p. ej. número de cliente o de proyecto duplicado o un registro de horas ya facturado.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
action"created" | "updated"sí
idstring (uuid)sí
Respuesta 201
CampoTipoObligatorioNotas
action"created" | "updated"sí
idstring (uuid)sí

Webhooks

Suscribirse a webhooks salientes para Zapier, Make y receptores propios.

GET/api/v1/webhooks

Listar webhooks

Endpoints de la empresa sin el secreto de firma. Prueba de conexión para Zapier y Make.

Scope necesario: webhooks:read.

Scope: webhooks:read

Respuestas

  • 200 Endpoints.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 200
CampoTipoObligatorioNotas
dataobject[]sí
data[].idstring (uuid)sí
data[].urlstringsí
data[].descriptionstring | nullsí
data[].eventsstring[]sí
data[].is_activebooleansí
POST/api/v1/webhooks

Suscribirse a un webhook

Crea un endpoint. Zapier envía target_url y event; otros clientes, url y events. El secreto de firma solo aparece en esta respuesta.

Scope necesario: webhooks:write.

Scope: webhooks:write

Cuerpo de la petición (JSON)
CampoTipoObligatorioNotas
urlstringno
target_urlstringno
event"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"no
events"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"[]no
descriptionstringnocomo máximo 200 caracteres

Respuestas

  • 201 Endpoint creado.
  • 400 Entrada no válida.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.
Respuesta 201
CampoTipoObligatorioNotas
dataobjectsí
data.idstring (uuid)sí
data.urlstringsí
data.events"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"[]sí
data.secretstringsí
DELETE/api/v1/webhooks/{id}

Cancelar la suscripción a un webhook

Elimina un endpoint. Un ID desconocido o de otra empresa devuelve 404.

Scope necesario: webhooks:write.

Scope: webhooks:write

Parámetros
CampoTipoObligatorioNotas
id(ruta)string (uuid)sí

Respuestas

  • 204 Endpoint eliminado.
  • 401 Falta la clave API, es desconocida o está revocada. Cuerpo vacío.
  • 403 A la clave le falta el scope necesario.
  • 404 No encontrado; también con ID de otra empresa.
  • 429 Demasiadas peticiones para esta clave.
  • 500 Error interno.

Modelos de datos

Error

Campos
CampoTipoObligatorioNotas
errorstringsí

ValidationError

Campos
CampoTipoObligatorioNotas
errorstringsí
fieldsobjectsí

Customer

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
customer_numberstring | nullsí
customer_type"company" | "private"sí
salutation"herr" | "frau" | nullsí
company_namestring | nullsí
first_namestring | nullsí
last_namestring | nullsí
display_namestringsí
emailstring | nullsí
phonestring | nullsí
mobile_phonestring | nullsí
faxstring | nullsí
address_streetstring | nullsí
address_zipstring | nullsí
address_citystring | nullsí
tax_idstring | nullsí
notesstring | nullsí
is_archivedbooleansí
created_atstringsí
updated_atstring | nullsí

Project

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
namestringsí
project_numberstring | nullsí
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sí
project_type"fixed_fee" | "time_and_materials" | "non_billable" | nullsí
customer_idstring (uuid)sí
descriptionstring | nullsí
start_datestring | nullsí
end_datestring | nullsí
address_streetstring | nullsí
address_zipstring | nullsí
address_citystring | nullsí
created_atstringsí

ProjectListItem

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
namestringsí
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sí
customerobject | nullsí
customer.idstring (uuid)sí
customer.namestringsí

Lead

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
namestringsí
emailstring | nullsí
phonestring | nullsí
notesstring | nullsí
status"new" | "contacted" | "quote_sent" | "won" | "lost"sí
source"whatsapp" | "voice" | "test" | "website" | nullsí
customer_idstring (uuid) | nullsí
project_idstring (uuid) | nullsí
external_referencestring | nullsí
created_atstringsí

Document

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
numberstring | nullsí
type"quote" | "invoice"sí
invoice_kind"partial" | "final" | nullsí
status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sí
datestring | nullsí
due_datestring | nullsí
currencystringsí
net_amountnumber | nullsí
tax_ratenumber | nullsí
tax_amountnumber | nullsí
gross_amountnumber | nullsí
customer_idstring (uuid) | nullsí
project_idstring (uuid) | nullsí
has_pdfbooleansí
created_atstringsí
updated_atstring | nullsí

DocumentDetail

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
numberstring | nullsí
type"quote" | "invoice"sí
invoice_kind"partial" | "final" | nullsí
status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sí
datestring | nullsí
due_datestring | nullsí
currencystringsí
net_amountnumber | nullsí
tax_ratenumber | nullsí
tax_amountnumber | nullsí
gross_amountnumber | nullsí
customer_idstring (uuid) | nullsí
project_idstring (uuid) | nullsí
has_pdfbooleansí
created_atstringsí
updated_atstring | nullsí
pdfobject | nullsí
pdf.urlstring (uri)sí
pdf.expires_atstringsí
pdf.requires_postal_codetruesí

TimeEntry

Campos
CampoTipoObligatorioNotas
idstring (uuid)sí
user_idstring (uuid) | nullsí
project_idstring (uuid)sí
datestringsí
start_timestring | nullsí
end_timestring | nullsí
break_minutesintegersí
duration_minutesintegersí
work_type"arbeiten" | "laden" | "fahren" | "pause"sí
descriptionstring | nullsí
is_billableboolean | nullsí
status"pending" | "approved" | "rejected" | "invoiced"sí
external_sourcestring | nullsí
external_idstring | nullsí
projectobject | nullsí
project.idstring (uuid)sí
project.namestringsí