
1. Add your Sienge access
- In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Sienge option from the list of connectors.
-
Click Next and you’ll be prompted to fill the configuration.
- API User: The user to authenticate against the API service. Check this documentation on how to create it.
- API Password: The password to authenticate against the API service.
- Company Domain: The domain identifier for your company account. For example, if your Sienge workspace URL is
https://mycompany.sienge.com.br
, then your company subdomain would bemycompany
. - Company ID: The ID of the company to sync (use 1 if you don’t know).
- Building IDs: The IDs of the buildings you want to extract data, used in the Building Resources stream.
- Start date: The earliest record date to sync.
Make sure you include permission to extract bulk data from the API, usually referred asMassive
in the token configuration. You have to enable allMassive
endpoints. Here are some links from the official documentation to help with that: https://ajuda.sienge.com.br/support/solutions/articles/153000200945-como-liberar-recursos-para-integrar-com-construpoint- - Click Next.
2. Select your Sienge streams
-
The next step is letting us know which streams you want to bring. The streams available are related to the different modules in Sienge. You can select entire groups of streams or only a subset of them.
Tip: The stream can be found more easily by typing its name.
- Click Next.
3. Configure your Sienge data streams
-
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
- Click Next.
4. Configure your Sienge data source
- Describe your data source for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
- To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).
-
Optionally, you can define some additional settings (if available).
- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Check your new source!
- Click Next to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
- You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. You can now monitor it on the Sources page to see its execution and completion. If needed, manually trigger the pipeline by clicking on the refresh icon. Once executed, your new table will appear in the Catalog section.
If you encounter any issues, reach out to us, and we’ll gladly assist you!
Streams and Fields
Below you’ll find all available data streams from Sienge and their corresponding fields from the bulk API:Sales
Sales
Stream for managing sales information and customer relationships.Fields:
id
:Integer
enterpriseId
:Integer
receivableBillId
:Integer
refundBillId
:Integer
proRataIndexer
:Number
number
:String
situation
:String
externalId
:String
note
:String
cancellationReason
:String
interestType
:String
lateInterestCalculationType
:String
financialInstitutionNumber
:String
discountType
:String
correctionType
:String
anualCorrectionType
:String
associativeCredit
:String
discountPercentage
:Number
value
:Number
totalSellingValue
:Number
interestPercentage
:Number
fineRate
:Number
dailyLateInterestValue
:Number
creationDate
:DateTime
contractDate
:DateTime
issueDate
:DateTime
cancellationDate
:DateTime
financialInstitutionDate
:DateTime
customers
:Array of Objects
id
:Integer
main
:Boolean
spouse
:Boolean
participationPercentage
:Number
personType
:String
cpf
:String
name
:String
email
:String
birthDate
:Date
marriageDate
:Date
civilStatus
:String
fatherName
:String
motherName
:String
sex
:String
cnpj
:String
nationality
:String
numberIdentityCard
:String
profession
:String
contactName
:String
fantasyName
:String
spouseData
:Object
cpf
:String
name
:String
email
:String
sex
:String
civilStatus
:String
birthDate
:Date
numberIdentityCard
:String
phones
:Array of Objects
type
:String
number
:String
main
:Boolean
note
:String
idd
:String
addresses
:Array of Objects
type
:String
streetName
:String
number
:String
complement
:String
neighborhood
:String
cityId
:Integer
city
:String
state
:String
zipCode
:String
mail
:Boolean
units
:Array of Objects
id
:Integer
main
:Boolean
participationPercentage
:Number
name
:String
propertyType
:String
note
:String
commercialStock
:String
legalRegistrationNumber
:String
deliveryDate
:DateTime
privateArea
:Number
commonArea
:Number
terrainArea
:Number
idealFraction
:Number
idealFractionSquareMeter
:Number
indexedQuantity
:Number
childUnits
:Array of Objects
name
:String
order
:String
privateArea
:Number
commonArea
:Number
idealFraction
:Number
idealFractionSquareMeter
:Number
locationName
:String
note
:String
groupings
:Array of Objects
groupingDescription
:String
valueGroupingDescription
:String
paymentConditions
:Array of Objects
conditionTypeId
:String
conditionTypeName
:String
bearerId
:String
bearerName
:String
installmentsNumber
:Integer
totalValue
:Number
firstPayment
:String
brokers
:Array of Objects
id
:Integer
name
:String
main
:Boolean
Income
Income
Stream containing income and receipt information.Fields:
companyId
:Integer
companyName
:String
businessAreaId
:Integer
businessAreaName
:String
projectId
:Integer
projectName
:String
groupCompanyId
:Integer
groupCompanyName
:String
holdingId
:Integer
holdingName
:String
subsidiaryId
:Integer
subsidiaryName
:String
businessTypeId
:Integer
businessTypeName
:String
clientId
:Integer
clientName
:String
billId
:Integer
installmentId
:Integer
documentIdentificationId
:String
documentIdentificationName
:String
documentNumber
:String
documentForecast
:String
originId
:String
originalAmount
:Number
discountAmount
:Number
taxAmount
:Number
indexerId
:Integer
indexerName
:String
dueDate
:Date
issueDate
:Date
billDate
:Date
installmentBaseDate
:Date
balanceAmount
:Number
correctedBalanceAmount
:Number
periodicityType
:String
embeddedInterestAmount
:Number
interestType
:String
interestRate
:Number
correctionType
:String
interestBaseDate
:String
defaulterSituation
:String
subJudicie
:String
mainUnit
:String
installmentNumber
:String
bearerId
:Integer
paymentTerm
:Object
id
:String
description
:String
descrition
:String
receiptsCategories
:Array of Objects
businessTypeId
:Integer
businessTypeName
:String
businessAreaId
:Integer
businessAreaName
:String
costCenterId
:Integer
costCenterName
:String
financialCategoryId
:String
financialCategoryName
:String
financialCategoryReducer
:String
financialCategoryType
:String
financialCategoryRate
:Number
projectId
:Integer
projectName
:String
receipts
:Array of Objects
operationTypeId
:Integer
operationTypeName
:String
grossAmount
:Number
monetaryCorrectionAmount
:Number
interestAmount
:Number
fineAmount
:Number
discountAmount
:Number
taxAmount
:Number
netAmount
:Number
additionAmount
:Number
insuranceAmount
:Number
dueAdmAmount
:Number
calculationDate
:Date
paymentDate
:Date
accountCompanyId
:Integer
accountNumber
:String
accountType
:String
sequencialNumber
:Integer
indexerId
:Integer
embeddedInterestAmount
:Number
proRata
:Number
bankMovements
:Array of Objects
bankMovementDate
:Date
sequencialNumber
:Integer
id
:Integer
amount
:Number
historicId
:Integer
historicName
:String
operationId
:Integer
operationName
:String
operationType
:String
reconcile
:String
correctedAmount
:Number
originId
:String
financialCategories
:Array of Objects
projectId
:Integer
projectName
:String
businessTypeId
:Integer
businessTypeName
:String
businessAreaId
:Integer
businessAreaName
:String
costCenterId
:Integer
costCenterName
:String
financialCategoryId
:String
financialCategoryName
:String
financialCategoryReducer
:String
financialCategoryType
:String
financialCategoryRate
:Number
bankMovementId
:Integer
Business Budget
Business Budget
Stream for managing business budget information.Fields:
id
:Integer
startDate
:Date
endDate
:Date
baseDate
:Date
description
:String
budgetType
:String
vision
:String
companyId
:Integer
companyName
:String
costCenterId
:Integer
costCenterName
:String
departmentId
:Integer
departmentName
:String
versionNumber
:Integer
versionDescription
:String
paymentCategories
:Array of Objects
id
:String
description
:String
type
:String
notes
:String
interval
:Array of Objects
monthYear
:String
totalPrice
:Number
Account Cost Center Balance
Account Cost Center Balance
Stream containing accounting balances for cost centers.Fields:
costCenterId
:Integer
companyId
:Integer
entryId
:Integer
batchId
:Integer
id
:Integer
accountId
:String
previousBalance
:Number
previousBalanceType
:String
debitBalance
:Number
creditBalance
:Number
balanceCarriedForward
:Number
balanceCarriedForwardType
:String
monthYear
:String
Invoice Items
Invoice Items
Stream with detailed information about invoice items.Fields:
entryExitType
:Integer
itemType
:String
entryExitDate
:Date
costCenterId
:Integer
documentNumber
:String
documenCode
:String
seriesType
:String
issueDate
:Date
participantCode
:Integer
participantName
:String
participantFederatedUnit
:String
participantStateRegistration
:String
participantCpfCnpj
:String
productCode
:Integer
productDescription
:String
unitOfMeasureSymbol
:String
ncm
:String
operationTaxCode
:String
productOriginCode
:String
quantity
:Number
unitPriceValue
:Number
freightValue
:Number
insuranceValue
:Number
ipiExpensesValue
:Number
ancillaryExpensesValue
:Number
discountValue
:Number
totalItemValue
:Number
pisTaxSituation
:String
pisCalculationBasis
:Number
pisRate
:Number
pisValue
:Number
cofinsTaxSituation
:String
cofinsCalculationBasis
:Number
cofinsRate
:Number
cofinsValue
:Number
icmsTaxSituation
:String
icmsCalculationBasis
:Number
icmsRate
:Number
icmsValue
:Number
icmsStCalculationBasis
:Number
icmsStRate
:Number
icmsStValue
:Number
icmsExoneratedValue
:Number
icmsExemptValue
:Number
icmsOtherValue
:Number
ipiTaxSituation
:String
ipiCalculationBasis
:Number
ipiRate
:Number
ipiValue
:Number
ipiExemptValue
:Number
ipiOtherValue
:Number
Defaulters Receivable Bills
Defaulters Receivable Bills
Stream for managing bills from defaulter customers.Fields:
companyId
:Integer
clientId
:Integer
clientName
:String
receivableBillId
:String
issueDate
:Date
documentNumber
:String
costCentersId
:Array of Integers
units
:String
receivableBillValue
:Number
defaulterInstallments
:Array of Objects
installmentId
:String
conditionType
:String
dueDate
:Date
daysOfDelay
:Integer
correctedValueWithoutAdditions
:Number
proRata
:Number
interest
:Number
fine
:Number
totalAdditions
:Number
correctedValueWithAdditions
:Number
installmentNumber
:String
installmentSentToSPCSerasa
:String
defaulterJudicialActivities
:Array of Objects
recordDate
:Date
situation
:String
concluded
:String
observation
:String
Bank Movement
Bank Movement
Stream containing bank movement and transaction data.Fields:
bankMovementId
:Integer
billId
:Integer
installmentId
:Integer
bankMovementAmount
:Number
documentIdentificationId
:String
documentIdentificationName
:String
documentIdentificationNumber
:String
bankMovementOriginId
:String
bankMovementHistoricId
:Integer
bankMovementHistoricName
:String
bankMovementOperationId
:Integer
bankMovementOperationName
:String
bankMovementOperationType
:String
bankMovementReconcile
:String
bankMovementDate
:Date
billDate
:Date
accountNumber
:String
companyId
:Integer
companyName
:String
groupCompanyId
:Integer
groupCompanyName
:String
holdingId
:Integer
holdingName
:String
subsidiaryId
:Integer
subsidiaryName
:String
creditorId
:Integer
creditorName
:String
clientId
:Integer
clientName
:String
financialCategories
:Array of Objects
companyId
:Integer
companyName
:String
costCenterId
:Integer
costCenterName
:String
financialCategoryId
:String
financialCategoryName
:String
financialCategoryReducer
:String
financialCategoryType
:String
financialCategoryRate
:Number
businessAreaId
:Integer
businessAreaName
:String
projectId
:Integer
projectName
:String
businessTypeId
:Integer
businessTypeName
:String
groupCompanyId
:Integer
groupCompanyName
:String
holdingId
:Integer
holdingName
:String
subsidiaryId
:Integer
subsidiaryName
:String
departamentCosts
:Array of Objects
id
:Integer
name
:String
rate
:Number
buldingCosts
:Array of Objects
buildingId
:Integer
buildingName
:String
buildingUnitId
:Integer
buildingUnitName
:String
costEstimationSheetId
:String
costEstimationSheetName
:String
rate
:Number
Customer Debt Balance
Customer Debt Balance
Stream for customer debt balance information.Fields:
billReceivableId
:Integer
company
:Object
id
:Integer
name
:String
costCenter
:Object
id
:Integer
name
:String
customer
:Object
id
:Integer
name
:String
document
:String
secondaryCustomers
:Array of Objects
id
:Integer
name
:String
document
:String
emissionDate
:Date
accountingDate
:Date
totalValue
:Number
lastRenegotiationDate
:Date
correctionDate
:Date
document
:String
cancellationDate
:Date
units
:Array of Objects
id
:Integer
number
:String
name
:String
installments
:Array of Objects
id
:Integer
paymentTerms
:Object
id
:String
descrition
:String
correctionBaseDate
:DateTime
originalValue
:Number
correctedValue
:Number
indexerName
:String
dueDate
:DateTime
accoutingReceiptDate
:DateTime
receiptDate
:DateTime
receiptBankAccount
:String
netReceivedAmount
:Number
penalty
:Number
interest
:Number
lateFee
:Number
currentBalance
:Number
updatedValue
:Number
additionsValue
:Number
contractualInterest
:Number
daysLate
:Integer
correctionDate
:Date
daysForPresentValueDiscount
:Integer
presentValueInterest
:Number
presentValue
:Number
discountedCommercialValue
:Number
interestBaseDate
:DateTime
installmentInterest
:Number
installmentNumber
:String
status
:String
Building Cost Estimation Items
Building Cost Estimation Items
Stream for items in building cost estimations.Fields:
buildingId
:Integer
buildingName
:String
buildingStatus
:String
projects
:Array of Objects
id
:Integer
name
:String
versionNumber
:Integer
buildingUnitId
:Integer
buildingUnitName
:String
id
:Integer
wbsCode
:String
workItemId
:Integer
description
:String
unitOfMeasure
:String
quantity
:Number
unitPrice
:Number
totalPrice
:Number
baseTotalPrice
:Number
scheduledPercentComplete
:Number
percentComplete
:Number
measuredQuantity
:Number
pricesByCategory
:Array of Objects
category
:String
unitPrice
:Number
totalPrice
:Number
baseTotalPrice
:Number
tasks
:Array of Objects
id
:Integer
presentationId
:Integer
description
:String
percentage
:Number
value
:Number
remainingDisbursments
:Number
disbursements
:Array of Objects
year
:Integer
month
:Integer
value
:Number
Account Company Balance
Account Company Balance
Stream containing accounting balances for companies.Fields:
companyId
:Integer
id
:Integer
accountId
:String
previousBalance
:Number
previousBalanceType
:String
debitBalance
:Number
creditBalance
:Number
balanceCarriedForward
:Number
balanceCarriedForwardType
:String
monthYear
:String
Outcome
Outcome
Stream containing outcome and payment information.Fields:
companyId
:Integer
companyName
:String
businessAreaId
:Integer
businessAreaName
:String
projectId
:Integer
projectName
:String
groupCompanyId
:Integer
groupCompanyName
:String
holdingId
:Integer
holdingName
:String
subsidiaryId
:Integer
subsidiaryName
:String
businessTypeId
:Integer
businessTypeName
:String
creditorId
:Integer
creditorName
:String
billId
:Integer
installmentId
:Integer
documentIdentificationId
:String
documentIdentificationName
:String
documentNumber
:String
forecastDocument
:String
consistencyStatus
:String
originId
:String
originalAmount
:Number
discountAmount
:Number
taxAmount
:Number
indexerId
:Integer
indexerName
:String
dueDate
:Date
issueDate
:Date
installmentBaseDate
:Date
balanceAmount
:Number
correctedBalanceAmount
:Number
authorizationStatus
:String
billDate
:Date
registeredUserId
:String
registeredBy
:String
registeredDate
:DateTime
paymentsCategories
:Array of Objects
costCenterId
:Integer
costCenterName
:String
projectId
:Integer
projectName
:String
financialCategoryId
:String
financialCategoryName
:String
financialCategoryReducer
:String
financialCategoryType
:String
financialCategoryRate
:Number
departamentsCosts
:Array of Objects
id
:Integer
name
:String
rate
:Number
buildingsCosts
:Array of Objects
buildingId
:Integer
buildingName
:String
buildingUnitId
:Integer
buildingUnitName
:String
costEstimationSheetId
:String
costEstimationSheetName
:String
rate
:Number
payments
:Array of Objects
operationTypeId
:Integer
operationTypeName
:String
grossAmount
:Number
monetaryCorrectionAmount
:Number
interestAmount
:Number
fineAmount
:Number
discountAmount
:Number
taxAmount
:Number
netAmount
:Number
calculationDate
:Date
paymentDate
:Date
sequencialNumber
:Integer
correctedNetAmount
:Number
paymentAuthentication
:String
bankMovements
:Array of Objects
accountCompanyId
:Integer
accountNumber
:String
accountType
:String
bankMovementDate
:Date
sequencialNumber
:Integer
id
:Integer
amount
:Number
historicId
:Integer
historicName
:String
operationId
:Integer
operationName
:String
operationType
:String
reconcile
:String
originId
:String
paymentCategories
:Array of Objects
costCenterId
:Integer
financialCategoryId
:String
financialCategoryName
:String
financialCategoryReducer
:String
financialCategoryType
:String
financialCategoryRate
:Number
bankMovementId
:Integer
authorizations
:Array of Objects
authorizationUserId
:String
authorizationUserName
:String
authorizationDate
:String
isLastToAuthorize
:String
Building Resources
Building Resources
Stream for managing building resources.Fields:
buildingResourceId
:Integer
buildingId
:Integer
buildingName
:String
description
:String
unitOfMeasure
:String
unitPrice
:Number
priceDate
:Date
priceCategory
:String
resourceCode
:String
category
:String
resourceGroup
:String
synonym
:String
financialCategory
:String
taxClassification
:String
productTax
:String
isActive
:Boolean
detailId
:Integer
detailDescription
:String
trademarkId
:Integer
trademarkDescription
:String
minimumStock
:Integer
maximumStock
:Integer
estimatedDeliveryTime
:Integer
hasServiceFeature
:Boolean
deliveryInterval
:Integer
installments
:Array of Objects
disbursementDays
:Integer
disbursementPercent
:Number
movementUnits
:Array of Objects
unitOfMeasureSymbol
:String
unitOfMeasureDescription
:String
conversionFactor
:Number
isDefault
:Boolean
isActive
:Boolean
notes
:Array of Objects
description
:String
buildingCostEstimationItems
:Array of Objects
buildingUnitId
:Integer
buildingUnitName
:String
wbsCode
:String
description
:String
sheetItemId
:Integer
totalPrice
:Number
quantity
:Number
disbursements
:Array of Objects
year
:Integer
month
:Integer
value
:Number
quantity
:Integer
remainingDisbursement
:Number
buildingAppropriations
:Object
pending
:Array of Objects
documentLabel
:String
date
:Date
costEstimationItemReference
:String
costEstimationItemDescription
:String
buildingUnitId
:Integer
buildingUnitName
:String
quantity
:Number
percentage
:Number
value
:Number
attended
:Array of Objects
documentLabel
:String
date
:Date
movementDate
:Date
costEstimationItemReference
:String
costEstimationItemDescription
:String
buildingUnitId
:Integer
buildingUnitName
:String
quantity
:Number
percentage
:Number
value
:Number
Customer Extract History
Customer Extract History
Stream for the history of customer extracts.Fields:
billReceivableId
:Integer
company
:Object
id
:Integer
name
:String
costCenter
:Object
id
:Integer
name
:String
customer
:Object
id
:Integer
name
:String
document
:String
emissionDate
:Date
lastRenegotiationDate
:Date
correctionDate
:Date
document
:String
privateArea
:Number
oldestInstallmentDate
:Date
revokedBillReceivableDate
:Date
units
:Array of Objects
id
:Integer
name
:String
installments
:Array of Objects
id
:Integer
annualCorrection
:Boolean
sentToScripturalCharge
:Boolean
paymentTerms
:Object
id
:String
descrition
:String
baseDate
:Date
originalValue
:Number
dueDate
:Date
indexerId
:Integer
calculationDate
:Date
currentBalance
:Number
currentBalanceWithAddition
:Number
generatedBillet
:Boolean
installmentSituation
:String
receipts
:Array of Objects
days
:Integer
date
:Date
value
:Number
extra
:Number
discount
:Number
netReceipt
:Number
type
:String
installmentNumber
:String
Purchase Quotations
Purchase Quotations
Stream for managing purchase quotations.Fields:
purchaseQuotationId
:Integer
registeredDate
:Date
lastModification
:Date
purchaseQuotationDate
:Date
sentDate
:Date
responseDeadline
:Date
notes
:String
minNumberOfSuppliers
:Integer
suggestedNumberOfSuppliers
:Integer
buyerId
:String
purchaseQuotationItems
:Array of Objects
purchaseQuotationItemId
:Integer
buildingId
:Integer
productId
:Integer
productDescription
:String
detailId
:Integer
detailDescription
:String
trademarkId
:Integer
trademarkDescription
:String
quantity
:Number
unitySimbol
:String
notes
:String
purchaseQuotationSuppliers
:Array of Objects
supplierId
:Integer
negotiations
:Array of Objects
negotiationId
:Integer
registeredDate
:Date
responseDate
:Date
expirationDate
:Date
sellersName
:String
totalValue
:Number
discount
:Number
freight
:Number
itemsFreight
:Number
negotiationItems
:Array of Objects
purchaseQuotationItemId
:Integer
productId
:Integer
productDescription
:String
detailId
:Integer
detailDescription
:String
trademarkId
:Integer
trademarkDescription
:String
quotedQuantity
:Number
negotiatedQuantity
:Number
unitPrice
:Number
discount
:Number
discountPercentage
:Number
increasePercentage
:Number
ipiTaxPercentage
:Number
issTaxPercentage
:Number
icmsTaxPercentage
:Number
freightUnitPrice
:Number
reference
:String
selectedOption
:Boolean