LegalizaObra

Cadastra um cliente (o dono da obra). Informe o nome e se é pessoa física (individual) ou empresa (company). E-mail e telefone são opcionais. O CPF/CNPJ do cliente não passa por aqui: o usuário cadastra no app, e ele é necessário depois para enviar contrato e procuração. Precisa de assinatura ativa. Contas de pessoa física não usam esta ferramenta: o dono da obra é cadastrado no app.

create_client

Cadastra uma obra para um cliente da conta: nome, estado (UF), data de início, data de fim (opcional), CNO (opcional) e as áreas da obra (principais e complementares). Precisa de assinatura ativa.

create_obra

Cancela um contrato enviado para assinatura: os links de assinatura deixam de valer. Não dá para desfazer. Confirme com o usuário antes.

cancel_contract_signature

Coloca na obra um pedreiro que já está cadastrado na conta, igual a 'Adicionar' na tela da obra. Se a obra já está no eSocial, o vínculo é enviado ao eSocial: confirme com o usuário antes. Um pedreiro novo precisa ser cadastrado antes no app, porque o cadastro pede o CPF. Demora: devolve um job_id para acompanhar com get_operation_status.

add_existing_employee_to_obra

Transforma um orçamento aprovado em obra: cria a obra com o cliente, as datas e as áreas da simulação do orçamento. Informe o nome da obra e, se já tiver, o CNO.

create_obra_from_quote

Cria um orçamento a partir de uma simulação de INSS. Informe o preço do serviço e o cliente: o id de um cliente que já existe (client_id) ou os dados de um cliente novo (client), nunca os dois. Devolve o link do orçamento para enviar ao dono da obra. Precisa de assinatura ativa.

create_quote_from_simulation

Encerra o trabalho de um pedreiro na obra, igual a 'Encerrar' na tela da obra. Só vale para obras já enviadas ao eSocial e envia o desligamento ao eSocial, o que não pode ser desfeito: confirme com o usuário antes. Demora: devolve um job_id para acompanhar com get_operation_status.

end_employment

Envia ao cliente, por e-mail, a guia de pagamento (DARF) de um mês da obra. A DARF do mês precisa já ter sido gerada. Pegue o payroll_id em get_obra_monthly_payments.

email_darf_to_client

Gera o contrato de um orçamento a partir de um modelo de contrato e envia para assinatura eletrônica da conta e do cliente. O cliente do orçamento precisa ter os dados completos e um e-mail diferente do e-mail da conta. Devolve os links de assinatura. Use list_templates para achar o modelo.

send_contract_for_signature

Envia a obra e os pedreiros ao eSocial, igual ao botão 'Enviar para eSocial'. É um envio oficial ao governo e não pode ser desfeito: confirme com o usuário antes. Precisa de certificado digital, CNO e pedreiros em todos os meses da obra. Demora alguns minutos: devolve um job_id para acompanhar com get_operation_status.

send_obra_to_esocial

Envia ao cliente, por e-mail, o link da procuração. O cliente precisa ter e-mail cadastrado.

send_procuracao_email

Finaliza a obra: marca a obra como concluída. Depois disso ela não pode mais ser editada. Confirme com o usuário antes.

finalize_obra

Gera a guia de INSS (DARF) de um mês da obra, igual ao botão 'Gerar guia INSS' / 'Gerar DARF'. Se o mês ainda não foi transmitido, envia os pagamentos ao eSocial e fecha a folha antes; se já foi, só gera a DARF. É um envio oficial ao governo: confirme com o usuário antes. Demora alguns minutos: devolve um job_id para acompanhar com get_operation_status.

generate_month_guide

Gera um link para baixar a guia de pagamento (DARF) de um mês da obra. A DARF do mês precisa já ter sido gerada. Pegue o payroll_id em get_obra_monthly_payments. Devolve um link que vale por 15 minutos. Entregue o link ao usuário para ele abrir o PDF.

get_darf_link

Gera o link da procuração do cliente. O cliente abre o link e autoriza a conta a enviar a obra ao eSocial em nome dele. Devolve o link e até quando ele vale.

get_procuracao_link

Gera um link para ver a prévia do contrato de um orçamento a partir de um modelo de contrato (contract), sem enviar para assinatura. Use list_templates para achar o modelo. Devolve um link que vale por 15 minutos. Entregue o link ao usuário para ele abrir o PDF.

