{"openapi":"3.0.0","paths":{"/gowa/send-message":{"post":{"operationId":"GowaController_sendMessage","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GowaSendMessageDto"}}}},"responses":{"201":{"description":""}}}},"/gowa/message/queue":{"post":{"operationId":"GowaController_sendMessageQueue","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"201":{"description":""}}}},"/gowa/check-connection":{"post":{"operationId":"GowaController_checkConnection","parameters":[],"responses":{"201":{"description":""}}}},"/gowa/fire-lambda":{"post":{"operationId":"GowaController_fireLambdaToSend","parameters":[],"responses":{"201":{"description":""}}}},"/gowa/remove-all-messages-from-redis":{"post":{"operationId":"GowaController_removeAllMessages","parameters":[],"responses":{"201":{"description":""}}}},"/gowa/init-instance/{business_id}":{"post":{"operationId":"GowaController_initGowaInstance","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/gowa/subscribe-messages-update-webhook":{"post":{"operationId":"GowaController_subscribeMessagesUpdateWebhook","parameters":[],"responses":{"201":{"description":""}}}},"/wasender/delete/{business_id}":{"delete":{"operationId":"WasenderController_deleteSession","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/wasender/init-session/{business_id}":{"post":{"operationId":"WasenderController_initSession","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitWasenderSessionDto"}}}},"responses":{"200":{"description":""}}}},"/wasender/connect/{business_id}":{"post":{"operationId":"WasenderController_connectSession","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitWasenderSessionDto"}}}},"responses":{"200":{"description":""}}}},"/wasender/qrcode/{business_id}":{"get":{"operationId":"WasenderController_getQrCode","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/wasender/status/{business_id}":{"get":{"operationId":"WasenderController_getStatus","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/wasender/update-session-phone/{business_id}":{"post":{"operationId":"WasenderController_updateSessionPhone","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWasenderSessionPhoneDto"}}}},"responses":{"200":{"description":""}}}},"/wasender/send-message":{"post":{"operationId":"WasenderController_sendMessage","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WasenderSendMessageDto"}}}},"responses":{"201":{"description":""}}}},"/wasender/webhook":{"post":{"operationId":"WasenderController_webhook","parameters":[{"name":"x-webhook-signature","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/wasender/cron/reconcile-message-statuses":{"post":{"operationId":"WasenderController_reconcileMessageStatuses","parameters":[],"responses":{"200":{"description":""}}}},"/digital-account-fees/{uuid}/set-fees-v2":{"post":{"operationId":"DigitalAccountFeesController_setFeesV2","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeesV2Dto"}}}},"responses":{"201":{"description":""}}}},"/digital-account-fees/update-fees":{"post":{"operationId":"DigitalAccountFeesController_updateFees","parameters":[],"responses":{"201":{"description":""}}}},"/digital-account-fees/sync-fees":{"post":{"operationId":"DigitalAccountFeesController_syncFees","parameters":[],"responses":{"201":{"description":""}}}},"/digital-account-tracking/list":{"get":{"operationId":"DigitalAccountTrackingController_getAccounts","parameters":[],"responses":{"200":{"description":""}}}},"/webhooks/qitech/analysis":{"post":{"operationId":"QitechWebhookAnalysisController_handleAnalysisWebhook","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QitechAnalysisWebhookDto"}}}},"responses":{"200":{"description":""}}}},"/new-digital-accounts/check/risk-analysys/{cnpj}":{"post":{"operationId":"NewDigitalAccountsController_requestRiskAnalysis","parameters":[{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/new-digital-accounts/faceid/{cpf}":{"post":{"operationId":"NewDigitalAccountsController_faceIdDigitalAccountToQiTech","parameters":[{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaceDataDto"}}}},"responses":{"201":{"description":""}}}},"/new-digital-accounts/documents/upload/{companyUuid}":{"post":{"operationId":"NewDigitalAccountsController_uploadDocument","parameters":[{"name":"companyUuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/new-digital-accounts/company-details/save":{"post":{"operationId":"NewDigitalAccountsController_storeCompanyDetails","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQITechCompanyDto"}}}},"responses":{"201":{"description":""}}}},"/new-digital-accounts/generate/link/{cpf}/{cnpj}":{"get":{"operationId":"NewDigitalAccountsController_generateLinkToFaceScan","parameters":[{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}},{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/new-digital-accounts/check/has-sessionid/{cpf}/{cnpj}":{"get":{"operationId":"NewDigitalAccountsController_hasScanned","parameters":[{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}},{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/new-digital-accounts/check/business/{businessId}":{"post":{"operationId":"NewDigitalAccountsController_hasCompany","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/new-digital-accounts/business/{businessId}/{cpf}":{"patch":{"operationId":"NewDigitalAccountsController_updateCompanyAccountwithPartner","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanyDto"}}}},"responses":{"200":{"description":""}}}},"/new-digital-accounts/company/rep/{cnpj}":{"get":{"operationId":"NewDigitalAccountsController_companyAndPartner","parameters":[{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/new-digital-accounts/companies/rep":{"get":{"operationId":"NewDigitalAccountsController_allCompaniesAndPartner","parameters":[],"responses":{"200":{"description":""}}}},"/new-digital-accounts/company/status/{cnpj}":{"get":{"operationId":"NewDigitalAccountsController_companystatus","parameters":[{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/new-digital-accounts/document/{cnpj}/{document_key}":{"get":{"operationId":"NewDigitalAccountsController_tempQiTechDocument","parameters":[{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}},{"name":"document_key","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/mail/send":{"post":{"operationId":"MailController_send","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMailDto"}}}},"responses":{"201":{"description":""}}}},"/mail/queue":{"post":{"operationId":"MailController_sendQueue","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"201":{"description":""}}}},"/qa/generating-missing-reminders":{"get":{"operationId":"QaTestsController_getMissingReminders","parameters":[],"responses":{"200":{"description":""}}}},"/missing-lifecycles":{"post":{"operationId":"QaTestsController_getMissingLifecycles","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingLifecyclesDto"}}}},"responses":{"201":{"description":""}}}},"/duplicated-lifecycles":{"get":{"operationId":"QaTestsController_getDuplicatedLifecycles","parameters":[],"responses":{"200":{"description":""}}}},"/debt-reminders-missing":{"post":{"operationId":"QaTestsController_getDebtRemindersMissing","parameters":[],"responses":{"201":{"description":""}}}},"/individual-reminders-missing":{"post":{"operationId":"QaTestsController_getIndividualRemindersMissing","parameters":[],"responses":{"201":{"description":""}}}},"/sync-omie-invoice-statuses":{"post":{"operationId":"QaTestsController_syncOmieInvoiceStatuses","parameters":[],"responses":{"201":{"description":""}}}},"/omie/get-all-bank-accounts/{business_id}":{"get":{"operationId":"QaTestsController_getAllBankAccounts","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/sanitize-business-clients":{"post":{"operationId":"QaTestsController_sanitizeClients","parameters":[],"responses":{"201":{"description":""}}}},"/check-business-clients":{"post":{"operationId":"QaTestsController_checkClients","parameters":[],"responses":{"201":{"description":""}}}},"/sending-summary":{"post":{"operationId":"QaTestsController_getSendingSummaty","parameters":[],"responses":{"201":{"description":""}}}},"/contracts":{"get":{"operationId":"ContractsController_getAll","parameters":[{"name":"business_id","required":false,"in":"query","description":"Filter receivables by business ID.","schema":{"type":"string"}},{"name":"client_id","required":false,"in":"query","description":"Filter receivables by client ID.","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"order_by","required":false,"in":"query","description":"Field name to order the results by, e.g., \"due_date\". Defaults to descending \"issued_date\" if not provided.","schema":{"type":"string"}},{"name":"sort_order","required":false,"in":"query","description":"Sort order, can be either \"asc\" for ascending or \"desc\" for descending. Defaults to \"desc\" if not provided.","schema":{"enum":["asc","desc"],"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status. Valid values are defined by the ContractStatus enum.","schema":{"enum":["ACTIVE","INACTIVE","COMPLETED","DELETED","SUSPENDED"],"type":"string"}},{"name":"with_client","required":false,"in":"query","description":"Boolean flag to include client details associated with this contract. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_receivables","required":false,"in":"query","description":"Boolean flag to include receivables details associated with this contract. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"date_type","required":false,"in":"query","description":"Type of date to filter by. Valid values are \"issue\" (first_bill_date), \"billing\" (next due date), or \"termination\" (end date).","schema":{"enum":["issue","billing","termination"],"type":"string"}},{"name":"date_filter","required":false,"in":"query","description":"Date period filter. Valid values are \"today\", \"this week\", \"this month\", \"this year\", \"custom\", \"indeterminate\", or \"all\".","schema":{"enum":["today","this week","this month","this year","custom","indeterminate","all"],"type":"string"}},{"name":"date_from","required":false,"in":"query","description":"Start date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is \"custom\".","schema":{"type":"string"}},{"name":"date_to","required":false,"in":"query","description":"End date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is \"custom\".","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the list of contracts based on the specified criteria."},"403":{"description":"Forbidden - User not authorized."},"500":{"description":"Internal Server Error."}},"tags":["Contracts"],"security":[{"access-token":[]}]},"post":{"operationId":"ContractsController_addContractBoletoAndLifeCycle","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContractDto"}}}},"responses":{"201":{"description":""}},"tags":["Contracts"]}},"/contracts/client":{"get":{"operationId":"ContractsController_getContractsClientFormat","parameters":[{"name":"business_id","required":false,"in":"query","description":"Filter receivables by business ID.","schema":{"type":"string"}},{"name":"client_id","required":false,"in":"query","description":"Filter receivables by client ID.","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"order_by","required":false,"in":"query","description":"Field name to order the results by, e.g., \"due_date\". Defaults to descending \"issued_date\" if not provided.","schema":{"type":"string"}},{"name":"sort_order","required":false,"in":"query","description":"Sort order, can be either \"asc\" for ascending or \"desc\" for descending. Defaults to \"desc\" if not provided.","schema":{"enum":["asc","desc"],"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status. Valid values are defined by the ContractStatus enum.","schema":{"enum":["ACTIVE","INACTIVE","COMPLETED","DELETED","SUSPENDED"],"type":"string"}},{"name":"with_client","required":false,"in":"query","description":"Boolean flag to include client details associated with this contract. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_receivables","required":false,"in":"query","description":"Boolean flag to include receivables details associated with this contract. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"date_type","required":false,"in":"query","description":"Type of date to filter by. Valid values are \"issue\" (first_bill_date), \"billing\" (next due date), or \"termination\" (end date).","schema":{"enum":["issue","billing","termination"],"type":"string"}},{"name":"date_filter","required":false,"in":"query","description":"Date period filter. Valid values are \"today\", \"this week\", \"this month\", \"this year\", \"custom\", \"indeterminate\", or \"all\".","schema":{"enum":["today","this week","this month","this year","custom","indeterminate","all"],"type":"string"}},{"name":"date_from","required":false,"in":"query","description":"Start date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is \"custom\".","schema":{"type":"string"}},{"name":"date_to","required":false,"in":"query","description":"End date for custom date range filter. Format: dd/mm/yyyy. Required when date_filter is \"custom\".","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Contracts"]}},"/contracts/{uuid}":{"get":{"operationId":"ContractsController_getSingleContract","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the contract to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the specific contract."},"403":{"description":"Forbidden - User not authorized."},"404":{"description":"Contract not found."},"500":{"description":"Internal Server Error."}},"tags":["Contracts"],"security":[{"access-token":[]}]},"put":{"operationId":"ContractsController_updateContract","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the contract to update the status.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContractDto"}}}},"responses":{"200":{"description":"Successfully updated the status of the contract."},"401":{"description":"Unauthorized - User not authorized to update the status of this contract."},"404":{"description":"Contract not found."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/{uuid}/status":{"patch":{"operationId":"ContractsController_updateContractStatus","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the contract to update the status.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContractStatusDto"}}}},"responses":{"200":{"description":"Successfully updated the status of the contract."},"401":{"description":"Unauthorized - User not authorized to update the status of this contract."},"404":{"description":"Contract not found."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/{uuid}/adjustment":{"patch":{"operationId":"ContractsController_updateContractAdjustment","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdjustmentDto"}}}},"responses":{"200":{"description":"Successfully updated contract adjustment configuration."},"403":{"description":"Forbidden - User not authorized."},"404":{"description":"Contract not found."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/bulk-adjustment":{"patch":{"operationId":"ContractsController_bulkUpdateContractAdjustments","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAdjustmentContractDto"}}}},"responses":{"200":{"description":"Successfully updated adjustment configuration for multiple contracts."},"401":{"description":"Unauthorized - User not authorized to update contracts."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/bulk-edit":{"post":{"operationId":"ContractsController_bulkEditContracts","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditContractsDto"}}}},"responses":{"200":{"description":"Successfully edited multiple contracts and their receivables in bulk.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditContractsResponseDto"}}}},"401":{"description":"Unauthorized - User not authorized to edit contracts."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/bulk-delete":{"post":{"operationId":"ContractsController_bulkDeleteContracts","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteContractsDto"}}}},"responses":{"200":{"description":"Successfully deleted the contracts in bulk."},"401":{"description":"Unauthorized - User not authorized to delete contracts."},"404":{"description":"No valid contracts found for deletion."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/{uuid}/receivables/bulk-edit":{"patch":{"operationId":"ContractsController_bulkEditReceivables","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the contract.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditReceivablesDto"}}}},"responses":{"200":{"description":"Successfully updated receivables in bulk."},"401":{"description":"Unauthorized - User not authorized to edit receivables."},"404":{"description":"Contract not found."},"500":{"description":"Internal server error."}},"tags":["Contracts"],"security":[{"access-token":[]}]}},"/contracts/{business_id}/add-batch-contract":{"post":{"operationId":"ContractsController_addBatchContract","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["Contracts"]}},"/receivables":{"get":{"operationId":"ReceivablesController_getAll","parameters":[{"name":"business_id","required":false,"in":"query","description":"Filter receivables by business ID.","schema":{"type":"string"}},{"name":"client_id","required":false,"in":"query","description":"Filter receivables by client ID.","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"order_by","required":false,"in":"query","description":"Field name to order the results by, e.g., \"issued_date\". Defaults to descending \"issued_date\" if not provided.","schema":{"type":"string"}},{"name":"sort_order","required":false,"in":"query","description":"Sort order, can be either \"asc\" for ascending or \"desc\" for descending. Defaults to \"desc\" if not provided.","schema":{"enum":["asc","desc"],"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status. Valid values are defined by the account_receivables_status enum.","schema":{"enum":["Paid","Cancelled","Ongoing","On_hold","Bad_Debt"],"type":"string"}},{"name":"with_business","required":false,"in":"query","description":"Boolean flag to include business details associated with this invoice. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_client","required":false,"in":"query","description":"Boolean flag to include client details associated with this invoice. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_bankslip","required":false,"in":"query","description":"Boolean flag to include all bankslip details associated with this invoice. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_nfse","required":false,"in":"query","description":"Boolean flag to include all NFSe details associated with this invoice. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_partial_payments","required":false,"in":"query","description":"Boolean flag to include all the partial payment associated for this invoice. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"nfse_status","required":false,"in":"query","description":"Filter receivables by NFSe status.","schema":{"type":"string"}},{"name":"nfse_without","required":false,"in":"query","description":"Boolean flag to exclude receivables that have NFSe associated. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved the list of receivables based on the specified criteria."},"403":{"description":"Forbidden - User not authorized."},"500":{"description":"Internal Server Error."}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/{uuid}":{"get":{"operationId":"ReceivablesController_getSingleReceivable","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the receivable to retrieve.","schema":{"type":"string"}},{"name":"with_business","required":false,"in":"query","description":"Boolean flag to include business details associated with this receivable. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_client","required":false,"in":"query","description":"Boolean flag to include client details associated with this receivable. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}},{"name":"with_bankslip","required":false,"in":"query","description":"Boolean flag to include all bankslip details associated with this receivable. Valid values are \"true\" or \"false\".","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved the specific receivable."},"403":{"description":"Forbidden - User not authorized."},"404":{"description":"Receivable not found."},"500":{"description":"Internal Server Error."}},"tags":["Receivables"],"security":[{"access-token":[]}]},"patch":{"operationId":"ReceivablesController_updateReceivable","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the receivable to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReceivableDto"}}}},"responses":{"200":{"description":"Successfully updated the receivable."},"401":{"description":"Unauthorized - User not authorized to update this receivable."},"404":{"description":"Receivable not found."},"500":{"description":"Internal server error."}},"tags":["Receivables"],"security":[{"access-token":[]}]},"delete":{"operationId":"ReceivablesController_deleteReceivable","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the receivable to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted the receivable."},"401":{"description":"Unauthorized - User not authorized to delete this receivable."},"404":{"description":"Receivable not found."},"500":{"description":"Internal server error."}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/public/{uuid}":{"get":{"operationId":"ReceivablesController_getPublicInvoice","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/payment-method/{uuid}":{"get":{"operationId":"ReceivablesController_getPublicPaymentMethod","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/status/{uuid}":{"patch":{"operationId":"ReceivablesController_updateReceivableStatus","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the receivable to update the status.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReceivableStatusDto"}}}},"responses":{"200":{"description":"Successfully updated the status of the receivable."},"401":{"description":"Unauthorized - User not authorized to update the status of this receivable."},"404":{"description":"Receivable not found."},"500":{"description":"Internal server error."}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/fix-contract-invoices":{"post":{"operationId":"ReceivablesController_fixContractInvoices","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixContractInvoicesDto"}}}},"responses":{"202":{"description":"Starts a background job that copies contract line items, discount, late fee, interest, and amount onto matching ongoing invoices. Results are posted to admin_alert."}},"tags":["Receivables"],"security":[{"access-token":[]}]}},"/receivables/add-invoice":{"post":{"operationId":"ReceivablesController_addInvoiceBoletoAndLifeCycle","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountReceivableDto"}}}},"responses":{"201":{"description":""}},"tags":["Receivables"]}},"/receivables/{business_id}/add-batch-invoice":{"post":{"operationId":"ReceivablesController_addBatchInvoiceBoletoAndLifeCycle","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"tags":["Receivables"]}},"/receivables/update-invoice/{uuid}":{"patch":{"operationId":"ReceivablesController_updateInvoiceBoletoAndLifeCycle","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountReceivableDtoII"}}}},"responses":{"200":{"description":""}},"tags":["Receivables"]}},"/economic-indexes":{"get":{"operationId":"EconomicIndexesController_getEconomicIndex","summary":"Get accumulated economic index for a period","description":"Fetches economic index data from BCB API and calculates the accumulated value for the specified period","parameters":[{"name":"startDate","required":true,"in":"query","description":"Start date for the index query","schema":{"example":"2024-01-01","type":"string"}},{"name":"endDate","required":true,"in":"query","description":"End date for the index query","schema":{"example":"2024-12-31","type":"string"}},{"name":"indexType","required":true,"in":"query","description":"Type of economic index","schema":{"example":"IGP_M","enum":["IGP_M","IPCA","INPC","INCC"],"type":"string"}}],"responses":{"200":{"description":"Economic index data retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomicIndexResponseDto"}}}},"400":{"description":"Invalid parameters"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}},"tags":["Economic Indexes"],"security":[{"access-token":[]}]}},"/economic-indexes/types":{"get":{"operationId":"EconomicIndexesController_getAvailableIndexTypes","summary":"Get available economic index types","description":"Returns all available economic indexes that can be used for automatic contract adjustments","parameters":[],"responses":{"200":{"description":"List of available economic index types","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EconomicIndexTypeResponseDto"}}}}},"401":{"description":"Unauthorized"}},"tags":["Economic Indexes"],"security":[{"access-token":[]}]}},"/economic-indexes/accumulated-last-12-months":{"get":{"operationId":"EconomicIndexesController_getAccumulatedLast12Months","summary":"Get accumulated index for the last 12 months","description":"Returns the accumulated value of a specific economic index for the last 12 complete months","parameters":[{"name":"indexType","required":true,"in":"query","description":"Type of economic index","schema":{"example":"IGP_M","enum":["IGP_M","IPCA","INPC","INCC"],"type":"string"}}],"responses":{"200":{"description":"Accumulated index data for the last 12 months","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccumulatedIndexResponseDto"}}}},"400":{"description":"Invalid index type or no data available"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}},"tags":["Economic Indexes"],"security":[{"access-token":[]}]}},"/auth/login":{"post":{"operationId":"AuthController_login","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"200":{"description":"Login success"},"401":{"description":"Unauthorized"}},"tags":["Auth"]}},"/auth/request-code":{"post":{"operationId":"AuthController_requestCode","parameters":[],"responses":{"201":{"description":""}},"tags":["Auth"]}},"/auth/verify-code":{"post":{"operationId":"AuthController_verifyCode","parameters":[],"responses":{"201":{"description":""}},"tags":["Auth"]}},"/users":{"post":{"operationId":"UserManagementController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagedUserDto"}}}},"responses":{"201":{"description":""}}}},"/users/client-user":{"post":{"operationId":"UserManagementController_createClientUser","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmClientUserDto"}}}},"responses":{"201":{"description":""}}}},"/users/client-user/request-code":{"post":{"operationId":"UserManagementController_requestClientUserCode","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientUserDto"}}}},"responses":{"201":{"description":""}}}},"/users/{uuid}/role":{"patch":{"operationId":"UserManagementController_changeRole","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeUserRoleDto"}}}},"responses":{"200":{"description":""}}}},"/business_accounts":{"get":{"operationId":"BusinessAccountsController_getAll","parameters":[{"name":"page","required":false,"in":"query","description":"The page number for pagination. Both page and limit parameters must be provided to enable pagination. The minimum value for page is 1.","schema":{"minimum":1,"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"The number of items per page for pagination. Both limit and page parameters must be provided to enable pagination. The minimum value for limit is 1.","schema":{"minimum":1,"type":"integer"}}],"responses":{"200":{"description":"Successfully retrieved all bussiness accounts associated to your account."},"500":{"description":"Internal Server Error."}},"tags":["Business Accounts"],"security":[{"access-token":[]}]}},"/business_accounts/search":{"get":{"operationId":"BusinessAccountsController_searchBusinessAccountByBusinessNo","parameters":[{"name":"business_no","required":true,"in":"query","schema":{"type":"string"}},{"name":"search","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully found the most likely active business account by CPF/CNPJ."},"400":{"description":"Missing business_no query param."}},"tags":["Business Accounts"],"security":[{"access-token":[]}]}},"/business_accounts/{uuid}":{"get":{"operationId":"BusinessAccountsController_getSingleBusinessAccounts","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the business account to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the specific business account."},"404":{"description":"Business account not found."},"500":{"description":"Internal server error."}},"tags":["Business Accounts"],"security":[{"access-token":[]}]},"patch":{"operationId":"BusinessAccountsController_updateBusinessAccount","parameters":[{"name":"uuid","required":true,"in":"path","description":"The unique identifier of the business account to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessAccountDto"}}}},"responses":{"200":{"description":"Successfully updated the business account."},"401":{"description":"Unauthorized - User not authorized to update this business account."},"404":{"description":"Business account not found."},"500":{"description":"Internal server error."}},"tags":["Business Accounts"],"security":[{"access-token":[]}]}},"/business_accounts/{uuid}/email-change/request-code":{"post":{"operationId":"BusinessAccountsController_requestBusinessEmailCode","parameters":[{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestBusinessEmailCodeDto"}}}},"responses":{"201":{"description":""}},"tags":["Business Accounts"]}},"/business_accounts/default-reminders/toggle":{"patch":{"operationId":"BusinessAccountsController_updateDefaultClientReminders","parameters":[],"responses":{"200":{"description":""}},"tags":["Business Accounts"]}},"/business_accounts/default-reminders":{"get":{"operationId":"BusinessAccountsController_getDefaultClientReminders","parameters":[{"name":"business_id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Business Accounts"]}},"/integrations/add":{"post":{"operationId":"IntegrationsController_addIntegration","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddIntegrationDto"}}}},"responses":{"201":{"description":""}}}},"/integrations/conta-azul/login":{"post":{"operationId":"IntegrationsController_contaAzulLogin","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContaAzulLoginDto"}}}},"responses":{"201":{"description":""}}}},"/integrations/perform-sync":{"post":{"operationId":"IntegrationsController_performIntegration","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerformSyncDto"}}}},"responses":{"201":{"description":""}}}},"/integrations/check-omie-missing-ids":{"post":{"operationId":"IntegrationsController_checkOmieMissingIds","parameters":[],"responses":{"201":{"description":""}}}},"/integrations/fetch/{business_id}":{"get":{"operationId":"IntegrationsController_fetchIntegrations","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/integrations/whatsapp/{business_id}":{"delete":{"operationId":"IntegrationsController_deleteIntegration","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"provider","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/integrations/{business_id}":{"get":{"operationId":"IntegrationsController_fetchIntegration","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/integrations/save-config":{"post":{"operationId":"IntegrationsController_saveConfig","parameters":[],"responses":{"201":{"description":""}}}},"/integrations/delete":{"post":{"operationId":"IntegrationsController_deleteErpIntegration","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteErpIntegrationDto"}}}},"responses":{"201":{"description":""}}}},"/omie/sync":{"post":{"operationId":"TasksController_omieSyncData","parameters":[],"responses":{"201":{"description":""}}}},"/omie/sync/boletos":{"post":{"operationId":"TasksController_omieSyncBoletos","parameters":[],"responses":{"201":{"description":""}}}},"/omie/sync/boletos/month":{"post":{"operationId":"TasksController_omieUpdateBoletosByMonth","parameters":[],"responses":{"201":{"description":""}}}},"/omie/sync-v1":{"post":{"operationId":"TasksController_omieSyncV1","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/login":{"post":{"operationId":"ContaAzulController_login","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/financial-accounts/{business_id}":{"get":{"operationId":"ContaAzulController_financialAccounts","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/conta-azul/financial-accounts/{business_id}/selection":{"put":{"operationId":"ContaAzulController_updateFinancialAccountSelection","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/conta-azul/categories/{business_id}":{"get":{"operationId":"ContaAzulController_categories","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/conta-azul/financial-accounts":{"post":{"operationId":"ContaAzulController_createFinancialAccount","summary":"Create a new financial account","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFinancialAccountDto"}}}},"responses":{"201":{"description":"The account has been successfully created."},"400":{"description":"Bad Request"}}},"put":{"operationId":"ContaAzulController_updateFinancialAccount","summary":"Update a financial account","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFinancialAccountDto"}}}},"responses":{"201":{"description":"The account has been successfully created."},"400":{"description":"Bad Request"}}},"delete":{"operationId":"ContaAzulController_deleteFinancialAccount","parameters":[],"responses":{"200":{"description":""}}}},"/conta-azul/customers":{"get":{"operationId":"ContaAzulController_getCustomer","parameters":[],"responses":{"200":{"description":""}}},"post":{"operationId":"ContaAzulController_createCustomer","parameters":[],"responses":{"201":{"description":""}}},"delete":{"operationId":"ContaAzulController_deleteCustomer","parameters":[],"responses":{"200":{"description":""}}}},"/conta-azul/contas-a-pagar":{"get":{"operationId":"ContaAzulController_accountsPayable","parameters":[],"responses":{"200":{"description":""}}}},"/conta-azul/contas-a-receber":{"get":{"operationId":"ContaAzulController_getAccountsReceivables","parameters":[],"responses":{"200":{"description":""}}},"post":{"operationId":"ContaAzulController_pay","summary":"Create a receivable account","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFinancialAccountDto"}}}},"responses":{"201":{"description":"The account has been successfully created."},"400":{"description":"Bad Request"}}}},"/conta-azul/contas-a-receber/{id}/paid":{"post":{"operationId":"ContaAzulController_updateAccountsReceivable","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountsReceivableDto"}}}},"responses":{"201":{"description":""}}}},"/conta-azul/sync":{"post":{"operationId":"ContaAzulController_sync","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/sync-v1":{"post":{"operationId":"ContaAzulController_syncV1","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/sync-clean-receivables-v1":{"post":{"operationId":"ContaAzulController_syncCleanReceivablesV1","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/sync-period-v1":{"post":{"operationId":"ContaAzulController_syncPeriodV1","parameters":[],"responses":{"201":{"description":""}}}},"/conta-azul/debug/invoice":{"post":{"operationId":"ContaAzulController_debugContaAzulInvoice","parameters":[],"responses":{"200":{"description":""}}}},"/integrations/conta-azul/v1/login":{"get":{"operationId":"AuthContaAzulV1Controller_generateAuthLink","parameters":[],"responses":{"200":{"description":""}}}},"/integrations/conta-azul/v1/auth":{"get":{"operationId":"AuthContaAzulV1Controller_handleContaAzulCallback","parameters":[{"name":"code","required":true,"in":"query","schema":{"type":"string"}},{"name":"state","required":true,"in":"query","schema":{"type":"string"}},{"name":"error","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/e-kontroll/financial-accounts":{"get":{"operationId":"EkontrollController_financialAccounts","parameters":[],"responses":{"200":{"description":""}}}},"/e-kontroll/customers/{business_uuid}":{"get":{"operationId":"EkontrollController_getCustomers","parameters":[{"name":"business_uuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/e-kontroll/receivables/{business_uuid}":{"get":{"operationId":"EkontrollController_getReceivables","parameters":[{"name":"business_uuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/e-kontroll/sync":{"post":{"operationId":"EkontrollController_importAllAndCompareAtributesForBusinesses","parameters":[],"responses":{"201":{"description":""}}}},"/webhook/{service}":{"post":{"operationId":"WebhookController_handleWebhook","parameters":[{"name":"service","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/bank-statements":{"post":{"operationId":"BankStatementsController_ImportBankStatements","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankAccountStatementsDto"}}}},"responses":{"201":{"description":""}}},"get":{"operationId":"BankStatementsController_getBankStatements","parameters":[],"responses":{"200":{"description":""}}}},"/bank-statements/export/excel":{"get":{"operationId":"BankStatementsController_test","parameters":[],"responses":{"200":{"description":""}}}},"/plug-notas/create-company":{"post":{"operationId":"PlugNotasController_createCompany","parameters":[],"responses":{"201":{"description":""}}}},"/plug-notas/{business_id}/update-authentication":{"post":{"operationId":"PlugNotasController_updateCredentialsOnly","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/plug-notas/webhook":{"post":{"operationId":"PlugNotasController_webhook","parameters":[],"responses":{"201":{"description":""}}}},"/plug-notas/company-lookup/{cnpj}":{"get":{"operationId":"PlugNotasController_companyLookup","parameters":[{"name":"cnpj","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/plug-notas/city-lookup/{cep}":{"get":{"operationId":"PlugNotasController_cityLookup","parameters":[{"name":"cep","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/plug-notas/{business_id}/upload-certificate":{"post":{"operationId":"PlugNotasController_uploadCertificate","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/plug-notas/{business_id}/certificate":{"get":{"operationId":"PlugNotasController_checkCertificate","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/plug-notas/{business_id}/nfse":{"get":{"operationId":"PlugNotasController_getNfseList","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/plug-notas/{business_id}/nfse/check":{"get":{"operationId":"PlugNotasController_checkNfse","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/addresses":{"post":{"operationId":"AddressesController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAddressDto"}}}},"responses":{"201":{"description":""}}},"get":{"operationId":"AddressesController_findAll","parameters":[],"responses":{"200":{"description":""}}}},"/addresses/by-ref":{"get":{"operationId":"AddressesController_findOne","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"patch":{"operationId":"AddressesController_update","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddressDto"}}}},"responses":{"200":{"description":""}}},"delete":{"operationId":"AddressesController_remove","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/addresses/populate-client-addresses":{"post":{"operationId":"AddressesController_populateClientAddresses","parameters":[],"responses":{"201":{"description":""}}}},"/addresses/import-client-addresses":{"post":{"operationId":"AddressesController_importClientAddresses","parameters":[],"responses":{"201":{"description":""}}}},"/addresses/import-all-business-with-nfse-client-addresses":{"post":{"operationId":"AddressesController_importAllBusinessWithNfseClientAddresses","parameters":[],"responses":{"201":{"description":""}}}},"/addresses/import-all-business":{"post":{"operationId":"AddressesController_importAllBusiness","parameters":[],"responses":{"201":{"description":""}}}},"/addresses/import-ibge-addresses":{"post":{"operationId":"AddressesController_importIbgeAddresses","parameters":[],"responses":{"201":{"description":""}}}},"/addresses/ibge-addresses":{"get":{"operationId":"AddressesController_getIbgeAddresses","parameters":[{"name":"cityName","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse":{"post":{"operationId":"NfseController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmitNfseDto"}}}},"responses":{"201":{"description":""}}}},"/nfse/batch":{"post":{"operationId":"NfseController_createBatch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmitNfseBatchDto"}}}},"responses":{"201":{"description":""}}}},"/nfse/{id}":{"post":{"operationId":"NfseController_emit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"201":{"description":""}}},"delete":{"operationId":"NfseController_delete","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse/exists/{id}":{"get":{"operationId":"NfseController_hasNfse","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse/{business_id}/config":{"get":{"operationId":"NfseController_getNfseConfig","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"post":{"operationId":"NfseController_upsertNfseConfig","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NfseConfigDto"}}}},"responses":{"201":{"description":""}}}},"/nfse/cancel":{"post":{"operationId":"NfseController_cancelNfse","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelNfseDto"}}}},"responses":{"201":{"description":""}}}},"/nfse/create-company":{"post":{"operationId":"NfseController_createCompany","parameters":[],"responses":{"201":{"description":""}}}},"/nfse/emit-pending-nfse":{"post":{"operationId":"NfseController_emitPendingNfse","parameters":[],"responses":{"201":{"description":""}}}},"/nfse/config-data/{business_id}":{"get":{"operationId":"NfseController_getConfigData","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse/sync-nfse":{"get":{"operationId":"NfseController_syncNfse","parameters":[],"responses":{"200":{"description":""}}}},"/nfse/resolve-nfse":{"get":{"operationId":"NfseController_resolveNfse","parameters":[],"responses":{"200":{"description":""}}}},"/nfse/{business_id}/additional-taxes":{"get":{"operationId":"NfseAdditionalTaxController_getByBusinessId","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"access-token":[]}]},"post":{"operationId":"NfseAdditionalTaxController_createByBusinessId","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertNfseAdditionalTaxDto"}}}},"responses":{"201":{"description":""}},"security":[{"access-token":[]}]}},"/nfse/{business_id}/additional-taxes/{uuid}":{"patch":{"operationId":"NfseAdditionalTaxController_updateByBusinessId","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertNfseAdditionalTaxDto"}}}},"responses":{"200":{"description":""}},"security":[{"access-token":[]}]},"delete":{"operationId":"NfseAdditionalTaxController_deleteByBusinessId","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"uuid","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"access-token":[]}]}},"/nfse-registration/{business_id}/setup":{"get":{"operationId":"NfseRegistrationController_getSetup","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse-registration/{business_id}/certificate-status":{"get":{"operationId":"NfseRegistrationController_getCertificateStatus","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/nfse-registration/{business_id}/certificate":{"post":{"operationId":"NfseRegistrationController_uploadCertificate","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/nfse-registration/{business_id}/register":{"post":{"operationId":"NfseRegistrationController_registerCompany","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/bank-accounts":{"post":{"operationId":"BankAccountsController_create","parameters":[],"responses":{"201":{"description":""}}},"get":{"operationId":"BankAccountsController_findAll","parameters":[{"name":"businessId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/bank-accounts/{id}":{"patch":{"operationId":"BankAccountsController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBankAccountDto"}}}},"responses":{"200":{"description":""}}},"delete":{"operationId":"BankAccountsController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/cnab/import":{"post":{"operationId":"CNABController_processCNABFile","parameters":[],"responses":{"201":{"description":""}}}},"/zappy/instances":{"post":{"operationId":"ZappyController_createInstance","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZappyInstanceDto"}}}},"responses":{"201":{"description":""}}}},"/zappy/instances/{id}/connect":{"post":{"operationId":"ZappyController_connectInstance","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/zappy/instances/{id}/sendText":{"post":{"operationId":"ZappyController_sendText","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTextDto"}}}},"responses":{"201":{"description":""}}}},"/zappy/instances/{id}":{"get":{"operationId":"ZappyController_getInstance","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/zappy/instances/{id}/disconnect":{"post":{"operationId":"ZappyController_disconnectInstance","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/zappy-legacy/instances":{"post":{"operationId":"ZappyLegacyController_createInstance","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZappyLegacyInstanceDto"}}}},"responses":{"201":{"description":""}}}},"/zappy-legacy/instances/{id}/sendText":{"post":{"operationId":"ZappyLegacyController_sendText","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTextDto"}}}},"responses":{"201":{"description":""}}}},"/zappy-legacy/instances/{id}":{"get":{"operationId":"ZappyLegacyController_getInstance","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"post":{"operationId":"ZappyLegacyController_selectInstance","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/zappy-legacy/departments/{id}":{"get":{"operationId":"ZappyLegacyController_getDepartment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"post":{"operationId":"ZappyLegacyController_selectDepartment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/zappy-legacy/config/{id}":{"get":{"operationId":"ZappyLegacyController_getConfig","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/zappy-legacy/toggle/{id}":{"post":{"operationId":"ZappyLegacyController_updateConfig","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/whatsapp-oficial/instances":{"post":{"operationId":"WhatsappOficialController_createInstance","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWhatsappOficialInstanceDto"}}}},"responses":{"201":{"description":""}}}},"/whatsapp-oficial/instances/{id}/sendText":{"post":{"operationId":"WhatsappOficialController_sendText","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTemplateRequestDto"}}}},"responses":{"201":{"description":""}}}},"/whatsapp-oficial/instances/{id}/sendTextPositional":{"post":{"operationId":"WhatsappOficialController_sendTextPositional","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTemplatePositionalRequestDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/analytics/{id}":{"get":{"operationId":"GupshupController_getAnalytics","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/gupshup/received-messages/{id}":{"get":{"operationId":"GupshupController_getReceivedMessages","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/gupshup/instances":{"post":{"operationId":"GupshupController_createInstance","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGupshupInstanceDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/received-messages":{"post":{"operationId":"GupshupController_ingestReceivedMessages","parameters":[],"responses":{"201":{"description":""}}}},"/gupshup/instances/{id}/sendText":{"post":{"operationId":"GupshupController_sendText","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTemplateGupShupRequestDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/instances/{id}/sendTextWithButton":{"post":{"operationId":"GupshupController_sendTextWithButton","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTemplateGupShupRequestDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/kolek-gowa/reconnection-reminder":{"post":{"operationId":"GupshupController_sendDisconnectedKolekGowaReminder","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendDisconnectedKolekGowaReminderDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/webhooks/received-messages":{"post":{"operationId":"GupshupWebhookController_ingestReceivedMessages","parameters":[],"responses":{"201":{"description":""}}}},"/gupshup/config/{businessId}/integration":{"post":{"operationId":"GupshupConfigurationController_setIntegrationCredentials","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetGupshupIntegrationCredentialsDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/config/{businessId}/templates":{"post":{"operationId":"GupshupConfigurationController_createTemplates","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGupshupTemplatesDto"}}}},"responses":{"201":{"description":""}}}},"/gupshup/config/{businessId}/templates/approved":{"post":{"operationId":"GupshupConfigurationController_checkTemplatesApproved","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}}}},"/cnae":{"post":{"operationId":"CnaeController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCnaeAndServiceCodeDto"}}}},"responses":{"201":{"description":""}}}},"/get-key/scan-face/{cpf}":{"get":{"operationId":"GetKeyController_getFaceKey","parameters":[{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/get-key/scan-device/{cpf}":{"get":{"operationId":"GetKeyController_getDeviceKey","parameters":[{"name":"cpf","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/receivable-settings/business/{businessId}":{"get":{"operationId":"ReceivableSettingsController_getByBusiness","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"post":{"operationId":"ReceivableSettingsController_update","parameters":[{"name":"businessId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReceivableSettingsDto"}}}},"responses":{"201":{"description":""}}}},"/analytics/dashboard/{business_id}":{"get":{"operationId":"AnalyticsController_getDashboardAnalytics","parameters":[{"name":"business_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"month","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}}},"/analytics/lifecycle":{"post":{"operationId":"AnalyticsController_getLifecycleAnalytics","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleAnalyticsDto"}}}},"responses":{"201":{"description":""}}}},"/analytics/lifecycle/daily-checker":{"post":{"operationId":"AnalyticsController_runLifecycleDailyChecker","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleDailyCheckerDto"}}}},"responses":{"201":{"description":""}}}},"/analytics/lifecycle/export":{"post":{"operationId":"AnalyticsController_exportLifecycleAnalytics","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LifecycleAnalyticsDto"}}}},"responses":{"201":{"description":""}}}}},"info":{"title":"Kolek API","description":"...","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GowaSendMessageDto":{"type":"object","properties":{}},"InitWasenderSessionDto":{"type":"object","properties":{}},"UpdateWasenderSessionPhoneDto":{"type":"object","properties":{}},"WasenderSendMessageDto":{"type":"object","properties":{}},"CreateFeesV2Dto":{"type":"object","properties":{}},"QitechAnalysisWebhookDto":{"type":"object","properties":{}},"FaceDataDto":{"type":"object","properties":{}},"CreateQITechCompanyDto":{"type":"object","properties":{}},"UpdateCompanyDto":{"type":"object","properties":{}},"SendMailDto":{"type":"object","properties":{}},"MissingLifecyclesDto":{"type":"object","properties":{}},"UpdateContractDto":{"type":"object","properties":{"line_items":{"type":"object","description":"The line items of the contract. Array or JSON string."},"services":{"type":"object","description":"Alias for line_items, same shape as contract create services."},"update_option":{"type":"string","description":"The update option of the contract."},"issue_day":{"type":"number","description":"Day of the month for issue date (1-31)"},"billing_day":{"type":"number","description":"Day of the month for billing/due date (1-31)"},"discount":{"type":"number","description":"Discount percentage"},"late_fee":{"type":"number","description":"Late fee percentage"},"interest":{"type":"number","description":"Interest percentage per month"}},"required":["update_option"]},"UpdateContractStatusDto":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","SUSPENDED","COMPLETED","DELETED"],"description":"The status of the receivable. Note: If setting to \"Paid\", both \"payment_date\" and \"payment_amount\" must be provided."}},"required":["status"]},"UpdateAdjustmentDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether automatic adjustment is enabled"},"frequency":{"type":"string","description":"Frequency of adjustment (PERIOD or SPECIFIC_DATE)"},"calculation_type":{"type":"string","description":"Type of calculation (PERCENTAGE or INDEX)"},"period_value":{"type":"number","description":"Period value for PERIOD frequency"},"period_unit":{"type":"string","description":"Period unit for PERIOD frequency (months or years)"},"specific_month":{"type":"number","description":"Specific month for SPECIFIC_DATE frequency (1-12)"},"percentage":{"type":"number","description":"Percentage for PERCENTAGE calculation type"},"index_type":{"type":"string","description":"Index type for INDEX calculation type"}},"required":["enabled"]},"BulkAdjustmentContractDto":{"type":"object","properties":{"contract_uuids":{"description":"Array of contract UUIDs to update adjustment for","example":["uuid1","uuid2","uuid3"],"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean","description":"Whether automatic adjustment is enabled"},"frequency":{"type":"string","description":"Frequency of adjustment (PERIOD or SPECIFIC_DATE)"},"calculation_type":{"type":"string","description":"Type of calculation (PERCENTAGE or INDEX)"},"period_value":{"type":"number","description":"Period value for PERIOD frequency"},"period_unit":{"type":"string","description":"Period unit for PERIOD frequency (months or years)"},"specific_month":{"type":"number","description":"Specific month for SPECIFIC_DATE frequency (1-12)"},"percentage":{"type":"number","description":"Percentage for PERCENTAGE calculation type"},"index_type":{"type":"string","description":"Index type for INDEX calculation type"},"edit_notes":{"type":"string","description":"Optional note about this bulk edit"}},"required":["contract_uuids","enabled"]},"LineItemDto":{"type":"object","properties":{"description":{"type":"string","description":"Description of the service"},"quantity":{"type":"number","description":"Quantity"},"price":{"type":"number","description":"Price per unit"}},"required":["description","quantity","price"]},"BulkEditContractsDto":{"type":"object","properties":{"contract_uuids":{"description":"Array of contract UUIDs to edit","example":["uuid-1","uuid-2"],"type":"array","items":{"type":"string"}},"receivable_scope":{"type":"string","enum":["open_to_be_due","all_open","specific_month"],"description":"Scope for applying changes to receivables: open_to_be_due (open and not yet due), all_open (all open including overdue), specific_month (specific month)","example":"open_to_be_due"},"specific_month":{"type":"string","description":"Specific month to apply changes (YYYY-MM format). Required when receivable_scope is SPECIFIC_MONTH.","example":"2025-01"},"first_bill_date":{"type":"string","description":"First bill date (contract start date) in ISO format","example":"2025-01-01"},"issue_day":{"type":"number","description":"Day of the month for issue date (1-31)","example":5},"billing_day":{"type":"number","description":"Day of the month for billing/due date (1-31)","example":10},"total_bill_cycles":{"type":"number","nullable":true,"description":"Total number of bill cycles (contract duration). Use null for indeterminate/unlimited cycles.","example":12},"discount":{"type":"number","description":"Discount value (percentage or absolute based on discount_code)","example":10},"discount_code":{"type":"number","description":"Discount type: 0 = percentage, 1 = absolute value","example":0},"late_fee":{"type":"number","description":"Late fee value (percentage or absolute based on late_fee_code)","example":2},"late_fee_code":{"type":"number","description":"Late fee type: 0 = percentage, 1 = absolute value","example":0},"interest":{"type":"number","description":"Interest value (percentage per month or absolute per day based on interest_code)","example":1},"interest_code":{"type":"number","description":"Interest type: 0 = percentage per month, 1 = absolute value per day","example":0},"line_items":{"description":"Line items (services) to update","type":"array","items":{"$ref":"#/components/schemas/LineItemDto"}},"replace_line_items":{"type":"boolean","description":"If true, replaces all line items. If false, appends to existing.","default":false},"regenerate_bankslips":{"type":"boolean","description":"If true, cancels existing bankslips and regenerates them with updated values","default":false},"edited_by":{"type":"string","description":"User ID who is making the edit"}},"required":["contract_uuids","receivable_scope","edited_by"]},"BulkEditContractResultDto":{"type":"object","properties":{"contract_uuid":{"type":"string","description":"Contract UUID"},"status":{"type":"string","enum":["success","failed","partial"],"description":"Status of the edit operation"},"message":{"type":"string","description":"Descriptive message about the result"},"receivables_updated":{"type":"number","description":"Number of receivables updated"},"receivables_deleted":{"type":"number","description":"Number of receivables deleted (excess invoices removed)"},"receivables_created":{"type":"number","description":"Number of receivables created (new invoices)"},"bankslips_cancelled":{"type":"number","description":"Number of bankslips cancelled"},"bankslips_regenerated":{"type":"number","description":"Number of bankslips regenerated"},"skipped_reasons":{"description":"Reasons for skipped receivables","type":"array","items":{"type":"string"}}},"required":["contract_uuid","status","message","receivables_updated","receivables_deleted","receivables_created","bankslips_cancelled","bankslips_regenerated"]},"BulkEditContractsResponseDto":{"type":"object","properties":{"status":{"type":"boolean","description":"Overall status of the bulk operation"},"message":{"type":"string","description":"Summary message"},"bulk_operation_id":{"type":"string","description":"Unique identifier for this bulk operation"},"total_contracts":{"type":"number","description":"Total number of contracts processed"},"successful_contracts":{"type":"number","description":"Number of contracts successfully updated"},"failed_contracts":{"type":"number","description":"Number of contracts that failed to update"},"results":{"description":"Individual results for each contract","type":"array","items":{"$ref":"#/components/schemas/BulkEditContractResultDto"}}},"required":["status","message","bulk_operation_id","total_contracts","successful_contracts","failed_contracts","results"]},"CreateContractDto":{"type":"object","properties":{}},"BulkDeleteContractsDto":{"type":"object","properties":{"contract_uuids":{"description":"Array of contract UUIDs to delete","example":["uuid1","uuid2","uuid3"],"type":"array","items":{"type":"string"}}},"required":["contract_uuids"]},"BulkEditReceivablesDto":{"type":"object","properties":{"filter_type":{"type":"string","enum":["all_pending","to_be_due"],"description":"Filter type to select which receivables to edit"},"receivable_ids":{"description":"Specific receivable UUIDs to edit. If provided, filter_type is ignored.","type":"array","items":{"type":"string"}},"issued_day":{"type":"number","description":"Day of the month for issued date (1-31)"},"due_day":{"type":"number","description":"Day of the month for due date (1-31)"},"discount":{"type":"number","description":"Discount value (percentage or absolute based on discount_code)"},"discount_code":{"type":"number","description":"Discount type: 0 = percentage, 1 = absolute value"},"late_fee":{"type":"number","description":"Late fee value (percentage or absolute based on late_fee_code)"},"late_fee_code":{"type":"number","description":"Late fee type: 0 = percentage, 1 = absolute value"},"interest":{"type":"number","description":"Interest value (percentage per month or absolute per day based on interest_code)"},"interest_code":{"type":"number","description":"Interest type: 0 = percentage per month, 1 = absolute value per day"},"line_items":{"description":"Line items (services) to update","type":"array","items":{"$ref":"#/components/schemas/LineItemDto"}},"replace_line_items":{"type":"boolean","description":"If true, replaces all line items. If false, appends to existing.","default":false},"edited_by":{"type":"string","description":"User ID who is making the edit"}},"required":["filter_type","edited_by"]},"UpdateReceivableStatusDto":{"type":"object","properties":{"status":{"type":"string","enum":["Ongoing","Cancelled","On-hold","Paid"],"description":"The status of the receivable. Note: If setting to \"Paid\", both \"payment_date\" and \"payment_amount\" must be provided."},"payment_date":{"format":"date-time","type":"string","description":"The payment date. Required if status is \"Paid\"."},"payment_amount":{"type":"number","description":"The payment amount. Required if status is \"Paid\"."}},"required":["status"]},"UpdateReceivableDto":{"type":"object","properties":{"invoice_no":{"type":"string"},"boleto":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"issued_date":{"format":"date-time","type":"string"},"due_date":{"format":"date-time","type":"string"},"discount":{"type":"number"},"late_fee":{"type":"number"},"interest":{"type":"number"},"updated_at":{"format":"date-time","type":"string"},"line_items":{"type":"string"},"has_adjustment":{"type":"boolean"},"adjustment_percentage":{"type":"number"},"adjustment_date":{"format":"date-time","type":"string"},"original_amount":{"type":"number"}}},"FixContractInvoicesDto":{"type":"object","properties":{"business_id":{"type":"string","description":"Business UUID to fix. If omitted, all non-deleted businesses are processed."}}},"CreateAccountReceivableDto":{"type":"object","properties":{}},"UpdateAccountReceivableDtoII":{"type":"object","properties":{}},"MonthlyValueDto":{"type":"object","properties":{"date":{"type":"string","description":"Month/Year of the index","example":"01/2024"},"value":{"type":"string","description":"Monthly variation in percentage","example":"0.45"}},"required":["date","value"]},"EconomicIndexResponseDto":{"type":"object","properties":{"indexType":{"type":"string","description":"Type of economic index","enum":["IGP_M","IPCA","INPC","INCC"],"example":"IGP_M"},"indexName":{"type":"string","description":"Index display name","example":"IGP-M"},"startDate":{"type":"string","description":"Start date of the query","example":"2024-01-01"},"endDate":{"type":"string","description":"End date of the query","example":"2024-12-31"},"accumulatedValue":{"type":"number","description":"Accumulated index value for the period (percentage)","example":5.21},"monthlyValues":{"description":"Monthly values within the period","type":"array","items":{"$ref":"#/components/schemas/MonthlyValueDto"}},"monthsCount":{"type":"number","description":"Total number of months in the period","example":12}},"required":["indexType","indexName","startDate","endDate","accumulatedValue","monthlyValues","monthsCount"]},"EconomicIndexTypeResponseDto":{"type":"object","properties":{"type":{"type":"string","description":"Index type key","enum":["IGP_M","IPCA","INPC","INCC"],"example":"IGP_M"},"name":{"type":"string","description":"Display name for the index","example":"IGP-M"},"code":{"type":"string","description":"Series code used in BCB API","example":"189"}},"required":["type","name","code"]},"AccumulatedIndexResponseDto":{"type":"object","properties":{"indexType":{"type":"string","description":"Type of economic index","enum":["IGP_M","IPCA","INPC","INCC"],"example":"IGP_M"},"indexName":{"type":"string","description":"Index display name","example":"IGP-M"},"accumulatedValue":{"type":"number","description":"Accumulated value for the last 12 months (percentage)","example":5.21},"period":{"type":"string","description":"Period description","example":"Últimos 12 meses"},"periodStartDate":{"type":"string","description":"Reference period start date","example":"2024-01-01"},"periodEndDate":{"type":"string","description":"Reference period end date","example":"2024-12-31"},"lastUpdated":{"type":"string","description":"Last update timestamp","example":"2025-08-25T13:45:30.000Z"}},"required":["indexType","indexName","accumulatedValue","period","periodStartDate","periodEndDate","lastUpdated"]},"LoginDto":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}},"required":["email","password"]},"CreateManagedUserDto":{"type":"object","properties":{}},"ConfirmClientUserDto":{"type":"object","properties":{}},"CreateClientUserDto":{"type":"object","properties":{}},"ChangeUserRoleDto":{"type":"object","properties":{}},"UpdateBusinessAccountDto":{"type":"object","properties":{"business_name":{"type":"string"},"business_no":{"type":"string"},"business_email":{"type":"string"},"business_contact":{"type":"string"}}},"RequestBusinessEmailCodeDto":{"type":"object","properties":{}},"AddIntegrationDto":{"type":"object","properties":{"type":{"type":"string"},"business_id":{"type":"string"},"bank_account_id":{"type":"string"},"erp":{"type":"string"},"api_key":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}},"required":["type","business_id","bank_account_id","erp","api_key","client_id","client_secret"]},"ContaAzulLoginDto":{"type":"object","properties":{}},"PerformSyncDto":{"type":"object","properties":{"integration_type":{"type":"string"},"business_id":{"type":"string"}},"required":["integration_type","business_id"]},"DeleteErpIntegrationDto":{"type":"object","properties":{}},"CreateFinancialAccountDto":{"type":"object","properties":{}},"UpdateFinancialAccountDto":{"type":"object","properties":{}},"UpdateAccountsReceivableDto":{"type":"object","properties":{}},"GetBankAccountStatementsDto":{"type":"object","properties":{}},"CreateAddressDto":{"type":"object","properties":{}},"UpdateAddressDto":{"type":"object","properties":{}},"EmitNfseDto":{"type":"object","properties":{}},"EmitNfseBatchDto":{"type":"object","properties":{}},"NfseConfigDto":{"type":"object","properties":{}},"CancelNfseDto":{"type":"object","properties":{}},"UpsertNfseAdditionalTaxDto":{"type":"object","properties":{}},"UpdateBankAccountDto":{"type":"object","properties":{}},"CreateZappyInstanceDto":{"type":"object","properties":{}},"SendTextDto":{"type":"object","properties":{}},"CreateZappyLegacyInstanceDto":{"type":"object","properties":{}},"CreateWhatsappOficialInstanceDto":{"type":"object","properties":{}},"SendTemplateRequestDto":{"type":"object","properties":{}},"SendTemplatePositionalRequestDto":{"type":"object","properties":{}},"CreateGupshupInstanceDto":{"type":"object","properties":{}},"SendTemplateGupShupRequestDto":{"type":"object","properties":{}},"SendDisconnectedKolekGowaReminderDto":{"type":"object","properties":{}},"SetGupshupIntegrationCredentialsDto":{"type":"object","properties":{}},"CreateGupshupTemplatesDto":{"type":"object","properties":{}},"CreateCnaeAndServiceCodeDto":{"type":"object","properties":{}},"UpdateReceivableSettingsDto":{"type":"object","properties":{}},"LifecycleAnalyticsDto":{"type":"object","properties":{}},"LifecycleDailyCheckerDto":{"type":"object","properties":{}}}}}