Sienge
Integração com a API do Sienge, software de gestão para construção civil.
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 354 actions:
| Action | Purpose | Parameters |
|---|---|---|
| accountancy_accounts_v1/get_accountancy_accounts | Lista 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_id | Retorna conta modificada. | id (string) |
| accountancy_batch_v1/post_batch | Salva lotes contábeis | data: { . companyId (integer) . batchType (string) . batchDescription (string) . startDate (string) . endDate (string) } (object) required |
| accountancy_batch_v1/get_batch | Busca lotes contábeis | companyId (integer) required batchType (string) batchStatus (string) batchDescription (string) startDate (string) required endDate (string) required limit (integer) offset (integer) |
| accountancy_closingaccountancy_v1/get_closingaccountancy | Busca empresas com saldos consolidados atualizados | companyId (integer) accountId (string) monthYear (string) required limit (integer) offset (integer) |
| accountancy_entries_v1/post_accountancy_entries | Salva lançamentos contábeis | data (array) required |
| accountancy_entries_v1/get_accountancy_entries | Busca lançamentos contábeis | companyId (integer) required limit (integer) offset (integer) entryBatchId (integer) entryType (string) costCenter (integer) startDate (string) endDate (string) account (string) |
| accountancy_entries_v1/post_accountancy_entries_async | Salva lançamentos contábeis assíncronos | data (array) required |
| accountancy_entries_v1/get_accountancy_entries_async_status | Retorna o status do processamento dos lançamentos | No parameters |
| accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches | Lista os lotes ordenados por Id. | companyId (integer) limit (integer) offset (integer) |
| accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches_by_id | Mostra um lote pelo código. | id (integer) |
| accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entry_batches_by_id_entries | Mostra as informações dos lançamentos do lote especificado pelo código do lote, ordenados pelo código dos lançamentos. | id (integer) startDate (string) endDate (string) limit (integer) offset (integer) |
| accountancy_entrygenerator_entrybatches_v1/get_accountancy_entry_generator_entries | Mostra 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_id | Mostra as informações dos lançamentos pelo código do lançamento, ordenado pelo código do lote | id (integer) entryId (integer) limit (integer) offset (integer) |
| accounts_balances_v1/get_accounts_balances | Retorna 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_bills | Busca os títulos do cliente no Sienge | customerId (integer) required companyId (integer) costCenterId (integer) paidOff (boolean) limit (integer) offset (integer) |
| accounts_receivable_v1/get_accounts_receivable_receivable_bills_by_receivable_bill_id | Busca os títulos no Sienge pelo número | receivableBillId (integer) |
| accounts_receivable_v1/get_accounts_receivable_receivable_bills_by_receivable_bill_id_installments | Busca as parcelas do título | receivableBillId (integer) 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_date | Altera 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) installmentId (integer) data: { . newDueDate (string) } (object) required |
| accounts_receivable_v1/get_accounts_receivable_by_receivable_bill_id_budget_categories | Busca as apropriações financeiras do título | receivableBillId (integer) limit (integer) offset (integer) |
| accounts_statements_v1/get_accounts_statements | Retorna 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_receivable | Busca uma lista de Portadores | limit (integer) offset (integer) filter (string) |
| bill_debt_v1/get_bills | Busca os títulos no Sienge | startDate (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_bills | Inserção do título no Sienge | data: { . 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_date | Busca os títulos no Sienge de acordo com a data de alteração | startDate (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_id | Busca o título no Sienge | billId (integer) |
| bill_debt_v1/patch_bills_by_bill_id | Atualiza o título no Sienge | billId (integer) data: { . documentIdentificationId (string) . documentNumber (string) } (object) required |
| bill_debt_v1/post_eletronic_invoice_bills | Inserção do título no Sienge com base em nota fiscal eletrônica recebida | data: { . 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_installments | Busca as parcelas do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id | Atualiza parcela do título | billId (integer) installmentId (integer) 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_transfer | Inserção de informação de pagamento da parcela do tipo transferência bancária | billId (integer) installmentId (integer) 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_transfer | Busca informação de pagamento da parcela do tipo transferência bancária | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_bancario | Inserção de informação de pagamento da parcela do tipo boleto bancário | billId (integer) installmentId (integer) 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_bancario | Busca informação de pagamento da parcela do tipo boleto bancário | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_concessionaria | Inserção de informação de pagamento da parcela do tipo boleto concessionária | billId (integer) installmentId (integer) 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_concessionaria | Busca informação de pagamento da parcela do tipo boleto concessionária | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_boleto_tax | Inserção de informação de pagamento da parcela do tipo tributos com código de barras | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos com código de barras | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_dda | Inserção de informação de pagamento da parcela do tipo débito direto autorizado | billId (integer) installmentId (integer) 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_dda | Busca informação de pagamento da parcela do tipo débito direto autorizado | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_darf_tax | Inserção de informação de pagamento da parcela do tipo tributos DARF | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos DARF | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_darj_tax | Inserção de informação de pagamento da parcela do tipo tributos DARJ | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos DARJ | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_fgts_tax | Inserção de informação de pagamento da parcela do tipo tributos FGTS | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos FGTS | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_gare_tax | Inserção de informação de pagamento da parcela do tipo tributos GARE | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos GARE | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_inss_tax | Inserção de informação de pagamento da parcela do tipo tributos INSS | billId (integer) installmentId (integer) 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_tax | Busca informação de pagamento da parcela do tipo tributos INSS | billId (integer) installmentId (integer) |
| bill_debt_v1/patch_bills_by_bill_id_installments_by_installment_id_payment_information_pix | Inserção de informação de pagamento da parcela do tipo Pix | billId (integer) installmentId (integer) 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_pix | Busca informação de pagamento da parcela do tipo Pix | billId (integer) installmentId (integer) |
| bill_debt_v1/get_bills_by_bill_id_taxes | Busca os impostos do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/get_bills_by_bill_id_budget_categories | Busca as apropriações financeiras do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/get_bills_by_bill_id_departments_cost | Busca as apropriações departamento do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/get_bills_by_bill_id_buildings_cost | Busca as apropriações obra do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/put_bills_by_bill_id_buildings_cost | Atualiza as apropriações obra do título | billId (integer) data (array) required |
| bill_debt_v1/post_bills_by_bill_id_attachments | Inserção de anexo no título | billId (integer) description (string) required |
| bill_debt_v1/get_bills_by_bill_id_attachments | Busca as informações dos anexos do título | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/get_bills_by_bill_id_attachments_by_attachment_id | Download de anexo do título | billId (integer) attachmentId (integer) |
| bill_debt_v1/get_bills_by_bill_id_units | Busca as unidades do título no Sienge | billId (integer) limit (integer) offset (integer) |
| bill_debt_v1/put_bills_by_bill_id_units | Altera as unidades do título no Sienge | billId (integer) data (array) required |
| building_calendar_v1/get_building_projects_by_building_id_calendar | Retorna 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) |
| building_calendar_v1/put_building_projects_by_building_id_calendar | Insere 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) data: { . projectStartDate (string) . projectFinishDate (string) . considerHolidaysAndDaysOffInGeneralRegister (boolean) . considerSaturdaysAsWorkingDay (boolean) . considerSundaysAsWorkingDay (boolean) } (object) required |
| building_calendar_v1/get_building_projects_by_building_id_calendar_days_off | Retorna 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) offset (integer) limit (integer) |
| building_calendar_v1/post_building_projects_by_building_id_calendar_days_off | Insere 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) data (array) required |
| building_calendar_v1/delete_building_projects_by_building_id_calendar_days_off | Remove 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) data (array) required |
| building_cost_estimation_cost_estimate_resources_v1/get_building_cost_estimations_by_building_id_cost_estimate_resources | Retorno um array com todos os insumos orçados | buildingId (integer) offset (integer) limit (integer) buildingUnitId (integer) |
| building_cost_estimation_resources_v1/get_building_cost_estimations_by_building_id_resources | Retorna um array com todos os insumos ativos do orçamento de uma obra | buildingId (integer) resourceGroups (array) offset (integer) limit (integer) |
| building_cost_estimation_resources_v1/post_building_cost_estimations_by_building_id_resources | Inclui um insumo no orçamento de uma obra. | buildingId (integer) data: { . id (integer) } (object) required |
| building_cost_estimation_resources_v1/get_building_cost_estimations_by_building_id_resources_by_id | Retorna um insumo do orçamento de uma obra | buildingId (integer) id (integer) |
| building_cost_estimation_resources_v1/patch_building_cost_estimations_by_building_id_resources_by_id | Atualiza o código auxiliar de um insumo no orçamento de uma obra | buildingId (integer) id (integer) data: { . resourceCode (string) } (object) required |
| building_cost_estimations_v1/get_building_cost_estimations_by_building_id_sheets | Retorna 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) offset (integer) limit (integer) |
| building_cost_estimations_v1/get_building_cost_estimations_by_building_id_sheets_by_building_unit_id_items | Retorna 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) building_unit_id (integer) offset (integer) limit (integer) |
| building_projects_progress_logs_v1/post_building_projects_by_building_id_progress_logs | Atualiza percentual de avanço físico das Tarefas do Planejamento de uma Obra. | buildingId (integer) data: { . date (string) . items (array) } (object) required |
| building_projects_progress_logs_v1/get_building_projects_progress_logs | Consulta 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_number | Consulta o progresso do Planejamento de uma Obra. | buildingId (integer) measurementNumber (integer) |
| building_projects_progress_logs_v1/get_building_projects_by_building_id_progress_logs_by_measurement_number_items_by_building_unit_id | Consulta informações dos itens de uma medição específica. | buildingId (integer) measurementNumber (integer) buildingUnitId (integer) |
| building_projects_v1/get_building_projects_by_building_id_sheets_by_building_unit_id_tasks | Retorna 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) buildingUnitId (integer) offset (integer) limit (integer) |
| building_projects_v1/put_building_projects_by_building_id_sheets_by_building_unit_id_tasks | Insere 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) buildingUnitId (integer) allowDeleteTaskCostItem (boolean) data (array) required |
| bulk_data_account_company_balance_v1/get_accountancy_account_balance | Retorna 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_balance | Retorna saldos contábeis, caso possua. | startDate (string) required endDate (string) required costCentersId (array) accountId (string) includeBalancesWithoutCostCenter (boolean) |
| bulk_data_bank_movement_v1/get_bank_movement | Retorna 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_movements | Retorna movimentos financeiros, caso possua. | movementsIds (array) required |
| bulk_data_building_cost_estimations_v1/get_building_cost_estimation_items | Retorna 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_resources | Retorna 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_budget | Retorna 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_balance | Realiza 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_history | Realiza 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_bills | Retorna 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_aging | Retorna 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_income | Retorna 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_bills | Retorna 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_itens | Realiza leitura de itens das notas fiscais. | companyId (integer) required startDate (string) required endDate (string) required showCostCenterId (string) |
| bulk_data_outcome_v1/get_outcome | Retorna 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_bills | Retorna parcelas. | billsIds (array) required correctionIndexerId (integer) correctionDate (string) withAuthorizations (boolean) withBankMovements (boolean) |
| bulk_data_purchase_quotations_v1/get_purchase_quotations | Retorna 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_sales | Realiza leitura dos contratos de vendas. | enterpriseId (integer) required createdAfter (string) required createdBefore (string) required situation (string) required valueGroupingDescription (string) |
| checking_accounts_v1/get_checking_accounts | Busca uma lista de contas-correntes ordenando pelo número da conta | companyId (integer) accountNumber (string) accountStatus (string) limit (integer) offset (integer) |
| cities_v1/get_cities | Busca uma lista de municípios | limit (integer) offset (integer) name (string) stateCode (string) |
| civil_status_v1/post_civil_status | Persiste um estado civil. | data: { . description (string) . type } (object) required |
| civil_status_v1/get_civil_status | Busca uma lista de estados civis | limit (integer) offset (integer) description (string) |
| collections_notification_history_v1/get_collections_notification_history_by_collection_notification_history_id | Busca o histórico da notificação de cobrança no Sienge | collectionNotificationHistoryId (integer) |
| commissions_forecasts_v1/get_sales_commissions | Busca uma lista de comissões de venda. | limit (integer) offset (integer) contractId (integer) brokerId (integer) customerId (integer) |
| commissions_forecasts_v1/post_sales_commissions_forecasts | Insere 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_commissions | Persiste uma comissão. | data: { . salesContractId (integer) . baseValue (number) . released (boolean) . brokers (array) } (object) required |
| commissions_v1/get_commissions | Busca 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_id | Busca uma comissão por ID. | id (integer) |
| commissions_v1/patch_commissions_by_id | Altera uma comissão por ID. | id (integer) data: { . brokers (array) } (object) required |
| commissions_v1/delete_commissions_by_id | Deleta uma comissão por ID. | id (integer) |
| commissions_v1/patch_commissions_authorize | Realiza autorização, ou desfaz autorização das parcelas. | data: { . authorize (boolean) . commissions } (object) required |
| commissions_v1/patch_commissions_cancel | Realiza cancelamento, ativação das parcelas. | data: { . cancel (boolean) . commissions } (object) required |
| commissions_v1/post_commissions_release | Realiza 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_corretor | Deleta corretor de uma comissão por ID. | id (integer) idCorretor (integer) |
| commissions_v1/post_commissions_by_id_brokers | Adiciona um ou mais corretores na comissão por ID. | id (integer) data: { . brokers (array) } (object) required |
| commissions_v1/get_commissions_count_filters | Retorna 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_brokers | Persiste uma configuração de corretor. | data (undefined) required |
| commissions_v1/get_commissions_configurations_brokers | Consulta uma lista de configurações de corretores. | offset (integer) limit (integer) filter (string) |
| commissions_v1/patch_commissions_configurations_brokers_by_id | Atualiza um registro de configuração do corretor. | id (integer) data: { . percentage (number) . installments (integer) } (object) required |
| commissions_v1/delete_commissions_configurations_brokers_by_id | Deleta um registro de configuração do corretor por ID. | id (integer) |
| commissions_v1/post_commissions_configurations_enterprises | Persiste uma configuração de empreendimento. | data (undefined) required |
| commissions_v1/get_commissions_configurations_enterprises_by_id | Consulta as configurações de um empreendimento. | id (integer) |
| commissions_v1/put_commissions_configurations_enterprises_by_id | Atualiza um registro de configuração do empreendimento. | id (integer) data: { . indexerId (integer) . limitPercentage (number) . releasePercentageAdjustment (number) . cancelCommissionsOnContractCancelation (boolean) . allowReleaseCommissionWithPendings (boolean) . considerForPayment (object) } (object) required |
| company_v1/get_companies_by_company_id | Busca a empresa no Sienge | companyId (integer) |
| company_v1/get_companies | Busca uma lista de empresas ordenadas pelo código id | limit (integer) offset (integer) |
| construction_daily_report_v1/get_construction_daily_report | Retorna os Diários das Obras paginados. | buildingId (integer) startDate (string) endDate (string) offset (integer) limit (integer) |
| construction_daily_report_v1/post_construction_daily_report | Cadastra 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_id | Retorna todos os dados de um Diário de Obra específico | buildingId (integer) constructionDailyId (integer) |
| construction_daily_report_v1/delete_construction_daily_report_by_building_id_by_construction_daily_id | Deleta um Diário de Obra, exceto aqueles que tenham sido usados em uma Integração. | buildingId (integer) constructionDailyId (integer) |
| construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_attachments | Inclui anexo em um Diário de Obra | buildingId (integer) constructionDailyId (integer) 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_id | Retorna o anexo de um Diário de Obra | buildingId (integer) constructionDailyId (integer) attachmentId (integer) |
| construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_events | Inclui ocorrências em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_events | Atualiza Ocorrências em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_tasks | Inclui tarefas em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data: { . plannedTasks . detachedTasks } (object) required |
| construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_tasks | Atualiza tarefas em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data: { . plannedTasks . detachedTasks } (object) required |
| construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_crews | Inclui equipes em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_crews | Atualiza Equipes em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/post_construction_daily_report_by_building_id_by_construction_daily_id_equipments | Inclui equipamentos em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/put_construction_daily_report_by_building_id_by_construction_daily_id_equipments | Atualiza Equipamentos em um Diário de Obra | buildingId (integer) constructionDailyId (integer) data (array) required |
| construction_daily_report_v1/get_construction_daily_report_event_type | Retorna 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_types | Retorna 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_all | Consulta lista de contratos | contractStartDate (string) required contractEndDate (string) required companyId (integer) buildingId (integer) limit (integer) offset (integer) statusApproval (string) authorization (string) consistency (string) |
| contracts_v1/get_supply_contracts | Consultar contrato | documentId (string) required contractNumber (string) required |
| contracts_v1/get_supply_contracts_attachments_all | Lista de anexos do contrato | documentId (string) required contractNumber (string) required |
| contracts_v1/get_supply_contracts_attachments | Retorna o anexo do contrato | documentId (string) required contractNumber (string) required contractAttachmentNumber (string) required |
| contracts_v1/post_supply_contracts_attachments | Inclui anexo do contrato | documentId (string) required contractNumber (string) required description (string) required |
| contracts_v1/get_supply_contracts_buildings | Consultar obras do contrato com unidades construtivas | documentId (string) required contractNumber (string) required limit (integer) offset (integer) |
| contracts_v1/get_supply_contracts_addenda | Consultar aditivos de obras do contrato | documentId (string) contractNumber (string) buildingId (integer) addendumNumber (integer) addendumStartDate (string) addendumEndDate (string) limit (integer) offset (integer) |
| contracts_v1/get_supply_contracts_addenda_items | Consultar itens de aditivo da obra do contrato | documentId (string) required contractNumber (string) required buildingId (integer) required addendumNumber (integer) required limit (integer) offset (integer) |
| contracts_v1/get_supply_contracts_items | Retorna 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_authorize | Somente 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_disapprove | Somente 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_id | Busca todos os centros de custo no Sienge | costCenterId (integer) |
| cost_center_v1/get_cost_centers_by_cost_center_id_available | Busca centro de custo no Sienge com as contas correntes disponíveis | costCenterId (integer) |
| cost_center_v1/get_cost_centers | Busca todos os centros de custos no Sienge ordenados pelo codigo id | limit (integer) offset (integer) |
| cost_center_v1/get_cost_centers_immediate_register_settings | Busca as configurações de registro ATO cadastradas no centro de custo. | costCenterId (integer) required |
| cost_databases_v1/get_cost_databases | Retorna um array com todas as tabelas ativas do custos unitários | id (integer) description (string) status (string) costDatabaseEnabledForIntegration (boolean) offset (integer) limit (integer) |
| cost_databases_v1/get_cost_databases_by_id_resources | Retorna um array com todos os insumos ativos de uma tabela do custos unitários cost-database | id (integer) 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_id | Retorna o insumo correspondente ao id informado da tabela do custos unitários cost-database | id (integer) resourceId (integer) |
| cost_databases_v1/get_cost_databases_by_id_work_items | Retorna um array com todos os serviços ativos de uma tabela do custos unitários cost-database | id (string) buildingTypeId (integer) description (string) status (string) offset (integer) limit (integer) |
| cost_databases_v1/get_cost_databases_by_id_work_items_assemblies | Retorna 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) buildingTypeId (integer) description (string) workItemIds (array) offset (integer) limit (integer) |
| creditor_report_v1/get_creditor_report_pdf | Gera 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_creditors | Inserção de credor no Sienge | data: { . name (string) . personType (string) . typesId (array) . registerNumber (string) . stateRegistrationNumber (string) . stateRegistrationType (string) . municipalSubscription (string) . paymentTypeId (integer) . phone . agents (array) . contacts (array) . procurators (array) . payslipDesonerationYears (array) . address . accountStatement } (object) required |
| creditor_v1/get_creditors | Busca o credor no Sienge | cpf (string) cnpj (string) creditor (string) limit (integer) offset (integer) |
| creditor_v1/get_creditors_by_creditor_id | Busca o credor no Sienge | creditorId (integer) |
| creditor_v1/patch_creditors_by_creditor_id | Atualiza informações referentes ao credor no Sienge | creditorId (integer) data: { . name (string) . personType (string) . cpf (string) . cnpj (string) . stateRegistrationNumber (string) . stateRegistrationType (string) . municipalSubscription (string) . address } (object) required |
| creditor_v1/post_creditors_by_creditor_id_bank_informations | Inserção das informações bancárias do credor no Sienge | creditorId (integer) data (array) required |
| creditor_v1/get_creditors_by_creditor_id_bank_informations | Busca as informações bancárias do credor no Sienge | creditorId (integer) limit (integer) offset (integer) |
| creditor_v1/patch_creditors_by_creditor_id_bank_informations_by_banck_information_id | Atualizar as informações bancárias do credor no Sienge | creditorId (integer) banckInformationId (integer) data: { . paymentTypeId (integer) . accountStatement } (object) required |
| creditor_v1/post_creditors_by_creditor_id_pix_informations | Insere as informações de pix do credor no Sienge | creditorId (integer) data: { . type (string) . key (string) . beneficiary (string) . cpfCnpjBeneficiary (string) . defaultFlag (string) } (object) required |
| creditor_v1/get_creditors_by_creditor_id_pix_informations | Busca as informações de pix do credor no Sienge | creditorId (integer) limit (integer) offset (integer) |
| creditor_v1/patch_creditors_by_creditor_id_pix_informations_by_pix_information_id | Altera as informações de pix do credor no Sienge | creditorId (integer) pixInformationId (integer) data: { . type (string) . key (string) . beneficiary (string) . cpfCnpjBeneficiary (string) . defaultFlag (string) } (object) required |
| creditor_v1/patch_creditors_by_creditor_id_phone_by_phone_id | Atualizar as informações de um telefone do credor no Sienge | creditorId (integer) phoneId (integer) data: { . ddd (string) . number (string) . main (boolean) . type (string) } (object) required |
| creditor_v1/patch_creditors_by_creditor_id_contact_by_contact_id | Atualizar as informações de um contato do credor no Sienge | creditorId (integer) contactId (integer) data: { . name (string) . phoneDdd (string) . phoneNumber (string) . phoneExtension (string) . email (string) } (object) required |
| creditor_v1/patch_creditors_by_creditor_id_procurator_by_procurator_id | Atualizar as informações de um procurador do credor no Sienge | creditorId (integer) procuratorId (integer) 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_agents | Enviar todos os códigos de representantes quando for atualizar | creditorId (integer) data (array) required |
| creditor_v1/put_creditors_by_creditor_id_payslip_desoneration_years | Ao 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) data (array) required |
| creditor_v1/put_creditors_by_creditor_id_activate | Ativar um credor desativado no Sienge | creditorId (integer) |
| creditor_v1/put_creditors_by_creditor_id_deactivate | Desativar um credor ativado no Sienge | creditorId (integer) |
| current_debit_balance_v1/get_current_debit_balance | Gera 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_pdf | Gera 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_statements | Envia relatório de extrato de cliente por e-mail | data: { . 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_statements | Exibe as informações do extrato do cliente | 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) includeBankMovements (boolean) |
| customer_financial_statements_v1/get_customer_financial_statements_pdf | Gera 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_report | Envia relatório de imposto de renda por e-mail | data: { . 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_pdf | Gera 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_types | Busca uma lista de tipos de clientes | limit (integer) offset (integer) id (integer) description (string) |
| customers_v1/get_customers | Busca 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_customers | Persiste 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_id | Busca um cliente. | id (integer) |
| customers_v1/patch_customers_by_id | Atualiza informações de um cliente. | id (integer) data: { . internationalId (string) . typeId (integer) . naturalPersonData . legalPersonData } (object) required |
| customers_v1/put_customers_by_id_phones | Atualiza os telefones de um cliente. | id (integer) data: { . phones (array) } (object) required |
| customers_v1/put_customers_by_id_spouse | Atualiza o cônjuge de um cliente, apagando o antigo cônjuge. Se não existir, cria. | id (integer) 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_incomes | Atualiza as rendas familiares de um cliente. | id (integer) data (array) required |
| customers_v1/put_customers_by_id_addresses_by_type | Atualiza os endereços de um cliente. Se não existir, cria. | id (integer) type (string) 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_attachments | Inclui um anexo ao cliente. | id (integer) description (string) required |
| customers_v1/get_customers_by_id_attachments | Busca as informações dos anexos do cliente | id (integer) limit (integer) offset (integer) |
| customers_v1/get_customers_by_id_attachments_by_attachment_id | Download de anexo do cliente | id (integer) attachmentId (integer) |
| customers_v1/post_customers_by_id_procurator | Inclui um procurador ao cliente. | id (integer) 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 . businessAddress . proxy . spouse . phones (array) } (object) required |
| departments_v1/get_departments_by_department_id | Busca o departamento no Sienge | departmentId (integer) |
| departments_v1/get_departments | Busca uma lista de departamentos | limit (integer) offset (integer) |
| document_identification_v1/get_document_identifications_by_document_identification_id | Busca o documento no Sienge | documentIdentificationId (string) |
| email_current_debit_balance_v1/post_email_current_debit_balance | Envia 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_id | Busca o empreendimento no Sienge | enterpriseId (integer) |
| enterprise_v1/get_enterprises | Busca uma lista de empreendimentos | companyId (integer) type (integer) limit (integer) offset (integer) receivableRegister (string) onlyBuildingsEnabledForIntegration (boolean) |
| enterprise_v1/get_enterprises_by_enterprise_id_groupings | Busca valores dos agrupamentos no Sienge | enterpriseId (integer) |
| fixed_assets_v1/get_patrimony_fixed | Lista os bens ordenados por código do patrimônio. | patrimonyId (integer) costCenter (string) detail (string) situation (string) limit (integer) offset (integer) |
| hooks_v1/get_hooks | Consulta paginada de WebHooks | limit (integer) offset (integer) |
| hooks_v1/post_hooks | Insere um novo WebHook | data: { . url (string) . token (string) . events (array) } (object) required |
| hooks_v1/get_hooks_by_hook_id | Consulta um WebHook específico por ID | hookId (string) |
| hooks_v1/delete_hooks_by_hook_id | Remove um WebHook específico por ID | hookId (string) |
| indexers_v1/get_indexers | Busca uma lista de indexadores | limit (integer) offset (integer) |
| measurement_v1/get_supply_contracts_measurements_all | Consulta medições de contratos | documentId (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_measurements | Consulta medições | documentId (string) required contractNumber (string) required buildingId (integer) required measurementNumber (integer) required |
| measurement_v1/post_supply_contracts_measurements | Cria 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_items | Retorna 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_clearing | Retorna 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_all | Consulta anexos de medição de contrato | measurementStartDate (string) required measurementEndDate (string) required documentId (string) contractNumber (string) buildingId (integer) measurementNumber (integer) limit (integer) offset (integer) |
| measurement_v1/get_supply_contracts_measurements_attachments | Download anexos de medição de contrato | documentId (string) required contractNumber (string) required buildingId (integer) required measurementNumber (integer) required attachmentNumber (integer) required |
| measurement_v1/post_supply_contracts_measurements_attachments | Inclui anexos de medição de contrato | documentId (string) required contractNumber (string) required buildingId (integer) required measurementNumber (integer) required description (string) required |
| measurement_v1/patch_supply_contracts_measurements_authorize | Somente 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_disapprove | Somente 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_movable | Lista 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_nfes | Retorna as notas fiscais em determinado período ordenadas por data de emissão | startDate (string) required endDate (string) required limit (integer) offset (integer) |
| nfe_api_v1/get_nfes_by_nfe_key | Retorna uma nota fiscal | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_issuers_recipients | Retorna o emitente e destinatario de uma nota | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_payments | Retorna as formas de pagamento de uma nota | nfeKey (string) limit (integer) offset (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_deliveries | Retorna as informações do local de entrega e retirada | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_linked_nfes | Retorna as notas referenciadas | nfeKey (string) limit (integer) offset (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_icms | Retorna as informações de icms total de uma nota | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_carriers | Retorna as informações de transporte, presentes na nota | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_issqn | Retorna as informações issqn total, presentes na nota | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_itens | Retorna os itens/produtos, presentes na nota | nfeKey (string) |
| nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_ipi | Retorna o ipi de determinado produto/serviço, presente na nota | nfeKey (string) itemId (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_pis_cofins | Retorna o pis-cofins de determinado produto/serviço, presente na nota | nfeKey (string) itemId (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_simplified_icms | Retorna o icms simples nacional de determinado produto/serviço, presente na nota | nfeKey (string) itemId (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_issqn | Retorna o issqn de determinado produto/serviço, presente na nota | nfeKey (string) itemId (integer) |
| nfe_api_v1/get_nfes_by_nfe_key_itens_by_item_id_icms | Retorna o icms de determinado produto/serviço, presente na nota | nfeKey (string) itemId (integer) |
| overdue_receivable_v1/post_overdue_receivable_bill | Registra 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_id | Retorna 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) |
| payment_categories_v1/get_payment_categories_by_payment_categories_id | Busca o plano financeiro no Sienge | paymentCategoriesId (integer) |
| payment_categories_v1/get_payment_categories | Busca todos os planos financeiros no Sienge | No parameters |
| payment_condition_types_v1/get_payment_condition_types | Busca os Tipos de Condição de Pagamento. | filter (string) offset (integer) limit (integer) |
| payment_slip_notification_v1/post_payment_slip_notification | Envia 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_notification | Gera 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_register | Registra 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_register | Consulta 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_tables | Busca 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_professions | Busca uma lista de profissões | limit (integer) offset (integer) name (string) |
| professions_v1/post_professions | Persiste uma lista de profissões. | data (array) required |
| professions_v1/get_professions_by_id | Busca uma profissão. | id (integer) |
| property_rental_v1/get_property_rental | Lista 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_rental | Cria 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_types | Busca uma lista de tipos de imóveis | limit (integer) offset (integer) name (string) |
| property_types_v1/get_property_types_by_id | Busca um tipo de imóvel. | id (integer) |
| purchase_invoices_v1/get_purchase_invoices_by_sequential_number | Consulta nota fiscal de compra | sequentialNumber (integer) |
| purchase_invoices_v1/get_purchase_invoices_by_sequential_number_items | Retorna os itens da nota fiscal de compra | sequentialNumber (integer) |
| purchase_invoices_v1/get_purchase_invoices | Retorna 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_invoices | Inserçã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_schedules | Inserção de itens em uma nota fiscal a partir de entregas de itens de pedidos de compra | sequentialNumber (integer) data: { . deliveriesOrder (array) . copyNotesPurchaseOrders (boolean) . copyNotesResources (boolean) . copyAttachmentsPurchaseOrders (boolean) } (object) required |
| purchase_invoices_v1/get_purchase_invoices_deliveries_attended | Retorna os itens atendidos entre o pedido de compra e a nota fiscal | billId (integer) sequentialNumber (integer) purchaseOrderId (integer) invoiceItemNumber (integer) purchaseOrderItemNumber (integer) limit (integer) offset (integer) |
| purchase_orders_v1/get_purchase_orders | Consulta pedidos de compra | startDate (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_id | Consulta pedido de compra | purchaseOrderId (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items | Consulta de itens do pedido de compra | purchaseOrderId (integer) limit (integer) offset (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_number | Consulta item do pedido de compra | purchaseOrderId (integer) itemNumber (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_number_delivery_schedules | Consulta de previsões de entregas do item do pedido de compra | purchaseOrderId (integer) itemNumber (integer) limit (integer) offset (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_items_by_item_number_buildings_appropriations | Consulta de apropriações de obra do item do pedido | purchaseOrderId (integer) itemNumber (integer) limit (integer) offset (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_totalization | Consultar a totalização do pedido de compra | purchaseOrderId (integer) limit (integer) offset (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_direct_billing | Consultar o faturamento direto simples do pedido de compra. Não consulta faturamento direto com desconto em medição. | purchaseOrderId (integer) limit (integer) offset (integer) |
| purchase_orders_v1/put_purchase_orders_by_purchase_order_id_authorize | Autoriza pedido de compra que está aguardando autorização | purchaseOrderId (integer) |
| purchase_orders_v1/patch_purchase_orders_by_purchase_order_id_authorize | Autoriza pedido de compra que está aguardando autorização com a opção de informar a observação | purchaseOrderId (integer) data (undefined) required |
| purchase_orders_v1/put_purchase_orders_by_purchase_order_id_disapprove | Reprova pedido de compra que está aguardando autorização | purchaseOrderId (integer) |
| purchase_orders_v1/patch_purchase_orders_by_purchase_order_id_disapprove | Reprova pedido de compra que está aguardando autorização com a opção de informar a observação | purchaseOrderId (integer) data (undefined) required |
| purchase_orders_v1/post_purchase_orders_by_purchase_order_id_attachments | Inserção de anexos no pedido de compra | purchaseOrderId (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_attachments | Busca as informações dos anexos do pedido de compra | purchaseOrderId (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_attachments_by_attachment_number | Download de anexo do Pedido de Compra | purchaseOrderId (integer) attachmentNumber (integer) |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_supplier_evaluation_criteria | Consulta os critérios de avaliação para um pedido específico | purchaseOrderId (integer) |
| purchase_orders_v1/post_purchase_orders_by_purchase_order_id_evaluation | Cadastra uma avaliação do fornecedor no pedido de compra | purchaseOrderId (integer) data (undefined) required |
| purchase_orders_v1/put_purchase_orders_by_purchase_order_id_evaluation | Cadastra uma avaliação do fornecedor no pedido de compra caso não exista, ou atualiza a última avaliação cadastrada | purchaseOrderId (integer) data (undefined) required |
| purchase_orders_v1/get_purchase_orders_by_purchase_order_id_analysis_pdf | Gera o relatório de Análise do Pedido de Compra informado e efetua download deste em formato PDF. | purchaseOrderId (integer) printPurchaseOrderAuthorizationObservationsFlag (boolean) printListOfPurchaseOrdersWithSameAppropriateItems (boolean) printOnlyPurchaseInvoicesWithOutstandingInstallments (boolean) printDetailedAmountsFromPurchaseInvoices (boolean) printAppropriationQuantity (boolean) |
| purchase_quotations_v1/post_purchase_quotations | Cria uma cotação de preço | data: { . buyerId (string) . date (string) } (object) required |
| purchase_quotations_v1/get_purchase_quotations_all_negotiations | Busca todas as cotações com negociações | quotationNumber (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_items | Cria um item de cotação de preço | purchaseQuotationId (integer) 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_request | Cria um item de cotação de preço a partir da entrega do item de solicitação de compra | purchaseQuotationId (integer) 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_suppliers | Inclui um fornecedor no item da cotação de preço | purchaseQuotationId (integer) purchaseQuotationItemNumber (integer) data: { . supplierId (integer) } (object) required |
| purchase_quotations_v1/post_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations | Inclui uma nova negociação de cotação de preço para um fornecedor | purchaseQuotationId (integer) supplierId (integer) |
| purchase_quotations_v1/patch_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations_latest_authorize | Autoriza a última negociação de cotação de preços para o fornecedor | purchaseQuotationId (integer) supplierId (integer) |
| purchase_quotations_v1/put_purchase_quotations_by_purchase_quotation_id_suppliers_by_supplier_id_negotiations_by_negotiation_number | Atualiza uma negociação de cotação de preço de um fornecedor | purchaseQuotationId (integer) supplierId (integer) negotiationNumber (integer) 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_number | Atualiza item de negociação de cotação de preço com fornecedor | purchaseQuotationId (integer) supplierId (integer) negotiationNumber (integer) quotationItemNumber (integer) 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_pdf | Gera 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_id | Consulta solicitação de compra | purchaseRequestId (integer) |
| purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_authorize | As 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) |
| purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_disapproval | Somente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante' | purchaseRequestId (integer) |
| purchase_requests_v1/post_purchase_requests | Cria uma solicitação de compra para uma obra já existente | data: { . 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_items | Consulta itens de solicitação de compra | purchaseRequestId (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_appropriations | Consulta apropriações de um item da solicitação de compra existente | purchaseRequestId (integer) purchaseRequestItemNumber (integer) limit (integer) offset (integer) |
| purchase_requests_v1/get_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_delivery_requirements | Consulta entregas de um item da solicitação de compra existente | purchaseRequestId (integer) purchaseRequestItemNumber (integer) |
| purchase_requests_v1/post_purchase_requests_by_purchase_request_id_items | Cria itens para uma solicitação de compra existente | purchaseRequestId (integer) data (array) required |
| purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_authorize | As 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) data: { . items (array) } (object) required |
| purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_authorize | Somente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante' | purchaseRequestId (integer) purchaseRequestItemNumber (integer) |
| purchase_requests_v1/patch_purchase_requests_by_purchase_request_id_items_by_purchase_request_item_number_disapproval | Somente irá enviar as notificações caso esteja configurado para 'Sempre enviar aviso ao solicitante' | purchaseRequestId (integer) purchaseRequestItemNumber (integer) |
| purchase_requests_v1/get_purchase_requests_by_purchase_request_id_attachments | Consulta de anexos da solicitação de compra | purchaseRequestId (integer) |
| purchase_requests_v1/get_purchase_requests_by_purchase_request_id_attachments_by_attachment_number | Download do anexo da solicitação de compra | purchaseRequestId (integer) attachmentNumber (integer) |
| real_estate_map_v1/get_real_estate_map | Retorna 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_installments | Busca os reparcelamentos das parcelas no Sienge | billReceivableId (integer) companyId (integer) costCenterId (integer) customerId (integer) dueDateStart (string) dueDateEnd (string) |
| remade_installments_v1/post_remade_installments | Realiza 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_groups | Retorna 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_movement | Retorna um array com as unidades de movimento dos insumos da obra. Retorna somente as unidades ativas dos insumos ativos. | buildingId (integer) resourceId (integer) offset (integer) limit (integer) |
| sales_contracts_v1/get_sales_contracts | Busca 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_contracts | Persiste 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_id | Exclui um contrato de vendas. | id (integer) |
| sales_contracts_v1/get_sales_contracts_by_id | Busca um contrato de vendas. | id (integer) |
| sales_contracts_v1/patch_sales_contracts_by_id | Atualiza dados de contratos. | id (integer) 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_attachments | Inclui um anexo ao contrato. | id (integer) description (string) required |
| sales_contracts_v1/get_sales_contracts_by_id_attachments | Busca as informações dos anexos do contrato | id (integer) limit (integer) offset (integer) |
| sales_contracts_v1/get_sales_contracts_by_id_attachments_by_attachment_id | Download de anexo do contrato | id (integer) attachmentId (integer) |
| sales_contracts_v1/get_sales_contracts_by_id_guarantors | Busca uma lista dos avalistas do contrato de vendas ordenados pelo código do avalista de forma decrescente. | id (integer) limit (integer) offset (integer) |
| sales_contracts_v1/post_sales_contracts_by_id_guarantors | Inclui avalistas ao contrato. | id (integer) data (array) required |
| sales_contracts_v1/get_sales_contracts_by_id_guarantors_by_guarantor_id | Busca um avalista no contrato de venda. | id (integer) guarantorId (integer) |
| sales_contracts_v1/patch_sales_contracts_by_id_guarantors_by_guarantor_id | Atualiza informações de avalistas do contrato. | id (integer) guarantorId (integer) data: { . name (string) . cnpj (string) . cpf (string) . nationality (string) . numberIdentityCard (string) . professionId (integer) . civilStatusId (integer) . birthDate (string) . email (string) . lgpd . address . spouse } (object) required |
| sales_contracts_v1/put_sales_contracts_by_id_guarantors_by_guarantor_id_phones | Sobrescreve a lista de telefones do avalista. | id (integer) guarantorId (integer) data (array) required |
| sales_contracts_v1/post_sales_contracts_by_id_cancellation | Cancela um contrato de venda. | id (integer) data: { . date (string) . reason (string) . subType (string) } (object) required |
| sites_v1/get_sites | Busca uma lista de locais de uma obra | limit (integer) offset (integer) buildingId (string) required |
| stock_inventories_v1/get_stock_inventories_by_cost_center_id_items | Retorna 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) offset (integer) limit (integer) |
| stock_inventories_v1/get_stock_inventories_by_cost_center_id_items_by_resource_id_building_appropriation | Consulta as apropriações de obra do insumo em estoque no centro de custo informado | costCenterId (integer) resourceId (integer) detailId (integer) trademarkId (integer) offset (integer) limit (integer) |
| stock_inventories_v1/get_stock_reservations | Retorna um array contendo todas as reservas consistentes de forma paginada. | offset (integer) limit (integer) |
| stock_inventories_v1/get_stock_reservations_by_reservation_id_items | Retorna um array contendo todos os itens da reserva de estoque informada de forma paginada. | reservationId (integer) |
| stock_inventories_v1/post_stock_movements | Cria 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_transfer | Realiza 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_movements | Cria um movimento que atende a reserva. | reservationId (integer) data: { . documentId (string) . movementNumber (string) . sourceDepartmentId (integer) . destinationDepartmentId (integer) . items (array) } (object) required |
| stock_inventories_v1/get_inventory_movements_by_id | Retorna uma movimentação de estoque. | id (integer) |
| stock_inventories_v1/get_inventory_movements | Retorna 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_information | Persiste informações fiscais do tipo 'Serviço' no título informado. | billId (integer) 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_items | Persiste um item do tipo 'Serviço' nas informações fiscais do título informado. | billId (integer) 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_balance | Gera 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_trademarks | A 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_balance | Busca dados do balancete de verificação | companyId (integer) required initialPeriod (string) required finalPeriod (string) required accountId (string) desconsiderClosingBalance (boolean) reportType (string) onlyAccountsWithMovements (boolean) thirdParties (boolean) |
| unit_bookings_v1/post_unit_bookings | Reserva 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_deactivate | Inativa a reserva da unidade. | id (integer) |
| unit_v1/get_units_by_unit_id | Busca a unidade no Sienge | unitId (integer) |
| unit_v1/patch_units_by_unit_id | Atualiza informações da Unidade | unitId (integer) data: { . commercialStock (string) . prizedCompliance (number) . iptuValue (number) . realEstateRegistration (string) } (object) required |
| unit_v1/get_units | Busca uma lista de unidades ordenadas decrescentemente pelo código id | limit (integer) offset (integer) enterpriseId (integer) commercialStock (string) name (string) additionalData (string) |
| unit_v1/post_units | Persiste 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_unit | Adiciona uma ou mais unidades filhas na unidade pelo ID. | unitId (integer) 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_address | Atualiza o endereço da unidade | unitId (integer) data: { . cityId (integer) . streetName (string) . complement (string) . number (string) . neighborhood (string) . zipCode (string) . streetType (integer) } (object) required |
| unit_v1/get_units_by_unit_id_groupings | Busca agrupamentos de unidade no Sienge | unitId (integer) |
| unit_v1/post_units_by_unit_id_attachments | Inclui um anexo a unidade. | unitId (integer) description (string) required |
| unit_v1/post_units_characteristics | Cria uma característica da unidade. | data: { . description (string) } (object) required |
| unit_v1/get_units_characteristics | Retorna todas características de unidade cadastradas | limit (integer) offset (integer) |
| unit_v1/put_units_by_unit_id_characteristics | Vincula uma ou mais características já cadastradas a uma unidade | unitId (integer) data (array) required |
| unit_v1/post_units_situations | Cria uma situação para unidade. | data: { . description (string) } (object) required |
| unit_v1/get_units_situations | Retorna todas situaçãos de unidade cadastradas | limit (integer) offset (integer) |
| units_of_measure_v1/get_units_of_measure | Retorna 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_groups | A 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) |