API REST do Bleno

Ligue ao Bleno os formulários do seu site, portais de pedidos, relógios de ponto ou o seu próprio software: crie clientes, obras e pedidos, consulte orçamentos e faturas e transfira registos de horas.

Versão 1.0.0

A referência da API abaixo é gerada a partir da especificação. A especificação JSON descreve os campos em alemão.

Autenticação

API REST para clientes, obras, pedidos, orçamentos/faturas, registos de horas e webhooks de uma empresa no Bleno.

Autenticação com chave API (Authorization: Bearer bleno_…). Cada chave tem scopes por recurso (read/write); um scope em falta dá 403.

Limite de pedidos: 60 chamadas por chave a cada 60 segundos; acima disso, 429 com Retry-After.

Os administradores criam uma chave em «Einstellungen → API & Webhooks» (Definições) e escolhem aí os scopes. A chave só é mostrada uma vez. Os dados de outras empresas nunca estão acessíveis: os ID de outra empresa devolvem 404, tal como os desconhecidos, e, usados como filtro, uma lista vazia.

A descrição legível por máquinas para geradores de código e ferramentas de API: Especificação OpenAPI (JSON, descrições em alemão)

curl https://bleno.de/api/v1/customers \
  -H "Authorization: Bearer bleno_…"
Scopes
ÂmbitoLeituraEscrita
Clientescustomers:readcustomers:write
Obrasprojects:readprojects:write
Pedidosleads:readleads:write
Documentosdocuments:readdocuments:write
Registos de horastime_entries:readtime_entries:write
Webhookswebhooks:readwebhooks:write

Clientes

Consultar, criar e alterar os clientes da empresa.

GET/api/v1/customers

Listar clientes

Por páginas; clientes arquivados só com include_archived=true.

Scope necessário: customers:read.

Scope: customers:read

Parâmetros
CampoTipoObrigatórioNotas
limit(query)integernãoPredefinição: 50 · mín. 1 · máx. 100
offset(query)integernãoPredefinição: 0 · mín. 0
include_archived(query)"true" | "false"nãoPredefinição: "false"

Respostas

  • 200 Lista de clientes.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobject[]sim
data[].idstring (uuid)sim
data[].customer_numberstring | nullsim
data[].customer_type"company" | "private"sim
data[].salutation"herr" | "frau" | nullsim
data[].company_namestring | nullsim
data[].first_namestring | nullsim
data[].last_namestring | nullsim
data[].display_namestringsim
data[].emailstring | nullsim
data[].phonestring | nullsim
data[].mobile_phonestring | nullsim
data[].faxstring | nullsim
data[].address_streetstring | nullsim
data[].address_zipstring | nullsim
data[].address_citystring | nullsim
data[].tax_idstring | nullsim
data[].notesstring | nullsim
data[].is_archivedbooleansim
data[].created_atstringsim
data[].updated_atstring | nullsim
paginationobjectsim
pagination.limitintegersim
pagination.offsetintegersim
pagination.totalintegersim
POST/api/v1/customers

Criar um cliente

Sem customer_type: com nome de empresa, uma empresa; caso contrário, um particular. Campos obrigatórios como no formulário de clientes.

Scope necessário: customers:write.

Scope: customers:write

Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
customer_type"company" | "private"não
salutation"herr" | "frau" | nullnão
company_namestring | nullnãono máximo 200 caracteres
first_namestring | nullnãono máximo 100 caracteres
last_namestring | nullnãono máximo 100 caracteres
emailstring (email) | "" | qualquer | nullnão
customer_numberstring | nullnãono máximo 50 caracteres
phonestring | nullnãono máximo 50 caracteres
mobile_phonestring | nullnãono máximo 50 caracteres
faxstring | nullnãono máximo 50 caracteres
address_streetstring | nullnãono máximo 200 caracteres
address_zipstring | nullnãono máximo 20 caracteres
address_citystring | nullnãono máximo 100 caracteres
tax_idstring | nullnãono máximo 50 caracteres
notesstring | nullnãono máximo 5000 caracteres

