
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 asMassivein the token configuration. You have to enable allMassiveendpoints. 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:IntegerenterpriseId:IntegerreceivableBillId:IntegerrefundBillId:IntegerproRataIndexer:Numbernumber:Stringsituation:StringexternalId:Stringnote:StringcancellationReason:StringinterestType:StringlateInterestCalculationType:StringfinancialInstitutionNumber:StringdiscountType:StringcorrectionType:StringanualCorrectionType:StringassociativeCredit:StringdiscountPercentage:Numbervalue:NumbertotalSellingValue:NumberinterestPercentage:NumberfineRate:NumberdailyLateInterestValue:NumbercreationDate:DateTimecontractDate:DateTimeissueDate:DateTimecancellationDate:DateTimefinancialInstitutionDate:DateTimecustomers:Array of Objectsid:Integermain:Booleanspouse:BooleanparticipationPercentage:NumberpersonType:Stringcpf:Stringname:Stringemail:StringbirthDate:DatemarriageDate:DatecivilStatus:StringfatherName:StringmotherName:Stringsex:Stringcnpj:Stringnationality:StringnumberIdentityCard:Stringprofession:StringcontactName:StringfantasyName:StringspouseData:Objectcpf:Stringname:Stringemail:Stringsex:StringcivilStatus:StringbirthDate:DatenumberIdentityCard:String
phones:Array of Objectstype:Stringnumber:Stringmain:Booleannote:Stringidd:String
addresses:Array of Objectstype:StringstreetName:Stringnumber:Stringcomplement:Stringneighborhood:StringcityId:Integercity:Stringstate:StringzipCode:Stringmail:Boolean
units:Array of Objectsid:Integermain:BooleanparticipationPercentage:Numbername:StringpropertyType:Stringnote:StringcommercialStock:StringlegalRegistrationNumber:StringdeliveryDate:DateTimeprivateArea:NumbercommonArea:NumberterrainArea:NumberidealFraction:NumberidealFractionSquareMeter:NumberindexedQuantity:NumberchildUnits:Array of Objectsname:Stringorder:StringprivateArea:NumbercommonArea:NumberidealFraction:NumberidealFractionSquareMeter:NumberlocationName:Stringnote:String
groupings:Array of ObjectsgroupingDescription:StringvalueGroupingDescription:String
paymentConditions:Array of ObjectsconditionTypeId:StringconditionTypeName:StringbearerId:StringbearerName:StringinstallmentsNumber:IntegertotalValue:NumberfirstPayment:String
brokers:Array of Objectsid:Integername:Stringmain:Boolean
Income
Income
Stream containing income and receipt information.Fields:
companyId:IntegercompanyName:StringbusinessAreaId:IntegerbusinessAreaName:StringprojectId:IntegerprojectName:StringgroupCompanyId:IntegergroupCompanyName:StringholdingId:IntegerholdingName:StringsubsidiaryId:IntegersubsidiaryName:StringbusinessTypeId:IntegerbusinessTypeName:StringclientId:IntegerclientName:StringbillId:IntegerinstallmentId:IntegerdocumentIdentificationId:StringdocumentIdentificationName:StringdocumentNumber:StringdocumentForecast:StringoriginId:StringoriginalAmount:NumberdiscountAmount:NumbertaxAmount:NumberindexerId:IntegerindexerName:StringdueDate:DateissueDate:DatebillDate:DateinstallmentBaseDate:DatebalanceAmount:NumbercorrectedBalanceAmount:NumberperiodicityType:StringembeddedInterestAmount:NumberinterestType:StringinterestRate:NumbercorrectionType:StringinterestBaseDate:StringdefaulterSituation:StringsubJudicie:StringmainUnit:StringinstallmentNumber:StringbearerId:IntegerpaymentTerm:Objectid:Stringdescription:Stringdescrition:String
receiptsCategories:Array of ObjectsbusinessTypeId:IntegerbusinessTypeName:StringbusinessAreaId:IntegerbusinessAreaName:StringcostCenterId:IntegercostCenterName:StringfinancialCategoryId:StringfinancialCategoryName:StringfinancialCategoryReducer:StringfinancialCategoryType:StringfinancialCategoryRate:NumberprojectId:IntegerprojectName:String
receipts:Array of ObjectsoperationTypeId:IntegeroperationTypeName:StringgrossAmount:NumbermonetaryCorrectionAmount:NumberinterestAmount:NumberfineAmount:NumberdiscountAmount:NumbertaxAmount:NumbernetAmount:NumberadditionAmount:NumberinsuranceAmount:NumberdueAdmAmount:NumbercalculationDate:DatepaymentDate:DateaccountCompanyId:IntegeraccountNumber:StringaccountType:StringsequencialNumber:IntegerindexerId:IntegerembeddedInterestAmount:NumberproRata:NumberbankMovements:Array of ObjectsbankMovementDate:DatesequencialNumber:Integerid:Integeramount:NumberhistoricId:IntegerhistoricName:StringoperationId:IntegeroperationName:StringoperationType:Stringreconcile:StringcorrectedAmount:NumberoriginId:StringfinancialCategories:Array of ObjectsprojectId:IntegerprojectName:StringbusinessTypeId:IntegerbusinessTypeName:StringbusinessAreaId:IntegerbusinessAreaName:StringcostCenterId:IntegercostCenterName:StringfinancialCategoryId:StringfinancialCategoryName:StringfinancialCategoryReducer:StringfinancialCategoryType:StringfinancialCategoryRate:NumberbankMovementId:Integer
Business Budget
Business Budget
Stream for managing business budget information.Fields:
id:IntegerstartDate:DateendDate:DatebaseDate:Datedescription:StringbudgetType:Stringvision:StringcompanyId:IntegercompanyName:StringcostCenterId:IntegercostCenterName:StringdepartmentId:IntegerdepartmentName:StringversionNumber:IntegerversionDescription:StringpaymentCategories:Array of Objectsid:Stringdescription:Stringtype:Stringnotes:Stringinterval:Array of ObjectsmonthYear:StringtotalPrice:Number
Account Cost Center Balance
Account Cost Center Balance
Stream containing accounting balances for cost centers.Fields:
costCenterId:IntegercompanyId:IntegerentryId:IntegerbatchId:Integerid:IntegeraccountId:StringpreviousBalance:NumberpreviousBalanceType:StringdebitBalance:NumbercreditBalance:NumberbalanceCarriedForward:NumberbalanceCarriedForwardType:StringmonthYear:String
Invoice Items
Invoice Items
Stream with detailed information about invoice items.Fields:
entryExitType:IntegeritemType:StringentryExitDate:DatecostCenterId:IntegerdocumentNumber:StringdocumenCode:StringseriesType:StringissueDate:DateparticipantCode:IntegerparticipantName:StringparticipantFederatedUnit:StringparticipantStateRegistration:StringparticipantCpfCnpj:StringproductCode:IntegerproductDescription:StringunitOfMeasureSymbol:Stringncm:StringoperationTaxCode:StringproductOriginCode:Stringquantity:NumberunitPriceValue:NumberfreightValue:NumberinsuranceValue:NumberipiExpensesValue:NumberancillaryExpensesValue:NumberdiscountValue:NumbertotalItemValue:NumberpisTaxSituation:StringpisCalculationBasis:NumberpisRate:NumberpisValue:NumbercofinsTaxSituation:StringcofinsCalculationBasis:NumbercofinsRate:NumbercofinsValue:NumbericmsTaxSituation:StringicmsCalculationBasis:NumbericmsRate:NumbericmsValue:NumbericmsStCalculationBasis:NumbericmsStRate:NumbericmsStValue:NumbericmsExoneratedValue:NumbericmsExemptValue:NumbericmsOtherValue:NumberipiTaxSituation:StringipiCalculationBasis:NumberipiRate:NumberipiValue:NumberipiExemptValue:NumberipiOtherValue:Number
Defaulters Receivable Bills
Defaulters Receivable Bills
Stream for managing bills from defaulter customers.Fields:
companyId:IntegerclientId:IntegerclientName:StringreceivableBillId:StringissueDate:DatedocumentNumber:StringcostCentersId:Array of Integersunits:StringreceivableBillValue:NumberdefaulterInstallments:Array of ObjectsinstallmentId:StringconditionType:StringdueDate:DatedaysOfDelay:IntegercorrectedValueWithoutAdditions:NumberproRata:Numberinterest:Numberfine:NumbertotalAdditions:NumbercorrectedValueWithAdditions:NumberinstallmentNumber:StringinstallmentSentToSPCSerasa:String
defaulterJudicialActivities:Array of ObjectsrecordDate:Datesituation:Stringconcluded:Stringobservation:String
Bank Movement
Bank Movement
Stream containing bank movement and transaction data.Fields:
bankMovementId:IntegerbillId:IntegerinstallmentId:IntegerbankMovementAmount:NumberdocumentIdentificationId:StringdocumentIdentificationName:StringdocumentIdentificationNumber:StringbankMovementOriginId:StringbankMovementHistoricId:IntegerbankMovementHistoricName:StringbankMovementOperationId:IntegerbankMovementOperationName:StringbankMovementOperationType:StringbankMovementReconcile:StringbankMovementDate:DatebillDate:DateaccountNumber:StringcompanyId:IntegercompanyName:StringgroupCompanyId:IntegergroupCompanyName:StringholdingId:IntegerholdingName:StringsubsidiaryId:IntegersubsidiaryName:StringcreditorId:IntegercreditorName:StringclientId:IntegerclientName:StringfinancialCategories:Array of ObjectscompanyId:IntegercompanyName:StringcostCenterId:IntegercostCenterName:StringfinancialCategoryId:StringfinancialCategoryName:StringfinancialCategoryReducer:StringfinancialCategoryType:StringfinancialCategoryRate:NumberbusinessAreaId:IntegerbusinessAreaName:StringprojectId:IntegerprojectName:StringbusinessTypeId:IntegerbusinessTypeName:StringgroupCompanyId:IntegergroupCompanyName:StringholdingId:IntegerholdingName:StringsubsidiaryId:IntegersubsidiaryName:String
departamentCosts:Array of Objectsid:Integername:Stringrate:Number
buldingCosts:Array of ObjectsbuildingId:IntegerbuildingName:StringbuildingUnitId:IntegerbuildingUnitName:StringcostEstimationSheetId:StringcostEstimationSheetName:Stringrate:Number
Customer Debt Balance
Customer Debt Balance
Stream for customer debt balance information.Fields:
billReceivableId:Integercompany:Objectid:Integername:String
costCenter:Objectid:Integername:String
customer:Objectid:Integername:Stringdocument:String
secondaryCustomers:Array of Objectsid:Integername:Stringdocument:String
emissionDate:DateaccountingDate:DatetotalValue:NumberlastRenegotiationDate:DatecorrectionDate:Datedocument:StringcancellationDate:Dateunits:Array of Objectsid:Integernumber:Stringname:String
installments:Array of Objectsid:IntegerpaymentTerms:Objectid:Stringdescrition:String
correctionBaseDate:DateTimeoriginalValue:NumbercorrectedValue:NumberindexerName:StringdueDate:DateTimeaccoutingReceiptDate:DateTimereceiptDate:DateTimereceiptBankAccount:StringnetReceivedAmount:Numberpenalty:Numberinterest:NumberlateFee:NumbercurrentBalance:NumberupdatedValue:NumberadditionsValue:NumbercontractualInterest:NumberdaysLate:IntegercorrectionDate:DatedaysForPresentValueDiscount:IntegerpresentValueInterest:NumberpresentValue:NumberdiscountedCommercialValue:NumberinterestBaseDate:DateTimeinstallmentInterest:NumberinstallmentNumber:Stringstatus:String
Building Cost Estimation Items
Building Cost Estimation Items
Stream for items in building cost estimations.Fields:
buildingId:IntegerbuildingName:StringbuildingStatus:Stringprojects:Array of Objectsid:Integername:String
versionNumber:IntegerbuildingUnitId:IntegerbuildingUnitName:Stringid:IntegerwbsCode:StringworkItemId:Integerdescription:StringunitOfMeasure:Stringquantity:NumberunitPrice:NumbertotalPrice:NumberbaseTotalPrice:NumberscheduledPercentComplete:NumberpercentComplete:NumbermeasuredQuantity:NumberpricesByCategory:Array of Objectscategory:StringunitPrice:NumbertotalPrice:NumberbaseTotalPrice:Number
tasks:Array of Objectsid:IntegerpresentationId:Integerdescription:Stringpercentage:Numbervalue:NumberremainingDisbursments:Numberdisbursements:Array of Objectsyear:Integermonth:Integervalue:Number
Account Company Balance
Account Company Balance
Stream containing accounting balances for companies.Fields:
companyId:Integerid:IntegeraccountId:StringpreviousBalance:NumberpreviousBalanceType:StringdebitBalance:NumbercreditBalance:NumberbalanceCarriedForward:NumberbalanceCarriedForwardType:StringmonthYear:String
Outcome
Outcome
Stream containing outcome and payment information.Fields:
companyId:IntegercompanyName:StringbusinessAreaId:IntegerbusinessAreaName:StringprojectId:IntegerprojectName:StringgroupCompanyId:IntegergroupCompanyName:StringholdingId:IntegerholdingName:StringsubsidiaryId:IntegersubsidiaryName:StringbusinessTypeId:IntegerbusinessTypeName:StringcreditorId:IntegercreditorName:StringbillId:IntegerinstallmentId:IntegerdocumentIdentificationId:StringdocumentIdentificationName:StringdocumentNumber:StringforecastDocument:StringconsistencyStatus:StringoriginId:StringoriginalAmount:NumberdiscountAmount:NumbertaxAmount:NumberindexerId:IntegerindexerName:StringdueDate:DateissueDate:DateinstallmentBaseDate:DatebalanceAmount:NumbercorrectedBalanceAmount:NumberauthorizationStatus:StringbillDate:DateregisteredUserId:StringregisteredBy:StringregisteredDate:DateTimepaymentsCategories:Array of ObjectscostCenterId:IntegercostCenterName:StringprojectId:IntegerprojectName:StringfinancialCategoryId:StringfinancialCategoryName:StringfinancialCategoryReducer:StringfinancialCategoryType:StringfinancialCategoryRate:Number
departamentsCosts:Array of Objectsid:Integername:Stringrate:Number
buildingsCosts:Array of ObjectsbuildingId:IntegerbuildingName:StringbuildingUnitId:IntegerbuildingUnitName:StringcostEstimationSheetId:StringcostEstimationSheetName:Stringrate:Number
payments:Array of ObjectsoperationTypeId:IntegeroperationTypeName:StringgrossAmount:NumbermonetaryCorrectionAmount:NumberinterestAmount:NumberfineAmount:NumberdiscountAmount:NumbertaxAmount:NumbernetAmount:NumbercalculationDate:DatepaymentDate:DatesequencialNumber:IntegercorrectedNetAmount:NumberpaymentAuthentication:StringbankMovements:Array of ObjectsaccountCompanyId:IntegeraccountNumber:StringaccountType:StringbankMovementDate:DatesequencialNumber:Integerid:Integeramount:NumberhistoricId:IntegerhistoricName:StringoperationId:IntegeroperationName:StringoperationType:Stringreconcile:StringoriginId:StringpaymentCategories:Array of ObjectscostCenterId:IntegerfinancialCategoryId:StringfinancialCategoryName:StringfinancialCategoryReducer:StringfinancialCategoryType:StringfinancialCategoryRate:NumberbankMovementId:Integer
authorizations:Array of ObjectsauthorizationUserId:StringauthorizationUserName:StringauthorizationDate:StringisLastToAuthorize:String
Building Resources
Building Resources
Stream for managing building resources.Fields:
buildingResourceId:IntegerbuildingId:IntegerbuildingName:Stringdescription:StringunitOfMeasure:StringunitPrice:NumberpriceDate:DatepriceCategory:StringresourceCode:Stringcategory:StringresourceGroup:Stringsynonym:StringfinancialCategory:StringtaxClassification:StringproductTax:StringisActive:BooleandetailId:IntegerdetailDescription:StringtrademarkId:IntegertrademarkDescription:StringminimumStock:IntegermaximumStock:IntegerestimatedDeliveryTime:IntegerhasServiceFeature:BooleandeliveryInterval:Integerinstallments:Array of ObjectsdisbursementDays:IntegerdisbursementPercent:Number
movementUnits:Array of ObjectsunitOfMeasureSymbol:StringunitOfMeasureDescription:StringconversionFactor:NumberisDefault:BooleanisActive:Boolean
notes:Array of Objectsdescription:String
buildingCostEstimationItems:Array of ObjectsbuildingUnitId:IntegerbuildingUnitName:StringwbsCode:Stringdescription:StringsheetItemId:IntegertotalPrice:Numberquantity:Number
disbursements:Array of Objectsyear:Integermonth:Integervalue:Numberquantity:Integer
remainingDisbursement:NumberbuildingAppropriations:Objectpending:Array of ObjectsdocumentLabel:Stringdate:DatecostEstimationItemReference:StringcostEstimationItemDescription:StringbuildingUnitId:IntegerbuildingUnitName:Stringquantity:Numberpercentage:Numbervalue:Number
attended:Array of ObjectsdocumentLabel:Stringdate:DatemovementDate:DatecostEstimationItemReference:StringcostEstimationItemDescription:StringbuildingUnitId:IntegerbuildingUnitName:Stringquantity:Numberpercentage:Numbervalue:Number
Customer Extract History
Customer Extract History
Stream for the history of customer extracts.Fields:
billReceivableId:Integercompany:Objectid:Integername:String
costCenter:Objectid:Integername:String
customer:Objectid:Integername:Stringdocument:String
emissionDate:DatelastRenegotiationDate:DatecorrectionDate:Datedocument:StringprivateArea:NumberoldestInstallmentDate:DaterevokedBillReceivableDate:Dateunits:Array of Objectsid:Integername:String
installments:Array of Objectsid:IntegerannualCorrection:BooleansentToScripturalCharge:BooleanpaymentTerms:Objectid:Stringdescrition:String
baseDate:DateoriginalValue:NumberdueDate:DateindexerId:IntegercalculationDate:DatecurrentBalance:NumbercurrentBalanceWithAddition:NumbergeneratedBillet:BooleaninstallmentSituation:Stringreceipts:Array of Objectsdays:Integerdate:Datevalue:Numberextra:Numberdiscount:NumbernetReceipt:Numbertype:String
installmentNumber:String
Purchase Quotations
Purchase Quotations
Stream for managing purchase quotations.Fields:
purchaseQuotationId:IntegerregisteredDate:DatelastModification:DatepurchaseQuotationDate:DatesentDate:DateresponseDeadline:Datenotes:StringminNumberOfSuppliers:IntegersuggestedNumberOfSuppliers:IntegerbuyerId:StringpurchaseQuotationItems:Array of ObjectspurchaseQuotationItemId:IntegerbuildingId:IntegerproductId:IntegerproductDescription:StringdetailId:IntegerdetailDescription:StringtrademarkId:IntegertrademarkDescription:Stringquantity:NumberunitySimbol:Stringnotes:String
purchaseQuotationSuppliers:Array of ObjectssupplierId:Integernegotiations:Array of ObjectsnegotiationId:IntegerregisteredDate:DateresponseDate:DateexpirationDate:DatesellersName:StringtotalValue:Numberdiscount:Numberfreight:NumberitemsFreight:NumbernegotiationItems:Array of ObjectspurchaseQuotationItemId:IntegerproductId:IntegerproductDescription:StringdetailId:IntegerdetailDescription:StringtrademarkId:IntegertrademarkDescription:StringquotedQuantity:NumbernegotiatedQuantity:NumberunitPrice:Numberdiscount:NumberdiscountPercentage:NumberincreasePercentage:NumberipiTaxPercentage:NumberissTaxPercentage:NumbericmsTaxPercentage:NumberfreightUnitPrice:Numberreference:StringselectedOption:Boolean