get_contract_preview_link

Gera um link para baixar o PDF de um orçamento a partir de um modelo de orçamento (quote). Use list_templates para achar o modelo. Devolve um link que vale por 15 minutos. Entregue o link ao usuário para ele abrir o PDF.

get_quote_pdf_link

Gera o recibo de pagamento de um pedreiro em um mês, igual ao botão Recibo do app, e um link para baixar o PDF. O pagamento precisa ter data de pagamento. Pegue o payment_id em get_obra_monthly_payments. Devolve um link que vale por 15 minutos. Entregue o link ao usuário para ele abrir o PDF.

get_payment_receipt_link

Liga ou desliga o envio automático da obra ao eSocial todo mês.

set_automatic_esocial_transmission

Lista os clientes (donos das obras) da conta. Filtre por nome para achar um cliente e pegar o id dele.

list_clients

Lista os contratos enviados para assinatura, com o status de cada um (pendente, aguardando assinatura, assinado ou cancelado).

list_documents

Lista os modelos de documento da conta: modelos de orçamento (quote) e de contrato (contract). Use o id para gerar o PDF do orçamento ou o contrato.

list_templates

Lista as obras da conta, com cliente, datas, áreas, pedreiros e situação no eSocial. Filtre por cliente ou por status (em andamento ou finalizada).

list_obras

Lista as últimas operações demoradas da conta (envios ao eSocial, guias, DARFs, cadastros de pedreiro) com a situação de cada uma.

list_recent_operations

Lista os orçamentos da conta, do mais recente para o mais antigo, com cliente, preço do serviço e a simulação de INSS de cada um.

list_quotes

Lista os pedreiros cadastrados na conta. Filtre por nome para achar um pedreiro e pegar o id dele. Pedreiros novos são cadastrados no app, porque o cadastro pede o CPF.

list_employees

Muda a data de fim da obra. Se a obra já foi enviada ao eSocial, os pagamentos que ainda não foram feitos são redistribuídos até a nova data. A nova data não pode ser antes do último mês com DARF gerada.

change_obra_end_date

Simula o INSS de uma obra que ainda não está cadastrada, para fazer um orçamento: informe o estado (UF), as datas e as áreas. Sem simulation_id, cria uma simulação nova (conta no limite gratuito do mês de quem não tem assinatura). Com o simulation_id de uma simulação existente, refaz o cálculo dela com os novos dados, sem criar outra. A tabela mês a mês só aparece para quem tem assinatura ativa.

simulate_inss_costs

Tira um pedreiro de uma obra (apaga o vínculo dele com a obra). O cadastro do pedreiro continua na conta. Confirme com o usuário antes.

remove_employee_from_obra

Calcula o INSS da obra, igual à tela da obra no app: INSS devido, INSS depois da otimização (economia), cálculo da RMT e a tabela mês a mês com remuneração, ICM, CPP, multa, mora e MAED.

get_obra_inss_costs

Mostra um contrato e quem já assinou, com os links de assinatura de cada pessoa.

get_document

Mostra o código de indicação da conta, quem já se cadastrou com ele e quanto de crédito a conta já ganhou com as indicações. Valores em centavos.

get_referral_summary

Mostra a conta Legaliza Obra conectada: nome, tipo de conta, situação da assinatura e o papel do usuário. Use primeiro para saber o que o usuário pode fazer.

get_my_account

Mostra os detalhes de uma obra: cliente, datas, CNO, áreas, pedreiros e a situação no eSocial.

get_obra

Lista os pagamentos de INSS da obra mês a mês, depois que a obra foi enviada ao eSocial: valor de cada pedreiro, se o mês já foi transmitido e se a DARF já foi gerada. Traz os ids de folha (payroll_id) e de pagamento (payment_id).

get_obra_monthly_payments

Mostra como está uma operação demorada (envio ao eSocial, guia, DARF, cadastro ou encerramento de pedreiro) iniciada antes. status queued ou running: ainda está rodando, espere um pouco e consulte de novo. succeeded: terminou bem. failed: deu erro, e error_message explica o motivo.

get_operation_status

Mostra quantas simulações de INSS gratuitas ainda restam neste mês. Contas com assinatura ativa não têm limite.

get_simulation_usage