Skip to main content

​
Campos

CampoTipoDescrição
companyPaymentSettingsIdUUIDIdentificador único
organizationIdUUIDReferência à organização da empresa
companyIdUUIDReferência à empresa dona da configuração
externalProviderStringIdentificador lógico do provider usado pela interface de billing
externalAccountIdStringIdentificador da conta externa da empresa no provider
externalWalletIdString?Identificador auxiliar da carteira externa, quando existir
externalApiKeyStringAPI key externa armazenada de forma criptografada
statusCompanyPaymentSettingsStatusStatus da configuração de billing
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização
deletedByUUID?Usuário que removeu o registro, quando aplicável
deletedAtDateTime?Data de remoção

​
Relacionamentos

​
Regras de Negócio

  • Cada empresa possui no máximo uma configuração de billing ativa.
  • A configuração pertence sempre a uma Company; Cooperative não participa do fluxo de billing.
  • externalAccountId identifica a conta externa usada pela empresa para cobranças, saldo, recebíveis e transferências.
  • externalApiKey é criptografado antes de ser persistido e nunca deve ser exibido em respostas públicas.
  • externalWalletId é uma referência externa auxiliar; não representa regra de split.

​
Enums

​
CompanyPaymentSettingsStatus

ValorDescrição
PENDINGConfiguração criada, aguardando habilitação
ACTIVEConfiguração ativa para operações financeiras
REJECTEDConfiguração recusada ou não aprovada
DISABLEDConfiguração desabilitada

​
Example

{
  "companyPaymentSettingsId": "0197a817-1cc7-7d9c-9d74-8149674d0ef2",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "externalProvider": "billing_interface",
  "externalAccountId": "acct_2c9f81b0",
  "externalWalletId": "wallet_42d8a19f",
  "externalApiKey": "encrypted_external_api_key",
  "status": "ACTIVE",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T14:30:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T14:30:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}