Skip to main content

Sienge

Integração com a API do Sienge, software de gestão para construção civil.

Sienge Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 355 actions:

ActionPurposeParameters
accountancy_accounts_v1/get_accountancy_accountsLista as contas ordenadas por código.companyId (integer)
id (integer)
uniqueNumber (string)
accountType (string)
limit (integer)
offset (integer)
accountancy_accounts_v1/get_accountancy_accounts_by_idRetorna conta modificada.id (string) required
accountancy_batch_v1/post_batchSalva lotes contábeisdata: {
. companyId (integer)
. batchType (string)
. batchDescription (string)
. startDate (string)
. endDate (string)
} (object) required
accountancy_batch_v1/get_batchBusca lotes contábeiscompanyId (integer) required
batchType (string)
batchStatus (string)
batchDescription (string)
startDate (string) required
endDate (string) required
limit (integer)
offset (integer)
accountancy_closingaccountancy_v1/get_closingaccountancyBusca empresas com saldos consolidados atualizadoscompanyId (integer)
accountId (string)
monthYear (string) required
limit (integer)
offset (integer)
accountancy_entries_v1/post_accountancy_entriesSalva lançamentos contábeisdata (array) required
accountancy_entries_v1/get_accountancy_entriesBusca lançamentos contábeiscompanyId (integer) required
limit (integer)
offset (integer)
entryBatchId (integer)
entryType (string)
costCenter (integer)
startDate (string)
endDate (string)
account (string)
accountancy_entries_v1/post_accountancy_entries_asyncSalva lançamentos contábeis assíncronosdata (array) required
accountancy_entries_v1/get_accountancy_entries_async_statusRetorna o status do processamento dos lançamentosNo parameters
accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batchesLista os lotes ordenados por Id.companyId (integer)
limit (integer)
offset (integer)
accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches_by_idMostra um lote pelo código.id (integer) required
accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches_by_id_entriesMostra as informações dos lançamentos do lote especificado pelo código do lote, ordenados pelo código dos lançamentos.id (integer) required
startDate (string)
endDate (string)
limit (integer)
offset (integer)
accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entriesMostra as informações dos lançamentos ordenados pelo código do lote e código dos lançamentos.companyId (integer)
startDate (string)
endDate (string)
limit (integer)
offset (integer)
accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches_by_id_entries_by_entry_idMostra as informações dos lançamentos pelo código do lançamento, ordenado pelo código do loteid (integer) required
entryId (integer) required
limit (integer)
offset (integer)
accounts_balances_v1/get_accounts_balancesRetorna a lista de saldos das contas do Sienge, na data informada nos parâmetros.balanceDate (string) required
accountNumber (string)
accountStatus (string)
companyId (integer)
companyGroupId (integer)
showLastBalanceIfNotExistBalance (string)
limit (integer)
offset (integer)
accounts_receivable_v1/get_accounts_receivable_receivable_billsBusca os títulos do cliente no SiengecustomerId (integer) required
companyId (integer)
costCenterId (integer)
paidOff (boolean)
limit (integer)
offset (integer)
accounts_receivable_v1/get_accounts_receivable_receivable_bills_by_receivable_bill_idBusca os títulos no Sienge pelo númeroreceivableBillId (integer) required
accounts_receivable_v1/get_accounts_receivable_receivable_bills_by_receivable_bill_id_installmentsBusca as parcelas do títuloreceivableBillId (integer) required
carrierIdIn (integer)
carrierIdNotIn (array)
limit (integer)
offset (integer)
accounts_receivable_v1/patch_accounts_receivable_receivable_bills_by_receivable_bill_id_installments_by_installment_id_change_due_dateAltera data de vencimento da parcela e o status da cobrança para Em Aberto. Será possível registrar nova cobrança na sequência. Não será possível alterar parcelas com baixas e a nova data de vencimento não poderá ser menor que a data corrente.receivableBillId (integer) required
installmentId (integer) required
data: {
. newDueDate (string)
} (object) required
accounts_receivable_v1/get_accounts_receivable_by_receivable_bill_id_budget_categoriesBusca as apropriações financeiras do títuloreceivableBillId (integer) required
limit (integer)
offset (integer)
accounts_statements_v1/get_accounts_statementsRetorna a lista de movimentações financeiras associados a contas do Sienge, com data dentro do periodo informado nos parâmetros.startDate (string) required
endDate (string) required
accountNumber (string)
companyId (integer)
companyGroupId (integer)
limit (integer)
offset (integer)
bearers_receivable_v1/get_bearers_receivableBusca uma lista de Portadoreslimit (integer)
offset (integer)
filter (string)
bill_debt_v1/get_billsBusca os títulos no SiengestartDate (string) required
endDate (string) required
debtorId (integer)
creditorId (integer)
costCenterId (integer)
documentsIdentificationId (array)
documentNumber (string)
status (string)
originId (string)
limit (integer)
offset (integer)
bill_debt_v1/post_billsInserção do título no Siengedata: {
. debtorId (integer)
. creditorId (integer)
. documentIdentificationId (string)
. documentNumber (string)
. issueDate (string)
. installmentsNumber (integer)
. indexId (integer)
. baseDate (string)
. dueDate (string)
. billDate (string)
. totalInvoiceAmount (number)
. notes (string)
. discount (number)
. budgetCategories (array)
. taxes (array)
. departmentsCost (array)
. buildingsCost (array)
. units (array)
} (object) required
bill_debt_v1/get_bills_by_change_dateBusca os títulos no Sienge de acordo com a data de alteraçãostartDate (string) required
endDate (string) required
debtorId (integer)
creditorId (integer)
costCenterId (integer)
documentsIdentificationId (array)
documentNumber (string)
status (string)
originId (string)
limit (integer)
offset (integer)
bill_debt_v1/get_bills_by_bill_idBusca o título no SiengebillId (integer) required
bill_debt_v1/patch_bills_by_bill_idAtualiza o título no SiengebillId (integer) required
data: {
. documentIdentificationId (string)
. documentNumber (string)
} (object) required
bill_debt_v1/post_eletronic_invoice_billsInserção do título no Sienge com base em nota fiscal eletrônica recebidadata: {
. debtorId (integer)
. creditorId (integer)
. documentIdentificationId (string)
. accessKeyNumber (string)
. installmentsNumber (integer)
. indexId (integer)
. baseDate (string)
. dueDate (string)
. billDate (string)
. notes (string)
. budgetCategories (array)
. departmentsCost (array)
. buildingsCost (array)
. units (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installmentsBusca as parcelas do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_idAtualiza parcela do títulobillId (integer) required
installmentId (integer) required
data: {
. dueDate (string)
. interestAmount (number)
. fineAmount (number)
. monetaryCorrectionAmount (number)
. discountAmount (number)
} (object) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_bank_transferInserção de informação de pagamento da parcela do tipo transferência bancáriabillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. beneficiaryBankCode (string)
. beneficiaryBankBranchNumber (string)
. beneficiaryBankBranchDigit (string)
. beneficiaryAccountNumber (string)
. beneficiaryAccountDigit (string)
. beneficiaryAccountDAC (string)
. beneficiaryAccountType (string)
. beneficiaryName (string)
. beneficiaryCPFNumber (string)
. beneficiaryCNPJNumber (string)
. tedFinalityCode (string)
. docFinalityCode (string)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_bank_transferBusca informação de pagamento da parcela do tipo transferência bancáriabillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_bancarioInserção de informação de pagamento da parcela do tipo boleto bancáriobillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. boletoBancarioBarCodeNumber (string)
. boletoBancarioManualBarCodeNumber (string)
. documentNumber (string)
. boletoBancarioBeneficiaryId (integer)
. boletoBancarioSacadorId (integer)
. discountDueDate (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_bancarioBusca informação de pagamento da parcela do tipo boleto bancáriobillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_concessionariaInserção de informação de pagamento da parcela do tipo boleto concessionáriabillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. boletoConcessionariaBarCodeNumber (string)
. boletoConcessionariaManualBarCodeNumber (string)
. boletoConcessionariaPaymentType (string)
. documentNumber (string)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_concessionariaBusca informação de pagamento da parcela do tipo boleto concessionáriabillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_taxInserção de informação de pagamento da parcela do tipo tributos com código de barrasbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. taxBarCodeNumber (string)
. taxManualBarCodeNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_taxBusca informação de pagamento da parcela do tipo tributos com código de barrasbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_ddaInserção de informação de pagamento da parcela do tipo débito direto autorizadobillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. beneficiaryBankCode (string)
. beneficiaryAccountNumber (string)
. beneficiaryAccountDigit (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_ddaBusca informação de pagamento da parcela do tipo débito direto autorizadobillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_darf_taxInserção de informação de pagamento da parcela do tipo tributos DARFbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. darfTaxReceitaId (string)
. darfReferenceNumber (number)
. darfBaseDate (string)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_darf_taxBusca informação de pagamento da parcela do tipo tributos DARFbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_darj_taxInserção de informação de pagamento da parcela do tipo tributos DARJbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. darjReferencePeriod (string)
. inscricaoEstadualNumber (string)
. darjDocumentNumber (string)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_darj_taxBusca informação de pagamento da parcela do tipo tributos DARJbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_fgts_taxInserção de informação de pagamento da parcela do tipo tributos FGTSbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. fgtsTaxReceitaId (string)
. fgtsIdNumber (number)
. conectividadeSocialLacreNumber (integer)
. conectividadeSocialLacreDigit (integer)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. taxBarCodeNumber (string)
. taxManualBarCodeNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_fgts_taxBusca informação de pagamento da parcela do tipo tributos FGTSbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_gare_taxInserção de informação de pagamento da parcela do tipo tributos GAREbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. gareTaxReceitaId (string)
. gareReferencePeriod (string)
. inscricaoEstadualNumber (string)
. gareLabelNumber (string)
. gareInstallmentNumber (string)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_gare_taxBusca informação de pagamento da parcela do tipo tributos GAREbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_inss_taxInserção de informação de pagamento da parcela do tipo tributos INSSbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. taxPayerIdentificationType (integer)
. taxPayerIdentificationNumber (string)
. inssPaymentCode (string)
. inssBaseDate (string)
. inssOtherEntitiesValue (number)
. taxPayerType (string)
. creditorTaxPayerId (integer)
. costCenterTaxPayerId (integer)
. taxPayerCPFCNPJNumber (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_inss_taxBusca informação de pagamento da parcela do tipo tributos INSSbillId (integer) required
installmentId (integer) required
bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_pixInserção de informação de pagamento da parcela do tipo PixbillId (integer) required
installmentId (integer) required
data: {
. paymentTypeId (integer)
. notes (string)
. beneficiaryName (string)
. beneficiaryCPFNumber (string)
. beneficiaryCNPJNumber (string)
. isUsingCreditorData (string)
. keyPixType (string)
. keyPix (string)
. links (array)
} (object) required
bill_debt_v1/get_bills_by_bill_id_installments_by_installment_id_payment_information_pixBusca informação de pagamento da parcela do tipo PixbillId (integer) required
installmentId (integer) required
bill_debt_v1/get_bills_by_bill_id_taxesBusca os impostos do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/get_bills_by_bill_id_budget_categoriesBusca as apropriações financeiras do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/get_bills_by_bill_id_departments_costBusca as apropriações departamento do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/get_bills_by_bill_id_buildings_costBusca as apropriações obra do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/put_bills_by_bill_id_buildings_costAtualiza as apropriações obra do títulobillId (integer) required
data (array) required
bill_debt_v1/post_bills_by_bill_id_attachmentsInserção de anexo no títulobillId (integer) required
description (string) required
data: {
. file (object)
} (object) required
bill_debt_v1/get_bills_by_bill_id_attachmentsBusca as informações dos anexos do títulobillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/get_bills_by_bill_id_attachments_by_attachment_idDownload de anexo do títulobillId (integer) required
attachmentId (integer) required
bill_debt_v1/get_bills_by_bill_id_unitsBusca as unidades do título no SiengebillId (integer) required
limit (integer)
offset (integer)
bill_debt_v1/put_bills_by_bill_id_unitsAltera as unidades do título no SiengebillId (integer) required
data (array) required
building_calendar_v1/get_building_projects_by_building_id_calendarRetorna um objeto JSON com as configurações do calendário usado no planejamento da obra. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
building_calendar_v1/put_building_projects_by_building_id_calendarInsere um calendário em uma nova versão da planilha de planejamento de uma obra. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
data: {
. projectStartDate (string)
. projectFinishDate (string)
. considerHolidaysAndDaysOffInGeneralRegister (boolean)
. considerSaturdaysAsWorkingDay (boolean)
. considerSundaysAsWorkingDay (boolean)
} (object) required
building_calendar_v1/get_building_projects_by_building_id_calendar_days_offRetorna um array com as datas dos dias de folga no período da obra e suas descrições. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
offset (integer)
limit (integer)
building_calendar_v1/post_building_projects_by_building_id_calendar_days_offInsere folgas no calendário da obra em uma nova versão da planilha de planejamento. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
data (array) required
building_calendar_v1/delete_building_projects_by_building_id_calendar_days_offRemove folgas do calendário da obra em uma nova versão da planilha de planejamento. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
data (array) required
building_cost_estimation_cost_estimate_resources_v1/get_building_cost_estimations_by_building_id_cost_estimate_resourcesRetorno um array com todos os insumos orçadosbuildingId (integer) required
offset (integer)
limit (integer)
buildingUnitId (integer)
building_cost_estimation_resources_v1/get_building_cost_estimations_by_building_id_resourcesRetorna um array com todos os insumos ativos do orçamento de uma obrabuildingId (integer) required
resourceGroups (array)
offset (integer)
limit (integer)
building_cost_estimation_resources_v1/post_building_cost_estimations_by_building_id_resourcesInclui um insumo no orçamento de uma obra.buildingId (integer) required
data: {
. id (integer)
} (object) required
building_cost_estimation_resources_v1/get_building_cost_estimations_by_building_id_resources_by_idRetorna um insumo do orçamento de uma obrabuildingId (integer) required
id (integer) required
building_cost_estimation_resources_v1/patch_building_cost_estimations_by_building_id_resources_by_idAtualiza o código auxiliar de um insumo no orçamento de uma obrabuildingId (integer) required
id (integer) required
data: {
. resourceCode (string)
} (object) required
building_cost_estimations_v1/get_building_cost_estimations_by_building_id_sheetsRetorna um array com as planilhas da versão atual do orçamento de uma obra, sendo uma planilha para cada unidade construtiva building unit. O orçamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do orçamento.buildingId (integer) required
offset (integer)
limit (integer)
building_cost_estimations_v1/get_building_cost_estimations_by_building_id_sheets_by_building_unit_id_itemsRetorna um array com os itens de uma planilha da versão atual do orçamento de uma obra. A planilha em questão é identificada pela respectivo código da unidade construtiva buildingUnitId.buildingId (integer) required
building_unit_id (integer) required
offset (integer)
limit (integer)
building_projects_progress_logs_v1/post_building_projects_by_building_id_progress_logsAtualiza percentual de avanço físico das Tarefas do Planejamento de uma Obra.buildingId (integer) required
data: {
. date (string)
. items (array)
} (object) required
building_projects_progress_logs_v1/get_building_projects_progress_logsConsulta progressos do Planejamento de Obras.buildingId (integer)
buildingUnitId (integer)
measurementStartDate (string)
measurementEndDate (string)
consistent (boolean)
limit (integer)
offset (integer)
building_projects_progress_logs_v1/get_building_projects_by_building_id_progress_logs_by_measurement_numberConsulta o progresso do Planejamento de uma Obra.buildingId (integer) required
measurementNumber (integer) required
building_projects_progress_logs_v1/get_building_projects_by_building_id_progress_logs_by_measurement_number_items_by_building_unit_idConsulta informações dos itens de uma medição específica.buildingId (integer) required
measurementNumber (integer) required
buildingUnitId (integer) required
building_projects_v1/get_building_projects_by_building_id_sheets_by_building_unit_id_tasksRetorna um array com as tarefas da versão atual da planilha de planejamento de uma obra, sendo uma planilha para cada unidade construtiva building unit. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
buildingUnitId (integer) required
offset (integer)
limit (integer)
building_projects_v1/put_building_projects_by_building_id_sheets_by_building_unit_id_tasksInsere um array de tarefas em uma nova versão da planilha de planejamento de uma obra, sendo uma planilha para cada unidade construtiva building unit. O planejamento em questão é identificado pelo respectivo código da obra buildingId, considerando por padrão a versão atual do planejamento.buildingId (integer) required
buildingUnitId (integer) required
allowDeleteTaskCostItem (boolean)
data (array) required
bulk_data_account_company_balance_v1/get_accountancy_account_balanceRetorna movimentos financeiros, caso possua.startDate (string) required
endDate (string) required
companyId (integer)
accountId (string)
bulk_data_account_cost_center_balance_v1/get_accountancy_account_cost_center_balanceRetorna saldos contábeis, caso possua.startDate (string) required
endDate (string) required
costCentersId (array)
accountId (string)
includeBalancesWithoutCostCenter (boolean)
bulk_data_bank_movement_v1/get_bank_movementRetorna movimentos financeiros, caso possua.startDate (string) required
endDate (string) required
selectionType (string)
companyId (integer)
costCentersId (array)
onlyDetachedMovement (string)
buildingId (integer)
buildingUnitId (integer)
costEstimationSheetId (string)
bulk_data_bank_movement_v1/get_bank_movement_by_movementsRetorna movimentos financeiros, caso possua.movementsIds (array) required
bulk_data_building_cost_estimations_v1/get_building_cost_estimation_itemsRetorna um array com todos os itens de todas as planilhas de todas as versões de orçamento de todas as obras.dataDate (string)
buildingId (integer)
adjustmentIndexId (integer)
adjustmentDate (string)
bdi (string)
laborBurden (string)
includeDisbursments (boolean)
bulk_data_building_resource_v1/get_building_resourcesRetorna um array dos Insumos associados à uma Obra por detalhe e marca. Observação: Não serão retornados os Insumos do tipo Item de Transporte e Item de Incidência.buildingId (integer) required
startDate (string) required
endDate (string) required
resourcesIds (array)
includeDisbursement (boolean)
bdi (string)
laborBurden (string)
bulk_data_business_budget_v1/get_business_budgetRetorna um array com todos as versões de orçamentos empresarias.startDate (string) required
endDate (string) required
id (integer)
companyId (integer)
companyName (string)
baseDate (string)
description (string)
budgetType (string)
costCenterId (integer)
departmentId (integer)
versionNumber (integer)
versionDate (string)
bulk_data_customer_debt_balance/get_customer_debt_balanceRealiza leitura de dados do saldo devedor cliente.startDueDate (string) required
endDueDate (string) required
correctionDate (string)
positionDate (string)
changeStartDate (string)
billReceivableId (integer)
companyId (integer)
customerId (integer)
costCenterId (integer)
unitNumber (string)
documentsId (string)
bearersId (integer)
paymentTermsId (array)
paymentTermsIdNotIn (array)
interestAmount (number)
commercialDiscount (number)
calculatePresentValue (boolean)
includeAdministrativeRateAmount (boolean)
includeInsuranceAmount (boolean)
correctAnnualInstallment (boolean)
includeReceiptsByAdvanceRebate (boolean)
includeConditionalDiscountValid (boolean)
calculateAdditionsUserInformation (boolean)
calculateAdditionsValue (boolean)
proratedIndexerAdditions (integer)
fineAdditions (number)
interestAmountAdditions (number)
interestTypeAdditions (string)
calculateAdditionsDate (string)
bulk_data_customer_extract_history_v1/get_customer_extract_historyRealiza leitura de dados do extrato de cliente.startDueDate (string) required
endDueDate (string) required
correctionDate (string)
positionDate (string)
billReceivableId (integer)
companyId (integer)
customerId (integer)
costCenterId (integer)
unitNumber (string)
documentsId (string)
bearersId (integer)
paymentTermsId (array)
includeRemadeInstallments (boolean)
includeCanceledInstallments (boolean)
includeRevokedInstallments (boolean)
includeRenegotiatedDischarge (boolean)
paymentTermsIdNotIn (array)
changeStartDate (string)
bulk_data_defaulters_receivable_bills_v1/get_defaulters_receivable_billsRetorna os títulos inadimplentes juntamente com as parcelas em atraso.companyId (integer) required
enterpriseId (integer)
dueDateLimit (string)
bearerId (integer)
documentsId (string)
billingOperationId (integer)
receivableBillId (integer)
customerId (integer)
cityId (integer)
correctionDate (string)
normalReceivableBills (boolean)
inBillingReceivableBills (boolean)
defaultersReceivableBills (boolean)
underJudgmentReceivableBills (boolean)
normalActivities (boolean)
inBillingActivities (boolean)
defaultersActivities (boolean)
underJudgmentActivities (boolean)
situationBillingControlInfo (string)
includeResidueInstallment (boolean)
includePartiallyPaidInstallments (boolean)
showOnlyDefaulters (boolean)
includeUnderJudgment (boolean)
showSentToSPCSerasa (boolean)
positionDate (string)
bulk_data_defaulters_receivable_bills_v1/get_defaulters_receivable_bills_by_agingRetorna os títulos inadimplentes somente com a parcela com maior atraso aging, agrupados por cliente e unidade. Ex.: caso tenham dois títulos de um mesmo cliente, na mesma unidade, será retornado apenas o título que possui a parcela mais antiga.companyId (integer) required
enterpriseId (integer)
dueDateLimit (string)
bearerId (integer)
documentsId (string)
billingOperationId (integer)
customerId (integer)
correctionDate (string)
defaultersReceivableBills (boolean)
underJudgmentReceivableBills (boolean)
defaultersActivities (boolean)
underJudgmentActivities (boolean)
situationBillingControlInfo (string)
includeResidueInstallment (boolean)
includePartiallyPaidInstallments (boolean)
showOnlyDefaulters (boolean)
includeUnderJudgment (boolean)
showSentToSPCSerasa (boolean)
positionDate (string)
bulk_data_income_v1/get_incomeRetorna as parcelas sem baixa e seus pagamentos caso possuam, para títulos em um período e tipo de período informados.startDate (string) required
endDate (string) required
selectionType (string) required
correctionIndexerId (integer)
correctionDate (string)
companyId (integer)
costCentersId (array)
changeStartDate (string)
completedBills (string)
originsIds (array)
bearersIdIn (array)
bearersIdNotIn (array)
bulk_data_income_v1/get_income_by_billsRetorna as parcelas dos títulos informados, independente de período e tipo de período.billsIds (array) required
correctionIndexerId (integer)
correctionDate (string)
bulk_data_invoice_items_v1/get_invoice_itensRealiza leitura de itens das notas fiscais.companyId (integer) required
startDate (string) required
endDate (string) required
showCostCenterId (string)
bulk_data_outcome_v1/get_outcomeRetorna parcelas sem baixa e seus pagamentos, caso possua.startDate (string) required
endDate (string) required
selectionType (string) required
correctionIndexerId (integer) required
correctionDate (string) required
companyId (integer)
costCentersId (array)
withAuthorizations (boolean)
withBankMovements (boolean)
buildingId (integer)
buildingUnitId (integer)
costEstimationSheetId (string)
bulk_data_outcome_v1/get_outcome_by_billsRetorna parcelas.billsIds (array) required
correctionIndexerId (integer)
correctionDate (string)
withAuthorizations (boolean)
withBankMovements (boolean)
bulk_data_purchase_quotations_v1/get_purchase_quotationsRetorna um array com todas as cotações de preços contendo itens, fornecedores e negociações.startDate (string) required
endDate (string) required
originatedPurchaseOrder (boolean)
bulk_data_sales_v1/get_salesRealiza leitura dos contratos de vendas.enterpriseId (integer) required
createdAfter (string) required
createdBefore (string) required
situation (string) required
valueGroupingDescription (string)
checking_accounts_v1/get_checking_accountsBusca uma lista de contas-correntes ordenando pelo número da contacompanyId (integer)
accountNumber (string)
accountStatus (string)
limit (integer)
offset (integer)
cities_v1/get_citiesBusca uma lista de municípioslimit (integer)
offset (integer)
name (string)
stateCode (string)
civil_status_v1/post_civil_statusPersiste um estado civil.data: {
. description (string)
. type
} (object) required
civil_status_v1/get_civil_statusBusca uma lista de estados civislimit (integer)
offset (integer)
description (string)
collections_notification_history_v1/get_collections_notification_history_by_collection_notification_history_idBusca o histórico da notificação de cobrança no SiengecollectionNotificationHistoryId (integer) required
commissions_forecasts_v1/get_sales_commissionsBusca uma lista de comissões de venda.limit (integer)
offset (integer)
contractId (integer)
brokerId (integer)
customerId (integer)
commissions_forecasts_v1/post_sales_commissions_forecastsInsere uma previsão de comissão de venda.data: {
. contractId (integer)
. brokerId (integer)
. rate (number)
. value (number)
. dueDate (string)
. indexerId (integer)
. baseDate (string)
. installmentsNumber (integer)
. type (string)
} (object) required
commissions_v1/post_commissionsPersiste uma comissão.data: {
. salesContractId (integer)
. baseValue (number)
. released (boolean)
. brokers (array)
} (object) required
commissions_v1/get_commissionsBusca as parcelas das comissões por filtro.unitId (integer)
contractId (integer)
brokerId (integer)
companyId (integer)
enterpriseId (integer)
startingDueDate (string)
endingDueDate (string)
offset (integer) required
limit (integer) required
commissionFilterType (string)
commissions_v1/get_commissions_by_idBusca uma comissão por ID.id (integer) required
commissions_v1/patch_commissions_by_idAltera uma comissão por ID.id (integer) required
data: {
. brokers (array)
} (object) required
commissions_v1/delete_commissions_by_idDeleta uma comissão por ID.id (integer) required
commissions_v1/patch_commissions_authorizeRealiza autorização, ou desfaz autorização das parcelas.data: {
. authorize (boolean)
. commissions (array)
} (object) required
commissions_v1/patch_commissions_cancelRealiza cancelamento, ativação das parcelas.data: {
. cancel (boolean)
. commissions (array)
} (object) required
commissions_v1/post_commissions_releaseRealiza liberação das parcelas.data: {
. documentId (string)
. documentNumber (string)
. installments (integer)
. value (integer)
. firstPayment (string)
. emissionDate (string)
. brokerId (integer)
. billingBrokerId (integer)
. releases (array)
} (object) required
commissions_v1/delete_commissions_by_id_brokers_by_id_corretorDeleta corretor de uma comissão por ID.id (integer) required
idCorretor (integer) required
commissions_v1/post_commissions_by_id_brokersAdiciona um ou mais corretores na comissão por ID.id (integer) required
data: {
. brokers (array)
} (object) required
commissions_v1/get_commissions_count_filtersRetorna um totalizador agrupado por situação das parcelas.unitId (integer)
contractId (integer)
brokerId (integer)
enterpriseId (integer)
startingDueDate (string)
endingDueDate (string)
commissions_v1/post_commissions_configurations_brokersPersiste uma configuração de corretor.data required
commissions_v1/get_commissions_configurations_brokersConsulta uma lista de configurações de corretores.offset (integer)
limit (integer)
filter (string)
commissions_v1/patch_commissions_configurations_brokers_by_idAtualiza um registro de configuração do corretor.id (integer) required
data: {
. percentage (number)
. installments (integer)
} (object) required
commissions_v1/delete_commissions_configurations_brokers_by_idDeleta um registro de configuração do corretor por ID.id (integer) required
commissions_v1/post_commissions_configurations_enterprisesPersiste uma configuração de empreendimento.data required
commissions_v1/get_commissions_configurations_enterprises_by_idConsulta as configurações de um empreendimento.id (integer) required
commissions_v1/put_commissions_configurations_enterprises_by_idAtualiza um registro de configuração do empreendimento.id (integer) required
data: {
. indexerId (integer)
. limitPercentage (number)
. releasePercentageAdjustment (number)
. cancelCommissionsOnContractCancelation (boolean)
. allowReleaseCommissionWithPendings (boolean)
. considerForPayment (object)
} (object) required
company_v1/get_companies_by_company_idBusca a empresa no SiengecompanyId (integer) required
company_v1/get_companiesBusca uma lista de empresas ordenadas pelo código idlimit (integer)
offset (integer)
construction_daily_report_v1/get_construction_daily_reportRetorna os Diários das Obras paginados.buildingId (integer)
startDate (string)
endDate (string)
offset (integer)
limit (integer)
construction_daily_report_v1/post_construction_daily_reportCadastra um Diário de Obra, com informações de tarefas, ocorrências, equipes e equipamentos.data: {
. buildingId (number)
. date (string)
. notes (string)
. responsibleId (string)
. rainfallIndex (number)
. shifts (array)
. plannedTasks (array)
. detachedTasks (array)
. events (array)
. crews (array)
. equipments (array)
} (object) required
construction_daily_report_v1/get_construction_daily_report_by_building_id_by_construction_daily_idRetorna todos os dados de um Diário de Obra específicobuildingId (integer) required
constructionDailyId (integer) required
construction_daily_report_v1/delete_construction_daily_report_by_building_id_by_construction_daily_idDeleta um Diário de Obra, exceto aqueles que tenham sido usados em uma Integração.buildingId (integer) required
constructionDailyId (integer) required
construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_attachmentsInclui anexo em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
description (string) required
localId (integer)
showInReports (boolean)
construction_daily_report_v1/get_construction_daily_report_by_building_id_by_construction_daily_id_attachments_by_attachment_idRetorna o anexo de um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
attachmentId (integer) required
construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_eventsInclui ocorrências em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_eventsAtualiza Ocorrências em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_tasksInclui tarefas em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data: {
. plannedTasks (array)
. detachedTasks (array)
} (object) required
construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_tasksAtualiza tarefas em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data: {
. plannedTasks (array)
. detachedTasks (array)
} (object) required
construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_crewsInclui equipes em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_crewsAtualiza Equipes em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_equipmentsInclui equipamentos em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_equipmentsAtualiza Equipamentos em um Diário de ObrabuildingId (integer) required
constructionDailyId (integer) required
data (array) required
construction_daily_report_v1/get_construction_daily_report_event_typeRetorna a lista de Tipos de Ocorrência.offset (integer)
limit (integer)
sort (string)
order (string)
id (number)
description (string)
isActive (boolean)
construction_daily_report_v1/get_construction_daily_report_typesRetorna a lista de Tipos de Ocorrência, Equipe e Equipamento do Diário de Obra.types (array)
offset (integer)
limit (integer)
sort (string)
order (string)
id (number)
description (string)
isActive (boolean)
contracts_v1/get_supply_contracts_allConsulta lista de contratoscontractStartDate (string) required
contractEndDate (string) required
companyId (integer)
buildingId (integer)
limit (integer)
offset (integer)
statusApproval (string)
authorization (string)
consistency (string)
contracts_v1/get_supply_contractsConsultar contratodocumentId (string) required
contractNumber (string) required
contracts_v1/get_supply_contracts_attachments_allLista de anexos do contratodocumentId (string) required
contractNumber (string) required
contracts_v1/get_supply_contracts_attachmentsRetorna o anexo do contratodocumentId (string) required
contractNumber (string) required
contractAttachmentNumber (string) required
contracts_v1/post_supply_contracts_attachmentsInclui anexo do contratodocumentId (string) required
contractNumber (string) required
description (string) required
data: {
. file (object)
} (object) required
contracts_v1/get_supply_contracts_buildingsConsultar obras do contrato com unidades construtivasdocumentId (string) required
contractNumber (string) required
limit (integer)
offset (integer)
contracts_v1/get_supply_contracts_addendaConsultar aditivos de obras do contratodocumentId (string)
contractNumber (string)
buildingId (integer)
addendumNumber (integer)
addendumStartDate (string)
addendumEndDate (string)
limit (integer)
offset (integer)
contracts_v1/get_supply_contracts_addenda_itemsConsultar itens de aditivo da obra do contratodocumentId (string) required
contractNumber (string) required
buildingId (integer) required
addendumNumber (integer) required
limit (integer)
offset (integer)
contracts_v1/get_supply_contracts_itemsRetorna um array com os itens do contrato identificados pelo contrato documentId, contractNumber e pertencentes a uma planilha buildingId, buildingUnitId.documentId (string) required
contractNumber (string) required
buildingId (integer) required
buildingUnitId (integer) required
limit (integer)
offset (integer)
contracts_v1/patch_supply_contracts_authorizeSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao responsável'documentId (string) required
contractNumber (string) required
data: {
. observation (string)
} (object) required
contracts_v1/patch_supply_contracts_disapproveSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao responsável'documentId (string) required
contractNumber (string) required
data: {
. observation (string)
} (object) required
cost_center_v1/get_cost_centers_by_cost_center_idBusca todos os centros de custo no SiengecostCenterId (integer) required
cost_center_v1/get_cost_centers_by_cost_center_id_availableBusca centro de custo no Sienge com as contas correntes disponíveiscostCenterId (integer) required
cost_center_v1/get_cost_centersBusca todos os centros de custos no Sienge ordenados pelo codigo idlimit (integer)
offset (integer)
cost_center_v1/get_cost_centers_immediate_register_settingsBusca as configurações de registro ATO cadastradas no centro de custo.costCenterId (integer) required
cost_databases_v1/get_cost_databasesRetorna um array com todas as tabelas ativas do custos unitáriosid (integer)
description (string)
status (string)
costDatabaseEnabledForIntegration (boolean)
offset (integer)
limit (integer)
cost_databases_v1/get_cost_databases_by_id_resourcesRetorna um array com todos os insumos ativos de uma tabela do custos unitários cost-databaseid (integer) required
resourceCode (string)
description (string)
resourceGroups (array)
status (string)
unitOfMeasureId (integer)
onlyResourcesWithoutComposition (boolean)
offset (integer)
limit (integer)
cost_databases_v1/get_cost_databases_by_id_resources_by_resource_idRetorna o insumo correspondente ao id informado da tabela do custos unitários cost-databaseid (integer) required
resourceId (integer) required
cost_databases_v1/get_cost_databases_by_id_work_itemsRetorna um array com todos os serviços ativos de uma tabela do custos unitários cost-databaseid (string) required
buildingTypeId (integer)
description (string)
status (string)
offset (integer)
limit (integer)
cost_databases_v1/get_cost_databases_by_id_work_items_assembliesRetorna um array com todas as composições dos serviços ativos para a respectiva tabela. Se não existir nenhuma, retorna um array vazio.id (integer) required
buildingTypeId (integer)
description (string)
workItemIds (array)
offset (integer)
limit (integer)
creditor_report_v1/get_creditor_report_pdfGera um relatório de extrato de credores conforme os filtros informados e retorna a URL para visualização do PDF.companyId (integer)
billId (integer)
dueStartDate (string)
dueEndDate (string)
issueStartDate (string)
issueEndDate (string)
documentId (array)
creditorId (array)
creditorClassId (array)
costCenterId (integer)
departmentId (array)
monetaryCorrectionDate (string)
sortBy (string)
indexerId (integer)
valuesPresentation (string)
forecastDocument (string)
obsBill (string)
includeObsPayment (string)
includePaymentInfo (string)
printPaymentMethod (string)
printOriginalDueDate (string)
showTaxes (string)
showDepartment (string)
includePaymentAdvance (string)
creditorTypeEmployee (string)
creditorTypeBroker (string)
creditorTypeSupplier (string)
creditor_v1/post_creditorsInserção de credor no Siengedata: {
. name (string)
. personType (string)
. typesId (array)
. registerNumber (string)
. stateRegistrationNumber (string)
. stateRegistrationType (string)
. municipalSubscription (string)
. paymentTypeId (integer)
. phone (object)
. agents (array)
. contacts (array)
. procurators (array)
. payslipDesonerationYears (array)
. address (object)
. accountStatement (object)
} (object) required
creditor_v1/get_creditorsBusca o credor no Siengecpf (string)
cnpj (string)
creditor (string)
limit (integer)
offset (integer)
creditor_v1/get_creditors_by_creditor_idBusca o credor no SiengecreditorId (integer) required
creditor_v1/patch_creditors_by_creditor_idAtualiza informações referentes ao credor no SiengecreditorId (integer) required
data: {
. name (string)
. personType (string)
. cpf (string)
. cnpj (string)
. stateRegistrationNumber (string)
. stateRegistrationType (string)
. municipalSubscription (string)
. address (object)
} (object) required
creditor_v1/post_creditors_by_creditor_id_bank_informationsInserção das informações bancárias do credor no SiengecreditorId (integer) required
data (array) required
creditor_v1/get_creditors_by_creditor_id_bank_informationsBusca as informações bancárias do credor no SiengecreditorId (integer) required
limit (integer)
offset (integer)
creditor_v1/patch_creditors_by_creditor_id_bank_informations_by_banck_information_idAtualizar as informações bancárias do credor no SiengecreditorId (integer) required
banckInformationId (integer) required
data: {
. paymentTypeId (integer)
. accountStatement (object)
} (object) required
creditor_v1/post_creditors_by_creditor_id_pix_informationsInsere as informações de pix do credor no SiengecreditorId (integer) required
data: {
. type (string)
. key (string)
. beneficiary (string)
. cpfCnpjBeneficiary (string)
. defaultFlag (string)
} (object) required
creditor_v1/get_creditors_by_creditor_id_pix_informationsBusca as informações de pix do credor no SiengecreditorId (integer) required
limit (integer)
offset (integer)
creditor_v1/patch_creditors_by_creditor_id_pix_informations_by_pix_information_idAltera as informações de pix do credor no SiengecreditorId (integer) required
pixInformationId (integer) required
data: {
. type (string)
. key (string)
. beneficiary (string)
. cpfCnpjBeneficiary (string)
. defaultFlag (string)
} (object) required
creditor_v1/patch_creditors_by_creditor_id_phone_by_phone_idAtualizar as informações de um telefone do credor no SiengecreditorId (integer) required
phoneId (integer) required
data: {
. ddd (string)
. number (string)
. main (boolean)
. type (string)
} (object) required
creditor_v1/patch_creditors_by_creditor_id_contact_by_contact_idAtualizar as informações de um contato do credor no SiengecreditorId (integer) required
contactId (integer) required
data: {
. name (string)
. phoneDdd (string)
. phoneNumber (string)
. phoneExtension (string)
. email (string)
} (object) required
creditor_v1/patch_creditors_by_creditor_id_procurator_by_procurator_idAtualizar as informações de um procurador do credor no SiengecreditorId (integer) required
procuratorId (integer) required
data: {
. name (string)
. cpf (string)
. rg (string)
. phoneDdd (string)
. phoneNumber (string)
. phoneExtension (string)
. cityId (integer)
. streetName (string)
. addressNumber (string)
. neighborhood (string)
. complement (string)
. zipCode (string)
} (object) required
creditor_v1/put_creditors_by_creditor_id_agentsEnviar todos os códigos de representantes quando for atualizarcreditorId (integer) required
data (array) required
creditor_v1/put_creditors_by_creditor_id_payslip_desoneration_yearsAo atualizar os anos referente a desoneração da folha de pagamento, todos os anos cadastrados serão excluídos e atualizados com os novos que forem enviados.creditorId (integer) required
data (array) required
creditor_v1/put_creditors_by_creditor_id_activateAtivar um credor desativado no SiengecreditorId (integer) required
creditor_v1/put_creditors_by_creditor_id_deactivateDesativar um credor ativado no SiengecreditorId (integer) required
current_debit_balance_v1/get_current_debit_balanceGera as informações referentes ao saldo devedor presente do cliente informado.cpf (string)
cnpj (string)
dueDateStart (string)
dueDateEnd (string)
generatedBoleto (boolean)
numberTitle (integer)
correctionDate (string)
correctAnnualInstallment (string)
conditionIdIn (array)
conditionIdNotIn (array)
costCenterIdIn (array)
costCenterIdNotIn (array)
unitNumber (string)
unitId (string)
current_debit_balance_v1/get_current_debit_balance_pdfGera o link para o download do PDF referente ao Saldo Devedor Presente do cliente. O link expira em 5 minutos.customerId (integer) required
numberTitle (integer)
unitNumber (string)
unitId (string)
correctionDate (string)
conditionIdIn (array)
conditionIdNotIn (array)
customerPortalBills (boolean)
documentIdIn (array)
documentIdNotIn (array)
customer_financial_statements_v1/post_customer_financial_statementsEnvia relatório de extrato de cliente por e-maildata: {
. customerId (integer)
. email (string)
. billReceivableId (integer)
. subject (string)
. message (string)
. unityId (array)
. unityCode (array)
. conditionIdIn (array)
. conditionIdNotIn (array)
} (object) required
customer_financial_statements_v1/get_customer_financial_statementsExibe as informações do extrato do clientecustomerId (integer) required
billReceivableId (integer)
monetaryCorrectionForAnnualInstallment (string)
includeSubJudice (boolean)
companyId (integer)
jointVentureId (integer)
unityId (array)
unityCode (array)
conditionIdIn (array)
conditionIdNotIn (array)
includeRemadeInstallments (string)
includeWriteOff (string)
includeCancelation (string)
includeRenegotiation (string)
monetaryCorrectionForDueDateInstallment (string)
includeBankMovements (boolean)
customer_financial_statements_v1/get_customer_financial_statements_pdfGera o link para o download do PDF referente ao Extrato do Cliente. O link expira em 5 minutos.customerId (integer) required
billReceivableId (integer)
monetaryCorrectionForAnnualInstallment (string)
includeSubJudice (boolean)
companyId (integer)
jointVentureId (integer)
unityId (array)
unityCode (array)
conditionIdIn (array)
conditionIdNotIn (array)
includeRemadeInstallments (string)
includeWriteOff (string)
includeCancelation (string)
includeRenegotiation (string)
monetaryCorrectionForDueDateInstallment (string)
customer_income_tax_v1/post_customer_income_tax_reportEnvia relatório de imposto de renda por e-maildata: {
. customerId (integer)
. companyId (integer)
. year (integer)
. subject (string)
. message (string)
. paymentTerms (array)
. documentsIn (array)
. receiptTypeNotIn (array)
. showConsolidatingCompanyDataInHeader (boolean)
} (object) required
customer_income_tax_v1/get_customer_income_tax_report_pdfGera o link para o download do PDF referente ao Imposto de Renda do cliente. O link expira em 5 minutos.customerId (integer) required
companyId (integer) required
year (integer)
subject (string)
message (string)
paymentTerms (array)
documentsIn (array)
receiptTypeNotIn (array)
showConsolidatingCompanyDataInHeader (boolean)
customer_types_v1/get_customer_typesBusca uma lista de tipos de clienteslimit (integer)
offset (integer)
id (integer)
description (string)
customers_v1/get_customersBusca uma lista de clientes ordenando do cadastro mais recente para o mais antigo.cpf (string)
cnpj (string)
internationalId (string)
onlyActive (boolean)
enterpriseId (number)
createdAfter (string)
createdBefore (string)
modifiedAfter (string)
modifiedBefore (string)
limit (integer)
offset (integer)
customers_v1/post_customersPersiste um cliente.data: {
. personType (string)
. foreigner (string)
. typeId (integer)
. internationalId (string)
. subtypeIds (array)
. addresses (array)
. phones (array)
. naturalPersonData (object)
. legalPersonData (object)
. familyIncome (array)
} (object) required
customers_v1/get_customers_by_idBusca um cliente.id (integer) required
customers_v1/patch_customers_by_idAtualiza informações de um cliente.id (integer) required
data: {
. internationalId (string)
. typeId (integer)
. naturalPersonData (object)
. legalPersonData (object)
} (object) required
customers_v1/put_customers_by_id_phonesAtualiza os telefones de um cliente.id (integer) required
data: {
. phones (array)
} (object) required
customers_v1/put_customers_by_id_spouseAtualiza o cônjuge de um cliente, apagando o antigo cônjuge. Se não existir, cria.id (integer) required
data: {
. cpf (string)
. name (string)
. email (string)
. sex (string)
. foreigner (string)
. internationalId (string)
. civilStatus (string)
. birthDate (string)
. numberIdentityCard (string)
. issueDateIdentityCard (string)
. profession (string)
. nationality (string)
. birthPlace (string)
. fatherName (string)
. motherName (string)
. cellphoneNumber (string)
. businessPhone (string)
. company (string)
. addresses (object)
} (object) required
customers_v1/put_customers_by_id_family_incomesAtualiza as rendas familiares de um cliente.id (integer) required
data (array) required
customers_v1/put_customers_by_id_addresses_by_typeAtualiza os endereços de um cliente. Se não existir, cria.id (integer) required
type (string) required
data: {
. streetName (string)
. number (string)
. complement (string)
. neighborhood (string)
. cityId (integer)
. city (string)
. state (string)
. zipCode (string)
} (object) required
customers_v1/post_customers_by_id_attachmentsInclui um anexo ao cliente.id (integer) required
description (string) required
data: {
. file (object)
} (object) required
customers_v1/get_customers_by_id_attachmentsBusca as informações dos anexos do clienteid (integer) required
limit (integer)
offset (integer)
customers_v1/get_customers_by_id_attachments_by_attachment_idDownload de anexo do clienteid (integer) required
attachmentId (integer) required
customers_v1/post_customers_by_id_procuratorInclui um procurador ao cliente.id (integer) required
data: {
. name (string)
. cpf (string)
. procuratorType (string)
. numberIdentityCard (string)
. email (string)
. birthDate (string)
. nationality (string)
. birthPlace (string)
. professionId (integer)
. civilStatusId (integer)
. marriageRegime (string)
. marriageDate (string)
. residentialAddress (object)
. businessAddress (object)
. proxy (object)
. spouse (object)
. phones (array)
} (object) required
departments_v1/get_departments_by_department_idBusca o departamento no SiengedepartmentId (integer) required
departments_v1/get_departmentsBusca uma lista de departamentoslimit (integer)
offset (integer)
document_identification_v1/get_document_identifications_by_document_identification_idBusca o documento no SiengedocumentIdentificationId (string) required
email_current_debit_balance_v1/post_email_current_debit_balanceEnvia relatório de Saldo Devedor Presente por e-mail.data: {
. customerId (integer)
. email (string)
. subject (string)
. message (string)
. fileName (string)
. conditionIdIn (array)
. conditionIdNotIn (array)
} (object) required
enterprise_v1/get_enterprises_by_enterprise_idBusca o empreendimento no SiengeenterpriseId (integer) required
enterprise_v1/get_enterprisesBusca uma lista de empreendimentoscompanyId (integer)
type (integer)
limit (integer)
offset (integer)
receivableRegister (string)
onlyBuildingsEnabledForIntegration (boolean)
enterprise_v1/get_enterprises_by_enterprise_id_groupingsBusca valores dos agrupamentos no SiengeenterpriseId (integer) required
fixed_assets_v1/get_patrimony_fixedLista os bens ordenados por código do patrimônio.patrimonyId (integer)
costCenter (string)
detail (string)
situation (string)
limit (integer)
offset (integer)
hooks_v1/get_hooksConsulta paginada de WebHookslimit (integer)
offset (integer)
hooks_v1/post_hooksInsere um novo WebHookdata: {
. url (string)
. token (string)
. events (array)
} (object) required
hooks_v1/get_hooks_by_hook_idConsulta um WebHook específico por IDhookId (string) required
hooks_v1/delete_hooks_by_hook_idRemove um WebHook específico por IDhookId (string) required
indexers_v1/get_indexersBusca uma lista de indexadoreslimit (integer)
offset (integer)
measurement_v1/get_supply_contracts_measurements_allConsulta medições de contratosdocumentId (string)
contractNumber (string)
buildingId (integer)
measurementNumber (integer)
contractSupplierId (integer)
contractCustomerId (integer)
measurementDate (string)
measurementStartDate (string)
measurementEndDate (string)
statusApproval (string)
authorization (string)
consistency (string)
limit (integer)
offset (integer)
measurement_v1/get_supply_contracts_measurementsConsulta mediçõesdocumentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
measurement_v1/post_supply_contracts_measurementsCria uma nova medição para o respectivo contrato e obra.documentId (string) required
contractNumber (string) required
buildingId (integer) required
data: {
. measurementDate (string)
. dueDate (string)
. notes (string)
. makeUnauthorized (boolean)
. items (array)
} (object) required
measurement_v1/get_supply_contracts_measurements_itemsRetorna um array com os itens medidos nesta medição.documentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
limit (integer)
offset (integer)
measurement_v1/get_supply_contracts_measurements_clearingRetorna a liberação de uma medição.documentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
measurement_v1/get_supply_contracts_measurements_attachments_allConsulta anexos de medição de contratomeasurementStartDate (string) required
measurementEndDate (string) required
documentId (string)
contractNumber (string)
buildingId (integer)
measurementNumber (integer)
limit (integer)
offset (integer)
measurement_v1/get_supply_contracts_measurements_attachmentsDownload anexos de medição de contratodocumentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
attachmentNumber (integer) required
measurement_v1/post_supply_contracts_measurements_attachmentsInclui anexos de medição de contratodocumentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
description (string) required
measurement_v1/patch_supply_contracts_measurements_authorizeSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao responsável'documentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
data: {
. observation (string)
} (object) required
measurement_v1/patch_supply_contracts_measurements_disapproveSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao responsável'documentId (string) required
contractNumber (string) required
buildingId (integer) required
measurementNumber (integer) required
data: {
. observation (string)
} (object) required
movable_assets_v1/get_patrimony_movableLista os bens ordenados por código do patrimônio.patrimonyId (integer)
barCode (string)
costCenter (string)
model (integer)
plateId (string)
situation (string)
limit (integer)
offset (integer)
nfe_api_v1/get_nfesRetorna as notas fiscais em determinado período ordenadas por data de emissãostartDate (string) required
endDate (string) required
limit (integer)
offset (integer)
nfe_api_v1/get_nfes_by_nfe_keyRetorna uma nota fiscalnfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_issuers_recipientsRetorna o emitente e destinatario de uma notanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_paymentsRetorna as formas de pagamento de uma notanfeKey (string) required
limit (integer)
offset (integer)
nfe_api_v1/get_nfes_by_nfe_key_deliveriesRetorna as informações do local de entrega e retiradanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_linked_nfesRetorna as notas referenciadasnfeKey (string) required
limit (integer)
offset (integer)
nfe_api_v1/get_nfes_by_nfe_key_icmsRetorna as informações de icms total de uma notanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_carriersRetorna as informações de transporte, presentes na notanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_issqnRetorna as informações issqn total, presentes na notanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_itensRetorna os itens/produtos, presentes na notanfeKey (string) required
nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_ipiRetorna o ipi de determinado produto/serviço, presente na notanfeKey (string) required
itemId (integer) required
nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_pis_cofinsRetorna o pis-cofins de determinado produto/serviço, presente na notanfeKey (string) required
itemId (integer) required
nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_simplified_icmsRetorna o icms simples nacional de determinado produto/serviço, presente na notanfeKey (string) required
itemId (integer) required
nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_issqnRetorna o issqn de determinado produto/serviço, presente na notanfeKey (string) required
itemId (integer) required
nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_icmsRetorna o icms de determinado produto/serviço, presente na notanfeKey (string) required
itemId (integer) required
overdue_receivable_v1/post_overdue_receivable_billRegistra cobrança referente a parcelas vencidas.data: {
. receivableBillId (integer)
. companyId (integer)
. checkingAccountId (string)
. newDueDate (string)
. interestPercentage (number)
. finePercentage (number)
. insurancepercentage (number)
. correctAnnualInstallment (boolean)
. groupedInstalments (boolean)
. installments (array)
} (object) required
parameters_v1/get_parameters_by_idRetorna o id e o valor de um determinado parâmetro. O formato do valor depende do seu tipo, podendo ser um texto, uma observação, um valor inteiro, um valor decimal ou o valor de uma chave estrangeira.id (integer) required
payment_categories_v1/get_payment_categories_by_payment_categories_idBusca o plano financeiro no SiengepaymentCategoriesId (integer) required
payment_categories_v1/get_payment_categoriesBusca todos os planos financeiros no SiengeNo parameters
payment_condition_types_v1/get_payment_condition_typesBusca os Tipos de Condição de Pagamento.filter (string)
offset (integer)
limit (integer)
payment_slip_notification_v1/post_payment_slip_notificationEnvia o boleto de segunda via do título e parcela informado, no e-mail do respectivo cliente do título.data: {
. receivableBillId (integer)
. installmentId (integer)
. emailCustomer (string)
. emailTitle (string)
. emailBody (string)
} (object) required
payment_slip_notification_v1/get_payment_slip_notificationGera o link para boleto de segunda via do título e parcela informado, assim como o número digitável do boleto. O link expira em 5 minutos.billReceivableId (integer) required
installmentId (integer) required
prepayment_slip_register_v1/post_prepayment_slip_registerRegistra cobrança referente a antecipação de parcelas.data: {
. companyId (integer)
. installments (array)
. accountNumber (string)
. newDueDate (string)
. groupBy (string)
. matchDueDate (string)
. percentPresentValue (number)
. calculatePresentValue (boolean)
. correctAnnualInstallment (boolean)
} (object) required
prepayment_slip_register_v1/get_prepayment_slip_registerConsulta informações para antecipação de parcelas.data: {
. companyId (integer)
. installments (array)
. accountNumber (string)
. newDueDate (string)
. groupBy (string)
. matchDueDate (string)
. percentPresentValue (number)
. calculatePresentValue (boolean)
. correctAnnualInstallment (boolean)
} (object) required
price_tables_v1/get_price_tablesBusca a última versão das tabelas de preços.companyId (integer)
enterpriseId (integer)
enterpriseIdView (integer)
projectId (integer)
tableName (string)
startOfTerm (string)
endOfTerm (string)
offset (integer)
limit (integer)
professions_v1/get_professionsBusca uma lista de profissõeslimit (integer)
offset (integer)
name (string)
professions_v1/post_professionsPersiste uma lista de profissões.data (array) required
professions_v1/get_professions_by_idBusca uma profissão.id (integer) required
property_rental_v1/get_property_rentalLista de locação de imóveis.offset (integer)
limit (integer)
contractSeqId (integer)
companyId (integer)
enterpriseId (integer)
rentalContractNumber (string)
unitId (integer)
customerId (integer)
situation (string)
property_rental_v1/post_property_rentalCria contrato de locação de imóveis.data: {
. companyId (integer)
. enterpriseId (integer)
. rentalContractNumber (string)
. paymentCategoriesId (string)
. contractType (string)
. contractDate (string)
. accountDate (string)
. initialRentalDate (string)
. finalRentalDate (string)
. allowReadjustment (boolean)
. allowEditInstallment (boolean)
. note (string)
. paymentCondition (object)
. installments (array)
. readjustment (object)
. units (array)
. customers (array)
} (object) required
property_types_v1/get_property_typesBusca uma lista de tipos de imóveislimit (integer)
offset (integer)
name (string)
property_types_v1/get_property_types_by_idBusca um tipo de imóvel.id (integer) required
purchase_invoices_v1/get_purchase_invoices_by_sequential_numberConsulta nota fiscal de comprasequentialNumber (integer) required
purchase_invoices_v1/get_purchase_invoices_by_sequential_number_itemsRetorna os itens da nota fiscal de comprasequentialNumber (integer) required
purchase_invoices_v1/get_purchase_invoicesRetorna uma lista paginada de notas fiscais de compra conforme filtros informados.companyId (integer)
supplierId (integer)
documentId (string)
series (string)
number (string)
startDate (string)
endDate (string)
limit (integer)
offset (integer)
purchase_invoices_v1/post_purchase_invoicesInserção dos dados que fazem parte das informações principais da nota fiscal de compra. O primeiro passo para cadastrar uma nota é inserir essas informações, que são compostos por dados essenciais como, por exemplo, empresa, fornecedor e o número da nota fiscal. Com essas informações inseridas, o próximo passo é incluir os demais dados da nota, como, por exemplo, os seus itens.data: {
. documentId (string)
. number (string)
. series (string)
. supplierId (integer)
. companyId (integer)
. movementTypeId (integer)
. movementDate (string)
. issueDate (string)
. notes (string)
} (object) required
purchase_invoices_v1/post_purchase_invoices_by_sequential_number_items_purchase_orders_delivery_schedulesInserção de itens em uma nota fiscal a partir de entregas de itens de pedidos de comprasequentialNumber (integer) required
data: {
. deliveriesOrder (array)
. copyNotesPurchaseOrders (boolean)
. copyNotesResources (boolean)
. copyAttachmentsPurchaseOrders (boolean)
} (object) required
purchase_invoices_v1/get_purchase_invoices_deliveries_attendedRetorna os itens atendidos entre o pedido de compra e a nota fiscalbillId (integer)
sequentialNumber (integer)
purchaseOrderId (integer)
invoiceItemNumber (integer)
purchaseOrderItemNumber (integer)
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_ordersConsulta pedidos de comprastartDate (string)
endDate (string)
status (string)
authorized (boolean)
supplierId (integer)
buildingId (integer)
buyerId (string)
statusApproval (string)
consistency (string)
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_orders_by_purchase_order_idConsulta pedido de comprapurchaseOrderId (integer) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_itemsConsulta de itens do pedido de comprapurchaseOrderId (integer) required
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_numberConsulta item do pedido de comprapurchaseOrderId (integer) required
itemNumber (integer) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_number_delivery_schedulesConsulta de previsões de entregas do item do pedido de comprapurchaseOrderId (integer) required
itemNumber (integer) required
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_number_buildings_appropriationsConsulta de apropriações de obra do item do pedidopurchaseOrderId (integer) required
itemNumber (integer) required
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_totalizationConsultar a totalização do pedido de comprapurchaseOrderId (integer) required
limit (integer)
offset (integer)
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_direct_billingConsultar o faturamento direto simples do pedido de compra. Não consulta faturamento direto com desconto em medição.purchaseOrderId (integer) required
limit (integer)
offset (integer)
purchase_orders_v1/put_purchase_orders_by_purchase_order_id_authorizeAutoriza pedido de compra que está aguardando autorizaçãopurchaseOrderId (integer) required
purchase_orders_v1/patch_purchase_orders_by_purchase_order_id_authorizeAutoriza pedido de compra que está aguardando autorização com a opção de informar a observaçãopurchaseOrderId (integer) required
data: {
. observation (string)
} (object) required
purchase_orders_v1/put_purchase_orders_by_purchase_order_id_disapproveReprova pedido de compra que está aguardando autorizaçãopurchaseOrderId (integer) required
purchase_orders_v1/patch_purchase_orders_by_purchase_order_id_disapproveReprova pedido de compra que está aguardando autorização com a opção de informar a observaçãopurchaseOrderId (integer) required
data: {
. observation (string)
} (object) required
purchase_orders_v1/post_purchase_orders_by_purchase_order_id_attachmentsInserção de anexos no pedido de comprapurchaseOrderId (integer) required
data: {
. description (string)
. attachment (object)
} (object) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_attachmentsBusca as informações dos anexos do pedido de comprapurchaseOrderId (integer) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_attachments_by_attachment_numberDownload de anexo do Pedido de ComprapurchaseOrderId (integer) required
attachmentNumber (integer) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_supplier_evaluation_criteriaConsulta os critérios de avaliação para um pedido específicopurchaseOrderId (integer) required
purchase_orders_v1/post_purchase_orders_by_purchase_order_id_evaluationCadastra uma avaliação do fornecedor no pedido de comprapurchaseOrderId (integer) required
data: {
. notes (string)
. evaluatedCriteria (array)
} (object) required
purchase_orders_v1/put_purchase_orders_by_purchase_order_id_evaluationCadastra uma avaliação do fornecedor no pedido de compra caso não exista, ou atualiza a última avaliação cadastradapurchaseOrderId (integer) required
data: {
. notes (string)
. evaluatedCriteria (array)
} (object) required
purchase_orders_v1/get_purchase_orders_by_purchase_order_id_analysis_pdfGera o relatório de Análise do Pedido de Compra informado e efetua download deste em formato PDF.purchaseOrderId (integer) required
printPurchaseOrderAuthorizationObservationsFlag (boolean)
printListOfPurchaseOrdersWithSameAppropriateItems (boolean)
printOnlyPurchaseInvoicesWithOutstandingInstallments (boolean)
printDetailedAmountsFromPurchaseInvoices (boolean)
printAppropriationQuantity (boolean)
purchase_quotations_v1/post_purchase_quotationsCria uma cotação de preçodata: {
. buyerId (string)
. date (string)
} (object) required
purchase_quotations_v1/get_purchase_quotations_all_negotiationsBusca todas as cotações com negociaçõesquotationNumber (integer)
supplierId (integer)
buyerId (string)
startDate (string)
endDate (string)
authorized (boolean)
status (string)
consistency (string)
limit (integer)
offset (integer)
purchase_quotations_v1/post_purchase_quotations_by_purchase_quotation_id_itemsCria um item de cotação de preçopurchaseQuotationId (integer) required
data: {
. buildingId (integer)
. productId (integer)
. detailId (integer)
. trademarkId (integer)
. quantity (number)
. unitySymbol (string)
. notes (string)
. deliveryRequirements (array)
} (object) required
purchase_quotations_v1/post_purchase_quotations_by_purchase_quotation_id_items_from_purchase_requestCria um item de cotação de preço a partir da entrega do item de solicitação de comprapurchaseQuotationId (integer) required
data: {
. purchaseRequestId (integer)
. purchaseRequestItemNumber (integer)
. deliveryRequirementNumber (integer)
} (object) required
purchase_quotations_v1/post_purchase_quotations_by_purchase_quotation_id_items_by_purchase_quotation_item_number_suppliersInclui um fornecedor no item da cotação de preçopurchaseQuotationId (integer) required
purchaseQuotationItemNumber (integer) required
data: {
. supplierId (integer)
} (object) required
purchase_quotations_v1/post_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiationsInclui uma nova negociação de cotação de preço para um fornecedorpurchaseQuotationId (integer) required
supplierId (integer) required
purchase_quotations_v1/patch_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations_latest_authorizeAutoriza a última negociação de cotação de preços para o fornecedorpurchaseQuotationId (integer) required
supplierId (integer) required
purchase_quotations_v1/put_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations_by_negotiation_numberAtualiza uma negociação de cotação de preço de um fornecedorpurchaseQuotationId (integer) required
supplierId (integer) required
negotiationNumber (integer) required
data: {
. supplierAnswerDate (string)
. validity (string)
. seller (string)
. discount (number)
. freightType (string)
. freightTypeForGeneratedPurchaseOrder (string)
. freightPrice (number)
. valueOtherExpenses (number)
. applyIpiFreight (boolean)
. internalNotes (string)
. supplierNotes (string)
. paymentTerms (array)
} (object) required
purchase_quotations_v1/put_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations_by_negotiation_number_items_by_quotation_item_numberAtualiza item de negociação de cotação de preço com fornecedorpurchaseQuotationId (integer) required
supplierId (integer) required
negotiationNumber (integer) required
quotationItemNumber (integer) required
data: {
. detailId (integer)
. trademarkId (integer)
. quotedQuantity (number)
. negotiatedQuantity (number)
. unitPrice (number)
. discount (number)
. discountPercentage (number)
. increasePercentage (number)
. ipiTaxPercentage (number)
. issTaxPercentage (number)
. icmsTaxPercentage (number)
. freightUnitPrice (number)
. reference (string)
. selectedOption (boolean)
. internalNotes (string)
. supplierNotes (string)
. negotiationDeliveries (array)
} (object) required
purchase_quotations_v1/get_purchase_quotations_comparison_map_pdfGera relatório e retorna url para download do PDF referente ao mapa de cotações.purchaseQuotationId (integer)
supplierId (integer)
buyerId (string)
buildingId (integer)
startDate (string) required
endDate (string) required
shortPrintFlag (boolean)
printGeneralDataFlag (boolean) required
printNumberRequestsOriginatedQuotationsFlag (boolean)
highlightHighestAndLowestPriceFlag (boolean)
highlightChosenSupplierFlag (boolean)
displayTradingAuthorizationHistoryFlag (boolean)
displaySupplierGroupPerPageFlag (boolean)
printQuotedPriceFlag (boolean)
printInternalObservationFlag (boolean)
showTheBestAndLastPriceConsideringDetailAndBrandFlag (boolean)
purchase_requests_v1/get_purchase_requests_by_purchase_request_idConsulta solicitação de comprapurchaseRequestId (integer) required
purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_authorizeAs notificações serão enviadas somente se a opção 'Sempre enviar aviso ao solicitante' estiver ativada. Se o acordo de preços estiver configurado e ativo, o sistema gerará pedidos ou contratos com base nos itens autorizados. Caso ocorra uma exceção no fluxo de geração de pedidos ou contratos, os itens da solicitação deverão permanecer autorizados.purchaseRequestId (integer) required
purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_disapprovalSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante'purchaseRequestId (integer) required
purchase_requests_v1/post_purchase_requestsCria uma solicitação de compra para uma obra já existentedata: {
. id (integer)
. buildingId (integer)
. departamentId (integer)
. requesterUser (string)
. requestDate (string)
. notes (string)
. status (string)
. consitent (string)
. createdBy (string)
. createdAt (string)
. modifiedBy (string)
. modifiedAt (string)
. purchaseProcessCarriedOutByBuildingFlag (boolean)
} (object) required
purchase_requests_v1/get_purchase_requests_all_itemsConsulta itens de solicitação de comprapurchaseRequestId (integer)
startDate (string)
endDate (string)
buildingId (integer)
requesterUser (string)
authorized (boolean)
disapproved (boolean)
limit (integer)
offset (integer)
purchaseRequestConsistency (string)
purchaseRequestStatus (string)
withOpenQuantity (boolean)
purchase_requests_v1/get_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_buildings_appropriationsConsulta apropriações de um item da solicitação de compra existentepurchaseRequestId (integer) required
purchaseRequestItemNumber (integer) required
limit (integer)
offset (integer)
purchase_requests_v1/get_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_delivery_requirementsConsulta entregas de um item da solicitação de compra existentepurchaseRequestId (integer) required
purchaseRequestItemNumber (integer) required
purchase_requests_v1/post_purchase_requests_by_purchase_request_id_itemsCria itens para uma solicitação de compra existentepurchaseRequestId (integer) required
data (array) required
purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_authorizeAs notificações serão enviadas somente se a opção 'Sempre enviar aviso ao solicitante' estiver ativada. Se o acordo de preços estiver configurado e ativo, o sistema gerará pedidos ou contratos com base nos itens autorizados. Caso ocorra uma exceção no fluxo de geração de pedidos ou contratos, os itens da solicitação deverão permanecer autorizados.purchaseRequestId (integer) required
data: {
. items (array)
} (object) required
purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_authorizeSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante'purchaseRequestId (integer) required
purchaseRequestItemNumber (integer) required
purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_disapprovalSomente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante'purchaseRequestId (integer) required
purchaseRequestItemNumber (integer) required
purchase_requests_v1/get_purchase_requests_by_purchase_request_id_attachmentsConsulta de anexos da solicitação de comprapurchaseRequestId (integer) required
purchase_requests_v1/get_purchase_requests_by_purchase_request_id_attachments_by_attachment_numberDownload do anexo da solicitação de comprapurchaseRequestId (integer) required
attachmentNumber (integer) required
real_estate_map_v1/get_real_estate_mapRetorna os dados do Mapa Imobiliário para os empreendimentos e período informados nos parâmetros.costCentersId (array) required
startDate (string) required
endDate (string) required
limit (integer)
offset (integer)
remade_installments_v1/get_remade_installmentsBusca os reparcelamentos das parcelas no SiengebillReceivableId (integer)
companyId (integer)
costCenterId (integer)
customerId (integer)
dueDateStart (string)
dueDateEnd (string)
remade_installments_v1/post_remade_installmentsRealiza um reparcelamento.data: {
. billReceivableId (integer)
. remadeDate (string)
. calculationDate (string)
. installments (string)
. builtInterestRule (string)
. interestPresentValue (number)
. differenceType (string)
. operationType (string)
. remadeType (string)
. remadeDescription (string)
. paymentConditions (array)
} (object) required
resource_groups_v1/get_resource_groupsRetorna um array com todos os grupos de insumos.query (string)
resourceGroups (array)
status (string)
offset (integer)
limit (integer)
resource_units_of_movement_v1/get_building_cost_estimations_by_building_id_resource_units_of_movementRetorna um array com as unidades de movimento dos insumos da obra. Retorna somente as unidades ativas dos insumos ativos.buildingId (integer) required
resourceId (integer)
offset (integer)
limit (integer)
sales_contracts_v1/get_sales_contractsBusca uma lista de contratos de vendas ordenados pelo código do contrato de forma decrescente.limit (integer)
offset (integer)
customerId (integer)
companyId (integer)
enterpriseId (integer)
enterpriseName (string)
externalId (string)
unitId (integer)
number (string)
situation (array)
createdAfter (string)
createdBefore (string)
modifiedAfter (string)
modifiedBefore (string)
onlyContractsWithoutCommission (boolean)
initialIssueDate (string)
finalIssueDate (string)
initialCancelDate (string)
finalCancelDate (string)
sales_contracts_v1/post_sales_contractsPersiste um contrato de vendas.data: {
. enterpriseId (integer)
. externalId (string)
. number (string)
. contractDate (string)
. expectedDeliveryDate (string)
. keysDeliveredAt (string)
. accountingDate (string)
. readjustAfterOf (string)
. saleType (string)
. correctionType (string)
. anualCorrectionType (string)
. generateResidue (string)
. diluteResidue (string)
. financialPlanAccount (string)
. value (number)
. totalSellingValue (number)
. note (string)
. readjustEach (integer)
. readjustMonth (integer)
. lateInterestDaily (boolean)
. proRataIndexer (integer)
. interestType (string)
. interestPercentage (number)
. fineRate (number)
. dailyLateInterestValue (number)
. housingProgram (string)
. discountType (string)
. discountPercentage (number)
. specialClause (string)
. paymentConditions (array)
. salesContractCustomers (array)
. salesContractUnits (array)
. brokers (array)
. salesContractGuarantors (array)
} (object) required
sales_contracts_v1/delete_sales_contracts_by_idExclui um contrato de vendas.id (integer) required
sales_contracts_v1/get_sales_contracts_by_idBusca um contrato de vendas.id (integer) required
sales_contracts_v1/patch_sales_contracts_by_idAtualiza dados de contratos.id (integer) required
data: {
. financialInstitutionNumber (string)
. financialInstitutionDate (string)
. keysDeliveredAt (string)
. registerPropertyDate (string)
. sellingCategory (string)
. financingStatus (string)
. contractDate (string)
. accountingDate (string)
. specialClause (string)
} (object) required
sales_contracts_v1/post_sales_contracts_by_id_attachmentsInclui um anexo ao contrato.id (integer) required
description (string) required
data: {
. file (object)
} (object) required
sales_contracts_v1/get_sales_contracts_by_id_attachmentsBusca as informações dos anexos do contratoid (integer) required
limit (integer)
offset (integer)
sales_contracts_v1/get_sales_contracts_by_id_attachments_by_attachment_idDownload de anexo do contratoid (integer) required
attachmentId (integer) required
sales_contracts_v1/get_sales_contracts_by_id_guarantorsBusca uma lista dos avalistas do contrato de vendas ordenados pelo código do avalista de forma decrescente.id (integer) required
limit (integer)
offset (integer)
sales_contracts_v1/post_sales_contracts_by_id_guarantorsInclui avalistas ao contrato.id (integer) required
data (array) required
sales_contracts_v1/get_sales_contracts_by_id_guarantors_by_guarantor_idBusca um avalista no contrato de venda.id (integer) required
guarantorId (integer) required
sales_contracts_v1/patch_sales_contracts_by_id_guarantors_by_guarantor_idAtualiza informações de avalistas do contrato.id (integer) required
guarantorId (integer) required
data: {
. name (string)
. cnpj (string)
. cpf (string)
. nationality (string)
. numberIdentityCard (string)
. professionId (integer)
. civilStatusId (integer)
. birthDate (string)
. email (string)
. lgpd (object)
. address (object)
. spouse (object)
} (object) required
sales_contracts_v1/put_sales_contracts_by_id_guarantors_by_guarantor_id_phonesSobrescreve a lista de telefones do avalista.id (integer) required
guarantorId (integer) required
data (array) required
sales_contracts_v1/post_sales_contracts_by_id_cancellationCancela um contrato de venda.id (integer) required
data: {
. date (string)
. reason (string)
. subType (string)
} (object) required
sites_v1/get_sitesBusca uma lista de locais de uma obralimit (integer)
offset (integer)
buildingId (string) required
stock_inventories_v1/get_stock_inventories_by_cost_center_id_itemsRetorna um array contendo as informações atuais de todos os insumos que estão no estoque do centro de custo informado. Insumos que estão com quantidade em estoque zerada não serão retornados. Cada item do array representa o estoque para uma combinação específica de insumo, detalhe e marca, conforme a organização desses dados no Sienge.costCenterId (integer) required
offset (integer)
limit (integer)
stock_inventories_v1/get_stock_inventories_by_cost_center_id_items_by_resource_id_building_appropriationConsulta as apropriações de obra do insumo em estoque no centro de custo informadocostCenterId (integer) required
resourceId (integer) required
detailId (integer)
trademarkId (integer)
offset (integer)
limit (integer)
stock_inventories_v1/get_stock_reservationsRetorna um array contendo todas as reservas consistentes de forma paginada.offset (integer)
limit (integer)
stock_inventories_v1/get_stock_reservations_by_reservation_id_itemsRetorna um array contendo todos os itens da reserva de estoque informada de forma paginada.reservationId (integer) required
stock_inventories_v1/post_stock_movementsCria um movimento de estoque de entrada ou de saída, para um ou mais insumos.data: {
. documentId (string)
. movementNumber (string)
. movementDate (string)
. movementTypeId (integer)
. costCenterId (integer)
. departmentId (integer)
. notes (string)
. items (array)
} (object) required
stock_inventories_v1/post_stock_movements_transferRealiza uma transferência de estoque entre centros de custo.data: {
. documentId (string)
. movementNumber (string)
. movementDate (string)
. movementTypeId (integer)
. notes (string)
. sourceCostCenterId (integer)
. sourceDepartmentId (integer)
. destinationCostCenterId (integer)
. destinationDepartmentId (integer)
. items (array)
} (object) required
stock_inventories_v1/post_stock_reservations_by_reservation_id_movementsCria um movimento que atende a reserva.reservationId (integer) required
data: {
. documentId (string)
. movementNumber (string)
. sourceDepartmentId (integer)
. destinationDepartmentId (integer)
. items (array)
} (object) required
stock_inventories_v1/get_inventory_movements_by_idRetorna uma movimentação de estoque.id (integer) required
stock_inventories_v1/get_inventory_movementsRetorna uma coleção de movimentações de estoque de forma paginada.documentId (string)
movementNumber (string)
movementTypeId (integer)
startDate (string)
endDate (string)
costCenterId (integer)
buildingId (integer)
offset (integer)
limit (integer)
tax_information_v1/post_bills_by_bill_id_tax_informationPersiste informações fiscais do tipo 'Serviço' no título informado.billId (integer) required
data: {
. status (integer)
. cancellationDate (string)
. creditorTaxingRegime (integer)
. entryDate (string)
. serialNumber (string)
. paymentType (integer)
. branchOfficeId (integer)
. operationTaxCode (string)
. cnaeCode (integer)
. cityServiceId (integer)
. taxSituationServiceCode (string)
. serviceTaxCode (string)
. natureServiceId (string)
. serviceExecutionDate (string)
. pisCofinsCalculationType (integer)
. pisCofinsCreditBaseId (integer)
. freightType (integer)
} (object) required
tax_information_v1/post_bills_by_bill_id_tax_information_itemsPersiste um item do tipo 'Serviço' nas informações fiscais do título informado.billId (integer) required
data: {
. taxService (integer)
. measurementUnit (integer)
. serviceCodeId (integer)
. cnaeCode (integer)
. additionalDescription (string)
. quantity (number)
. unitPrice (number)
. employedMaterialValue (number)
. contractedSubcontractValue (number)
. itemDiscountValue (number)
. operationTaxCode (string)
. serviceTaxCode (string)
. natureServiceId (string)
. pisTaxSituation (string)
. pisCalculationBasis (number)
. pisRate (number)
. pisWithheldCalculationBasis (number)
. pisWithheldRate (number)
. cofinsTaxSituation (string)
. cofinsCalculationBasis (number)
. cofinsRate (number)
. cofinsWithheldCalculationBasis (number)
. cofinsWithheldRate (number)
. issTaxSituation (string)
. issDeductionPercentage (number)
. issMaterialDeductionValue (number)
. issSubContractDeductionValue (number)
. issCalculationBasis (number)
. issRate (number)
. issOthersValue (number)
. issWithheldCalculationBasis (number)
. issWithheldRate (number)
. inssWithheldCalculationBasis (number)
. inssWithheldRate (number)
. irffWithheldCalculationBasis (number)
. irffWithheldRate (number)
. csllWithheldCalculationBasis (number)
. csllWithheldRate (number)
} (object) required
total_current_debit_balance_v1/get_total_current_debit_balanceGera as informações referentes ao total do saldo devedor presente do cliente informado.cpf (string)
cnpj (string)
correctionDate (string)
conditionIdIn (array)
conditionIdNotIn (array)
receivableBillsIds (array)
trademarks_v1/get_trademarksA API disponibiliza uma lista de Marcas existentes no sistema, trazendo o id, descrição e status.trademarkId (integer)
trademarkDescription (string)
status (string)
offset (integer)
limit (integer)
trial_balance_v1/get_trial_balanceBusca dados do balancete de verificaçãocompanyId (integer) required
initialPeriod (string) required
finalPeriod (string) required
accountId (string)
desconsiderClosingBalance (boolean)
reportType (string)
onlyAccountsWithMovements (boolean)
thirdParties (boolean)
unit_bookings_v1/post_unit_bookingsReserva uma unidade.data: {
. enterpriseId (integer)
. unitId (integer)
. brokerId (integer)
. customerId (integer)
. validityDate (string)
. bill (object)
. note (string)
} (object) required
unit_bookings_v1/patch_unit_bookings_units_by_id_deactivateInativa a reserva da unidade.id (integer) required
unit_v1/get_units_by_unit_idBusca a unidade no SiengeunitId (integer) required
unit_v1/patch_units_by_unit_idAtualiza informações da UnidadeunitId (integer) required
data: {
. commercialStock (string)
. prizedCompliance (number)
. iptuValue (number)
. realEstateRegistration (string)
} (object) required
unit_v1/get_unitsBusca uma lista de unidades ordenadas decrescentemente pelo código idlimit (integer)
offset (integer)
enterpriseId (integer)
commercialStock (string)
name (string)
additionalData (string)
unit_v1/post_unitsPersiste uma Unidade.data: {
. enterpriseId (integer)
. indexerId (integer)
. classificationUnit (integer)
. propertyTypeId (integer)
. situationId (integer)
. condominiumValue (number)
. privateArea (number)
. usableArea (number)
. commonArea (number)
. nonProportionalCommonArea (number)
. terrainArea (number)
. terrainValue (number)
. idealFraction (number)
. idealFractionSquareMeter (number)
. indexedQuantity (number)
. iptuValue (number)
. generalSaleValueFraction (number)
. prizedCompliance (number)
. realEstateRegistration (string)
. name (string)
. commercialStock (string)
. legalStock (string)
. constructionStock (string)
. location (string)
. floor (string)
. legalRegistrationNumber (string)
. latitude (string)
. longitude (string)
. note (string)
. endorsement (string)
. availableDate (string)
. deliveryDate (string)
. occupancyDate (string)
. purchaseDeed (array)
. landDetails (array)
. unitGroupings (array)
} (object) required
unit_v1/post_units_by_unit_id_child_unitAdiciona uma ou mais unidades filhas na unidade pelo ID.unitId (integer) required
data: {
. propertyTypeId (integer)
. privateArea (number)
. commonArea (number)
. idealFraction (number)
. idealFractionSquareMeter (number)
. name (string)
. locationName (string)
. note (string)
} (object) required
unit_v1/put_units_by_unit_id_addressAtualiza o endereço da unidadeunitId (integer) required
data: {
. cityId (integer)
. streetName (string)
. complement (string)
. number (string)
. neighborhood (string)
. zipCode (string)
. streetType (integer)
} (object) required
unit_v1/get_units_by_unit_id_groupingsBusca agrupamentos de unidade no SiengeunitId (integer) required
unit_v1/post_units_by_unit_id_attachmentsInclui um anexo a unidade.unitId (integer) required
description (string) required
data: {
. file (object)
} (object) required
unit_v1/post_units_characteristicsCria uma característica da unidade.data: {
. description (string)
} (object) required
unit_v1/get_units_characteristicsRetorna todas características de unidade cadastradaslimit (integer)
offset (integer)
unit_v1/put_units_by_unit_id_characteristicsVincula uma ou mais características já cadastradas a uma unidadeunitId (integer) required
data (array) required
unit_v1/post_units_situationsCria uma situação para unidade.data: {
. description (string)
} (object) required
unit_v1/get_units_situationsRetorna todas situaçãos de unidade cadastradaslimit (integer)
offset (integer)
units_of_measure_v1/get_units_of_measureRetorna lista de unidades de medidas.unitOfMeasureId (integer)
unitOfMeasureDescription (string)
unitOfMeasureSymbol (string)
unitOfTime (boolean)
status (string)
offset (integer)
limit (integer)
work_item_groups_v1/get_work_item_groupsA API disponibiliza uma lista de Grupos de Serviços existentes no sistema, trazendo o código de referência, nível, descrição, Código Auxiliar e Código do tipo de obra.buildingTypeId (integer)
workItemGroups (array)
description (string)
offset (integer)
limit (integer)
customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body
_headers (object)