Respostas

  • 201 Cliente criado.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 409 Conflito, p. ex. número de cliente ou de obra duplicado ou um registo de horas já faturado.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 201
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.customer_numberstring | nullsim
data.customer_type"company" | "private"sim
data.salutation"herr" | "frau" | nullsim
data.company_namestring | nullsim
data.first_namestring | nullsim
data.last_namestring | nullsim
data.display_namestringsim
data.emailstring | nullsim
data.phonestring | nullsim
data.mobile_phonestring | nullsim
data.faxstring | nullsim
data.address_streetstring | nullsim
data.address_zipstring | nullsim
data.address_citystring | nullsim
data.tax_idstring | nullsim
data.notesstring | nullsim
data.is_archivedbooleansim
data.created_atstringsim
data.updated_atstring | nullsim
GET/api/v1/customers/{id}

Consultar um cliente

Scope necessário: customers:read.

Scope: customers:read

Parâmetros
CampoTipoObrigatórioNotas
id(caminho)string (uuid)sim

Respostas

  • 200 Cliente.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.customer_numberstring | nullsim
data.customer_type"company" | "private"sim
data.salutation"herr" | "frau" | nullsim
data.company_namestring | nullsim
data.first_namestring | nullsim
data.last_namestring | nullsim
data.display_namestringsim
data.emailstring | nullsim
data.phonestring | nullsim
data.mobile_phonestring | nullsim
data.faxstring | nullsim
data.address_streetstring | nullsim
data.address_zipstring | nullsim
data.address_citystring | nullsim
data.tax_idstring | nullsim
data.notesstring | nullsim
data.is_archivedbooleansim
data.created_atstringsim
data.updated_atstring | nullsim
PATCH/api/v1/customers/{id}

Alterar um cliente

Só mudam os campos enviados; null esvazia um campo.

Scope necessário: customers:write.

Scope: customers:write

Parâmetros
CampoTipoObrigatórioNotas
id(caminho)string (uuid)sim
Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
customer_type"company" | "private"não
salutation"herr" | "frau" | nullnão
company_namestring | nullnãono máximo 200 caracteres
first_namestring | nullnãono máximo 100 caracteres
last_namestring | nullnãono máximo 100 caracteres
emailstring (email) | "" | qualquer | nullnão
customer_numberstring | nullnãono máximo 50 caracteres
phonestring | nullnãono máximo 50 caracteres
mobile_phonestring | nullnãono máximo 50 caracteres
faxstring | nullnãono máximo 50 caracteres
address_streetstring | nullnãono máximo 200 caracteres
address_zipstring | nullnãono máximo 20 caracteres
address_citystring | nullnãono máximo 100 caracteres
tax_idstring | nullnãono máximo 50 caracteres
notesstring | nullnãono máximo 5000 caracteres

Respostas

  • 200 Cliente alterado.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 409 Conflito, p. ex. número de cliente ou de obra duplicado ou um registo de horas já faturado.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.customer_numberstring | nullsim
data.customer_type"company" | "private"sim
data.salutation"herr" | "frau" | nullsim
data.company_namestring | nullsim
data.first_namestring | nullsim
data.last_namestring | nullsim
data.display_namestringsim
data.emailstring | nullsim
data.phonestring | nullsim
data.mobile_phonestring | nullsim
data.faxstring | nullsim
data.address_streetstring | nullsim
data.address_zipstring | nullsim
data.address_citystring | nullsim
data.tax_idstring | nullsim
data.notesstring | nullsim
data.is_archivedbooleansim
data.created_atstringsim
data.updated_atstring | nullsim

Obras

Consultar e criar obras.

GET/api/v1/projects

Listar obras

Todas as obras não arquivadas com cliente e estado, ordenadas por nome.

Scope necessário: projects:read.

Scope: projects:read

Respostas

  • 200 Lista de obras.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
projectsobject[]sim
projects[].idstring (uuid)sim
projects[].namestringsim
projects[].status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sim
projects[].customerobject | nullsim
projects[].customer.idstring (uuid)sim
projects[].customer.namestringsim
POST/api/v1/projects

Criar uma obra

Se a empresa usar números de obra automáticos, o Bleno atribui o número seguinte quando nenhum é enviado.

Scope necessário: projects:write.

Scope: projects:write

Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
namestringsimpelo menos 1 caracteres · no máximo 200 caracteres
customer_idstring (uuid)sim
descriptionstring | nullnãono máximo 5000 caracteres
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"não
project_type"fixed_fee" | "time_and_materials" | "non_billable"não
project_numberstring | nullnãono máximo 60 caracteres
start_datestring | nullnãoPadrão ^\d{4}-\d{2}-\d{2}$
end_datestring | nullnãoPadrão ^\d{4}-\d{2}-\d{2}$
address_streetstring | nullnãono máximo 200 caracteres
address_zipstring | nullnãono máximo 20 caracteres
address_citystring | nullnãono máximo 100 caracteres

