Empréstimos
- Empréstimos
- Políticas de crédito
- Esteira
- Produtos
- Ofertas
- Parcelas
Empresas
- Empresas
- Grupos de empresas
- Operadores
- Permissões
- Métodos de pagamento
Clientes
- Clientes
- Funcionários
Fundos
- Fundos
Eventos
- Eventos
- Assinaturas
- Webhooks externos
- Notificações
Cobrança
- Itens da fatura
- Intenções de pagamento
- Faturas
Arquivos
- Links de arquivos
- Arquivos
Configurações
- Temas
- Chaves da API
- Configurações
Entidades
- Entidade de dados
- Documentos
Automações
- Workflows
Modelos
- Modelos
- Settings
- ApiKeys
- ApiKey
- ApiKeyResponseCreate
- PaymentIntent
- PaymentIntents
- Company
- Companies
- CompanyGroup
- CompanyGroups
- CreditPolicy
- CreditPolicies
- CreditPolicyModelEmploymentLengthSalaryMultiplier
- Step
- Steps
- Loan
- Loans
- Offer
- Customer
- Customers
- Employment
- Employments
- Fund
- Funds
- Event
- Events
- ResendEvents
- PaymentMethod
- PaymentMethods
- Product
- Products
- ProductEligible
- ProductsEligibles
- Subscription
- Subscriptions
- Operator
- Operators
- Permission
- Permissions
- Installment
- Installments
- ExternalWebhooksQItech
- ExternalWebhooksKobana
- InvoiceItem
- InvoiceItems
- FileLink
- FileLinks
- File
- Invoice
- Invoices
- Themes
- DataEntity
- DataEntities
- Document
- Documents
- Workflows
- Workflow
- WorkflowExecution
- WorkflowExecutions
- WorkflowExecutionLog
- WorkflowExecutionLogs
- NotificationMessageAccepted
- WorkflowDefault
- WorkflowsDefault
- InvoicePayOff
- InvoiceCompanyRecurring
- InvoiceCustomerRecurring
- MethodData
- Address
- SettingsEmployments
- SettingsEmploymentsCompanies
- SettingsDomains
- SettingsPayments
- SettingsLoans
- SettingsLoansProducts
- SettingsProducts
- SettingsSteps
- SettingsDisbursements
- SettingsFlags
- SettingsFundFlags
- SettingsNotifications
- SettingsValidations
- SettingsRecaptcha
- SettingsQueues
- SettingsLocales
- SettingsInvoicesProducts
- SettingsInvoicesTenants
- SettingsInvoicesCompanies
- Deleted
- StepSignature
- CashoutTransfer
- CashoutBoleto
- CashoutInvoice
- CashoutLoan
- Transaction
- BankAccount
- PixKey
- PaymentMethodLink
- InstallmentTransaction
- Nationality
- State
- WorkflowsContent
- WorkflowsStatus
- WorkflowRunErrorNotAcceptable
- WorkflowTriggerScheduled
- WorkflowTriggerWebhookBase39
- BasicAuth
- SettingsCreate
- ApiKeyCreate
- CreditPolicyCreate
- InvoiceItemCreate
- PaymentIntentCreate
- PaymentIntentPay
- CompanyCreate
- OfferCreate
- LoanCreate
- CustomerCreate
- EmploymentCreate
- FundCreate
- ProductCreate
- SubscriptionCreate
- OperatorCreate
- PermissionCreate
- PaymentMethodsCreate
- InstallmentCreate
- CompanyGroupsCreate
- ExternalWebhooksQItechCreate
- ExternalWebhooksKobanaCreate
- ExternalWebhooksUnicoCreate
- FileLinkCreate
- InvoiceCreate
- ThemesCreate
- DataEntityCreate
- DocumentCreate
- WorkflowCreate
- WorkflowRun
- SendSMS
- SendEmail
- Error
- WorkflowError406
Modelos
Company
Este objeto representa uma empresa do seu negócio. Ele permite que você crie vínculos empregatícios e rastreie contratos que pertencem a mesma empresa.
{
"id": "comp_5f92f01728e009f403d8502e",
"status": "active",
"document": "12123123000112",
"name": "Big Corporation SA",
"friendlyName": "Big Corp",
"group": "cgrp_5f92f01728e009f403d8502e",
"address": {
"city": "São Paulo",
"state": "São Paulo",
"country": "BR",
"line1": "Av Paulista",
"line2": "Sala 404",
"number": "123",
"postalCode": "12123123",
"neighborhood": "Bela Vista"
},
"creditPolicies": [
{
"id": "cpol_63ss07b6c39f5d3d917009b631"
}
],
"settings": {
"steps": {
"title": "<string>",
"type": "signature",
"methodData": {
"schema": {
"type": "operator",
"role": "approver"
}
},
"needs": [
"<string>"
],
"slug": "<string>",
"hooks": {
"onFailure": [
"void_loan"
]
},
"onStart": [
"mark_loan_as_pending"
]
},
"loans": {
"concurrency": [
{
"quantityAllowed": 123,
"status": [
"open"
]
}
],
"conditions": [
{
"title": "<string>",
"content": "<string>"
}
]
},
"invoices": {
"payOff": {
"fine": {
"amount": 0.02,
"daysToStart": 1
},
"interest": {
"amount": 0.01,
"daysToStart": 1
},
"allowOverduePayment": true,
"daysUntilDue": {
"type": "absolute",
"amount": 1
},
"updateInvoiceItemOnInsert": true
},
"companyRecurring": {
"fine": {
"amount": 0.02,
"daysToStart": 1
},
"interest": {
"amount": 0.01,
"daysToStart": 1
},
"allowOverduePayment": true,
"daysUntilDue": {
"type": "static",
"amount": 10
},
"create": {
"cutoffDay": 25,
"autoCreate": true
},
"updateInvoiceItemOnInsert": false
}
},
"employments": {
"expireInDays": 30,
"canUpdateEmploymentData": true
}
},
"metadata": {},
"createdAt": "2023-08-25T22:38:41.134Z",
"updatedAt": "2023-08-25T22:38:41.134Z",
"deleted": false
}
Assistant
Responses are generated using AI and may contain mistakes.