Respostas

  • 201 Obra criada.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 409 Conflito, p. ex. número de cliente ou de obra duplicado ou um registo de horas já faturado.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 201
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.namestringsim
data.project_numberstring | nullsim
data.status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sim
data.project_type"fixed_fee" | "time_and_materials" | "non_billable" | nullsim
data.customer_idstring (uuid)sim
data.descriptionstring | nullsim
data.start_datestring | nullsim
data.end_datestring | nullsim
data.address_streetstring | nullsim
data.address_zipstring | nullsim
data.address_citystring | nullsim
data.created_atstringsim

Pedidos

Criar pedidos a partir de formulários web e portais.

POST/api/v1/leads

Criar um pedido

Para formulários web e portais de pedidos. Os pedidos novos começam com o estado new e a origem website.

Scope necessário: leads:write.

Scope: leads:write

Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
namestringsimpelo menos 1 caracteres · no máximo 200 caracteres
emailstring (email) | "" | qualquer | nullnão
phonestring | nullnãono máximo 50 caracteres
notesstring | nullnãono máximo 5000 caracteres
customer_idstring (uuid) | nullnão
external_referencestring | nullnãono máximo 200 caracteres

Respostas

  • 201 Pedido criado.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 201
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.namestringsim
data.emailstring | nullsim
data.phonestring | nullsim
data.notesstring | nullsim
data.status"new" | "contacted" | "quote_sent" | "won" | "lost"sim
data.source"whatsapp" | "voice" | "test" | "website" | nullsim
data.customer_idstring (uuid) | nullsim
data.project_idstring (uuid) | nullsim
data.external_referencestring | nullsim
data.created_atstringsim

Documentos

Consultar orçamentos e faturas com estado, valores e ligação ao PDF.

GET/api/v1/documents

Listar orçamentos e faturas

Filtrável por tipo, estado, cliente e obra. A lista não contém ligações para PDF.

Scope necessário: documents:read.

Scope: documents:read

Parâmetros
CampoTipoObrigatórioNotas
limit(query)integernãoPredefinição: 50 · mín. 1 · máx. 100
offset(query)integernãoPredefinição: 0 · mín. 0
type(query)"quote" | "invoice"não
status(query)"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"não
customer_id(query)string (uuid)não
project_id(query)string (uuid)não

Respostas

  • 200 Lista de documentos.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobject[]sim
data[].idstring (uuid)sim
data[].numberstring | nullsim
data[].type"quote" | "invoice"sim
data[].invoice_kind"partial" | "final" | nullsim
data[].status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sim
data[].datestring | nullsim
data[].due_datestring | nullsim
data[].currencystringsim
data[].net_amountnumber | nullsim
data[].tax_ratenumber | nullsim
data[].tax_amountnumber | nullsim
data[].gross_amountnumber | nullsim
data[].customer_idstring (uuid) | nullsim
data[].project_idstring (uuid) | nullsim
data[].has_pdfbooleansim
data[].created_atstringsim
data[].updated_atstring | nullsim
paginationobjectsim
pagination.limitintegersim
pagination.offsetintegersim
pagination.totalintegersim
GET/api/v1/documents/{id}

Consultar um orçamento ou uma fatura

Com ligação ao PDF: com prazo limitado, e ao abri-la o Bleno pede o código postal do cliente.

Scope necessário: documents:read.

Scope: documents:read

Parâmetros
CampoTipoObrigatórioNotas
id(caminho)string (uuid)sim

Respostas

  • 200 Documento.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.numberstring | nullsim
data.type"quote" | "invoice"sim
data.invoice_kind"partial" | "final" | nullsim
data.status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sim
data.datestring | nullsim
data.due_datestring | nullsim
data.currencystringsim
data.net_amountnumber | nullsim
data.tax_ratenumber | nullsim
data.tax_amountnumber | nullsim
data.gross_amountnumber | nullsim
data.customer_idstring (uuid) | nullsim
data.project_idstring (uuid) | nullsim
data.has_pdfbooleansim
data.created_atstringsim
data.updated_atstring | nullsim
data.pdfobject | nullsim
data.pdf.urlstring (uri)sim
data.pdf.expires_atstringsim
data.pdf.requires_postal_codetruesim

Registos de horas

Consultar registos de horas e transferi-los a partir de terminais ou sistemas externos.

GET/api/v1/time-entries

Listar registos de horas

Registos no período de from a to, opcionalmente de um só colaborador.

Scope necessário: time_entries:read.

Scope: time_entries:read

Parâmetros
CampoTipoObrigatórioNotas
from(query)stringsimPadrão ^\d{4}-\d{2}-\d{2}$
to(query)stringsimPadrão ^\d{4}-\d{2}-\d{2}$
user_id(query)string (uuid)não
limit(query)integernãoValores acima de 500 são limitados a 500. · Predefinição: 200 · mín. 1 · máx. 500
offset(query)integernãoPredefinição: 0 · mín. 0

Respostas

  • 200 Registos de horas.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
entriesobject[]sim
entries[].idstring (uuid)sim
entries[].user_idstring (uuid) | nullsim
entries[].project_idstring (uuid)sim
entries[].datestringsim
entries[].start_timestring | nullsim
entries[].end_timestring | nullsim
entries[].break_minutesintegersim
entries[].duration_minutesintegersim
entries[].work_type"arbeiten" | "laden" | "fahren" | "pause"sim
entries[].descriptionstring | nullsim
entries[].is_billableboolean | nullsim
entries[].status"pending" | "approved" | "rejected" | "invoiced"sim
entries[].external_sourcestring | nullsim
entries[].external_idstring | nullsim
entries[].projectobject | nullsim
entries[].project.idstring (uuid)sim
entries[].project.namestringsim
has_morebooleansim
POST/api/v1/time-entries

Transferir um registo de horas

Ou duration_minutes, ou start_time e end_time. Com external_source e external_id, uma nova chamada atualiza o mesmo registo em vez de criar um segundo. A aprovação é definida pela empresa.

Scope necessário: time_entries:write.

Scope: time_entries:write

Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
user_idstring (uuid)sim
project_idstring (uuid)sim
datestringsimPadrão ^\d{4}-\d{2}-\d{2}$
work_type"arbeiten" | "laden" | "fahren" | "pause"nãoPredefinição: "arbeiten"
start_timestringnãoPadrão ^\d{1,2}:\d{2}$
end_timestringnãoPadrão ^\d{1,2}:\d{2}$
break_minutesnumbernãomín. 0
duration_minutesnumbernãomín. 0 · máx. 1440
descriptionstringnão
is_billablebooleannão
external_sourcestringnão
external_idstringnão

Respostas

  • 200 Registo existente da mesma origem atualizado.
  • 201 Registo de horas criado (`created`); com origem conhecida, 200 com `updated`.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 409 Conflito, p. ex. número de cliente ou de obra duplicado ou um registo de horas já faturado.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
action"created" | "updated"sim
idstring (uuid)sim
Resposta 201
CampoTipoObrigatórioNotas
action"created" | "updated"sim
idstring (uuid)sim

Webhooks

Subscrever webhooks de saída para o Zapier, o Make e recetores próprios.

GET/api/v1/webhooks

Listar webhooks

Endpoints da empresa sem o segredo de assinatura. Teste de ligação para o Zapier e o Make.

Scope necessário: webhooks:read.

Scope: webhooks:read

Respostas

  • 200 Endpoints.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 200
CampoTipoObrigatórioNotas
dataobject[]sim
data[].idstring (uuid)sim
data[].urlstringsim
data[].descriptionstring | nullsim
data[].eventsstring[]sim
data[].is_activebooleansim
POST/api/v1/webhooks

Subscrever um webhook

Cria um endpoint. O Zapier envia target_url e event; outros clientes, url e events. O segredo de assinatura só aparece nesta resposta.

Scope necessário: webhooks:write.

Scope: webhooks:write

Corpo do pedido (JSON)
CampoTipoObrigatórioNotas
urlstringnão
target_urlstringnão
event"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"não
events"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"[]não
descriptionstringnãono máximo 200 caracteres

Respostas

  • 201 Endpoint criado.
  • 400 Entrada inválida.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.
Resposta 201
CampoTipoObrigatórioNotas
dataobjectsim
data.idstring (uuid)sim
data.urlstringsim
data.events"customer.created" | "project.created" | "project.status_changed" | "lead.created" | "quote.accepted" | "quote.rejected" | "invoice.sent" | "invoice.paid" | "time_entry.created"[]sim
data.secretstringsim
DELETE/api/v1/webhooks/{id}

Cancelar a subscrição de um webhook

Remove um endpoint. Um ID desconhecido ou de outra empresa devolve 404.

Scope necessário: webhooks:write.

Scope: webhooks:write

Parâmetros
CampoTipoObrigatórioNotas
id(caminho)string (uuid)sim

Respostas

  • 204 Endpoint removido.
  • 401 Chave API em falta, desconhecida ou revogada. Corpo vazio.
  • 403 Falta à chave o scope necessário.
  • 404 Não encontrado; também com ID de outra empresa.
  • 429 Demasiados pedidos para esta chave.
  • 500 Erro interno.

Modelos de dados

Error

Campos
CampoTipoObrigatórioNotas
errorstringsim

ValidationError

Campos
CampoTipoObrigatórioNotas
errorstringsim
fieldsobjectsim

Customer

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
customer_numberstring | nullsim
customer_type"company" | "private"sim
salutation"herr" | "frau" | nullsim
company_namestring | nullsim
first_namestring | nullsim
last_namestring | nullsim
display_namestringsim
emailstring | nullsim
phonestring | nullsim
mobile_phonestring | nullsim
faxstring | nullsim
address_streetstring | nullsim
address_zipstring | nullsim
address_citystring | nullsim
tax_idstring | nullsim
notesstring | nullsim
is_archivedbooleansim
created_atstringsim
updated_atstring | nullsim

Project

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
namestringsim
project_numberstring | nullsim
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sim
project_type"fixed_fee" | "time_and_materials" | "non_billable" | nullsim
customer_idstring (uuid)sim
descriptionstring | nullsim
start_datestring | nullsim
end_datestring | nullsim
address_streetstring | nullsim
address_zipstring | nullsim
address_citystring | nullsim
created_atstringsim

ProjectListItem

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
namestringsim
status"planned" | "ready_for_work" | "in_progress" | "completed" | "cancelled" | "on_hold"sim
customerobject | nullsim
customer.idstring (uuid)sim
customer.namestringsim

Lead

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
namestringsim
emailstring | nullsim
phonestring | nullsim
notesstring | nullsim
status"new" | "contacted" | "quote_sent" | "won" | "lost"sim
source"whatsapp" | "voice" | "test" | "website" | nullsim
customer_idstring (uuid) | nullsim
project_idstring (uuid) | nullsim
external_referencestring | nullsim
created_atstringsim

Document

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
numberstring | nullsim
type"quote" | "invoice"sim
invoice_kind"partial" | "final" | nullsim
status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sim
datestring | nullsim
due_datestring | nullsim
currencystringsim
net_amountnumber | nullsim
tax_ratenumber | nullsim
tax_amountnumber | nullsim
gross_amountnumber | nullsim
customer_idstring (uuid) | nullsim
project_idstring (uuid) | nullsim
has_pdfbooleansim
created_atstringsim
updated_atstring | nullsim

DocumentDetail

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
numberstring | nullsim
type"quote" | "invoice"sim
invoice_kind"partial" | "final" | nullsim
status"draft" | "published" | "sent" | "accepted" | "rejected" | "lost" | "partially_paid" | "paid" | "cancelled"sim
datestring | nullsim
due_datestring | nullsim
currencystringsim
net_amountnumber | nullsim
tax_ratenumber | nullsim
tax_amountnumber | nullsim
gross_amountnumber | nullsim
customer_idstring (uuid) | nullsim
project_idstring (uuid) | nullsim
has_pdfbooleansim
created_atstringsim
updated_atstring | nullsim
pdfobject | nullsim
pdf.urlstring (uri)sim
pdf.expires_atstringsim
pdf.requires_postal_codetruesim

TimeEntry

Campos
CampoTipoObrigatórioNotas
idstring (uuid)sim
user_idstring (uuid) | nullsim
project_idstring (uuid)sim
datestringsim
start_timestring | nullsim
end_timestring | nullsim
break_minutesintegersim
duration_minutesintegersim
work_type"arbeiten" | "laden" | "fahren" | "pause"sim
descriptionstring | nullsim
is_billableboolean | nullsim
status"pending" | "approved" | "rejected" | "invoiced"sim
external_sourcestring | nullsim
external_idstring | nullsim
projectobject | nullsim
project.idstring (uuid)sim
project.namestringsim