{"openapi":"3.0.0","info":{"title":"5.13.2 - Billing Account Associations Management","description":"# **Esta API disponibiliza consultas de Billing Account Associations Management, ou seja, consulta de associações da conta de faturamento dos clientes da brMalls com outras entidades.**\n\n> _Para utilização do serviço é necessário cadastro em nossa API Manager\n(https://integration.brmalls.com.br/store/site/pages/sign-up.jag) e\ninscrever a aplicação no serviço, o mesmo será aprovado por **TICORE**._","contact":{"name":"Integração","email":"gd_ti_integracao@brmalls.com.br"},"version":"1.6.0"},"servers":[{"url":"https://services.brmalls.com.br/customer/BillingAccountAssociationsManagement/1.2.0"},{"url":"https://virtserver.swaggerhub.com/brmalls/5.13.2-BillingAccountAssociationsManagement/1.5.0"}],"tags":[{"name":"CustomerAccount"},{"name":"CustomerAccountLine"},{"name":"CustomerAcctBusinessPurpose"},{"name":"BillingGroup"},{"name":"BillingGroupCustomer"},{"name":"BillingGroupCustomerLuc"}],"paths":{"/billing-account-associations/accounts/{custAccountId}":{"get":{"tags":["CustomerAccount"],"summary":"Conta do Cliente","description":"Retorna a conta de cliente.  A conta pode pertencer a uma parte do tipo Pessoa ou Organização e é usada nas transações financeiras do cliente.","parameters":[{"name":"custAccountId","in":"path","description":"Id da Conta do Cliente. Tambem chamado de Id do cliente.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Conta do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccount"}}}},"400":{"description":"Requisição Inválida."},"404":{"description":"Dado não encontrado."},"500":{"description":"Erro Interno."}}}},"/billing-account-associations/accounts":{"get":{"tags":["CustomerAccount"],"summary":"Conta do Cliente","description":"Retorna uma lista de contas de cliente.  A conta pode pertencer a uma parte do tipo Pessoa ou Organização e é usada nas transações financeiras do cliente. <br>**É necessário buscar por pelo menos um parâmetro que não seja de paginação.**","parameters":[{"name":"partyId","in":"query","description":"Id do cabeçalho do Cliente.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"accountNumber","in":"query","description":"Raiz do CNPJ ou CPF do Cliente.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status de Ativo (A) ou Inativo (I)","required":false,"schema":{"type":"string","enum":["A","I"]}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=raizInscricao ou sort=-raizInscricao indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de Contas do Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccountResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/customeraccountlines/{custAcctSiteId}":{"get":{"tags":["CustomerAccountLine"],"summary":"Linha da conta do cliente.","description":"Retorna a linha da conta de um cliente. Cada linha é uma associação com uma organização do shopping.","parameters":[{"name":"custAcctSiteId","in":"path","description":"Id da linha da conta do Cliente.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Linhas da conta do cliente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccountLine"}}}},"400":{"description":"Requisição Inválida."},"404":{"description":"Dado não encontrado."},"500":{"description":"Erro Interno."}}}},"/billing-account-associations/customeraccountlines":{"get":{"tags":["CustomerAccountLine"],"summary":"Linhas da conta do cliente.","description":"Retorna as linhas da conta de um cliente. Cada linha é uma associação com uma organização de um shopping. <br>**É necessário buscar por pelo menos um parâmetro que não seja de paginação**","parameters":[{"name":"companyIds","in":"query","description":"Lista de ids de organizações de um shopping separados por vírgula. Exemplo: 106,108,121,123,241,942","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"custAccountId","in":"query","description":"Id da conta do Cliente.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"partySiteIds","in":"query","description":"Lista de ids da linha do cliente, separados por virgula.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"raizInscricao","in":"query","description":"Raiz do CNPJ ou CPF.<br> O tamanho da raiz de um CPNJ é de 8 digitos e CPF, 9. <BR>No EBS essa informação, somente para CNPJ está prefixada com digito 0, devido a uma regra de limite de tamanho de campo na tela do EBS. Portanto prefixar a raiz do CNPJ com o digito 0 para buscar a informação.","required":false,"schema":{"type":"string"}},{"name":"filialInscricao","in":"query","description":"Filial da inscriacao para quando a inscrição for do tipo CNPJ.","required":false,"schema":{"type":"string"}},{"name":"digitoInscricao","in":"query","description":"Digito verificador do CNPJ ou CPF.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status de Ativo (A) ou Inativo (I)","required":false,"schema":{"type":"string","enum":["A","I"]}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=raizInscricao ou sort=-raizInscricao indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista as linhas da conta do cliente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccountLineResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/customeracct-businesspurposes/{siteUseId}":{"get":{"tags":["CustomerAcctBusinessPurpose"],"summary":"Objetivo comercial da linha da conta do cliente.","description":"Retorna o objetivo comercial da linha da conta de um cliente associado à LUC da linha do cliente. É necessário buscar por pelo menos um parâmetro.","parameters":[{"name":"siteUseId","in":"path","description":"Id do objetivo comercial da linha da conta do cliente.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Objetivo comercial da linha da conta do cliente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAcctBusinessPurpose"}}}},"400":{"description":"Requisição Inválida."},"404":{"description":"Dado não encontrado."},"500":{"description":"Erro Interno."}}}},"/billing-account-associations/customeracct-businesspurposes":{"get":{"tags":["CustomerAcctBusinessPurpose"],"summary":"Objetivos comerciais da linha da conta do cliente","description":"Retorna os objetivos comerciais da linha da conta de um cliente associado à LUC da linha do cliente. <br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"custAcctSiteIds","in":"query","description":"Lista de Ids da linha da conta do cliente.","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"siteUseCode","in":"query","description":"Codigo do objetivo comercial da linha da conta do cliente. Exemplo de Valores mais usados: <br><br> - BILL_TO : usado para o faturamento <br> - DELIVER_TO <br> - SHIP_TO","schema":{"type":"string"}},{"name":"companyIds","in":"query","description":"Lista de ids de organizações de um shopping separados por vírgula. Exemplo: 106,108,121,123,241,942","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"luc","in":"query","description":"Código da LUC (Alias) da linha da conta do cliente. Aceita busca parcial.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Status de Ativo (A) ou Inativo (I)","required":false,"schema":{"type":"string","enum":["A","I"]}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=raizInscricao ou sort=-raizInscricao indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista os objetivos comerciais da linha da conta do cliente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAcctBusinessPurposeResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/customeraccountlines/lucs":{"get":{"tags":["CustomerAccountLine"],"summary":"Lucs de uma linha de conta de cliente (CNPJ ou CPF completo)","description":"Retorna a lista de LUCs que pertecem ou que ja pertenceram a um CNPJ ou CPF completo de uma conta de cliente.","parameters":[{"name":"customerInscription","in":"query","description":"CNPJ ou CPF completos de um cliente sem formatação, 14 caracteres ou 11 caracteres respectivamente. Aceita também consulta por CNPJ ou CPF raiz, ou seja, 8 ou 9 caracteres, respectivamente.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=raizInscricao ou sort=-raizInscricao indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de Lucs de uma linha de conta de cliente (CNPJ ou CPF completo)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LucCustomerResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/billinggroup":{"get":{"tags":["BillingGroup"],"summary":"Retorna uma lista de Grupos de Cobrança com todas suas associações.","description":"Retorna uma lista de grupos de Cobrança com todas suas associações. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.<br>Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança.<br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"groupName","in":"query","description":"Nome do Grupo de Cobrança. Consulta aceita busca parcial para esse parâmetro.","required":false,"schema":{"type":"string"}},{"name":"customerInscription","in":"query","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos<br>CPF: 11 digitos. Consulta aceita busca parcial para esse parâmetro.","required":false,"schema":{"type":"string"}},{"name":"luc","in":"query","description":"Código da Luc (Alias). Aceita busca parcial.","required":false,"schema":{"type":"string"}},{"name":"shoppingIds","in":"query","description":"Lista de Ids do Shopping na federação","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"page","in":"query","description":"Número da pagina corrente do resultado. Valor default 1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Quantidade de registros por pagina corrente. Valor default 20.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Nomes dos atributos que serão usados para ordenar a lista, separados por vírgula, cada um com um possível unário negativo para indicar ordem descendente. Ex. sort=groupName ou sort=-groupName indicando ordenação decrescente.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de Grupos de Cobranças","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingGroupPageResponse"}}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["BillingGroup"],"summary":"Cria um Grupo de Cobrança.","description":"Cria um grupo de cobrança.<br>-  Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa. <br>- Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança e deverá ser registrada data/hora da inclusão.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupRequest"}}},"description":"Grupo de cobrança a ser associado"},"responses":{"201":{"description":"Grupo de cobrança criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupResponse"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/billinggroup/{bgroupId}":{"get":{"tags":["BillingGroup"],"summary":"Consulta um Grupo de Cobrança","description":"Retorna um grupos de cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.<br>Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança.<br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"bgroupId","in":"path","description":"id do Grupo de Cobrança","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Grupos de Cobrança","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroup"}}}},"400":{"description":"Requisição Inválida."},"404":{"description":"Dado não encontrado."},"500":{"description":"Erro Interno."}}},"put":{"tags":["BillingGroup"],"summary":"Atualiza Grupo de Cobrança","description":"Atualiza somente o nome do cobrança. <br>- Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa. <br>- Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança e deverá ser registrada data/hora da inclusão.","parameters":[{"name":"bgroupId","in":"path","description":"id do Grupo de Cobrança","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Grupo de cobrança a ser associado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupRequest"}}}},"responses":{"200":{"description":"Grupo de cobrança alterado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupResponse"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado para atualização.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["BillingGroup"],"summary":"Remove o Grupo de Cobrança","description":"Exclui o Grupo de Cobrança e todos os seus relacionamentos com o cliente (cnpjCpf completo) e lucs. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.","parameters":[{"name":"bgroupId","in":"path","description":"Id de grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Grupo de Cobrança removido."},"404":{"description":"Dado não encontrado para remoção."}}}},"/billing-account-associations/billinggroup/billinggroupcustomer":{"post":{"tags":["BillingGroupCustomer"],"summary":"Cria a associação de um cliente a um Grupo de Cobrança.","description":"Cria a associação de um cliente a um Grupo de Cobrança.<br>-  Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa. <br>- Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança e deverá ser registrada data/hora da inclusão.","parameters":[{"name":"bgroupId","in":"query","description":"Id de grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerRequest"}}},"description":"Cliente a ser associado"},"responses":{"201":{"description":"Cliente associado ao Grupo de cobrança.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerResponse"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/billinggroup/billinggroupcustomer/{bgroupCustId}":{"get":{"tags":["BillingGroupCustomer"],"summary":"Retorna um cliente (CNPJ ou CPF) de um Grupo de Cobrança","description":"Retorna o cliente (CNPJ ou CPF) de um Grupo de Cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.<br>Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança.<br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"bgroupCustId","in":"path","description":"Id do cliente (cnpjCpf completo) associado ao grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Cliente associado ao Grupo de cobrança","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerResponse"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["BillingGroupCustomer"],"summary":"Altera o CNPJ ou CPF de uma associação ja existente de um cliente a um Grupo de Cobrança.","description":"Altera o CNPJ ou CPF de uma associação ja existente de um cliente a um Grupo de Cobrança.<br>-  Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa. <br>- Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança e deverá ser registrada data/hora da inclusão.","parameters":[{"name":"bgroupCustId","in":"path","description":"Id do cliente (cnpjCpf completo) associado ao grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerRequest"}}},"description":"Cliente a ser associado"},"responses":{"201":{"description":"Cliente associado ao Grupo de cobrança","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerResponse"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["BillingGroupCustomer"],"summary":"Exclui o cliente (cnpjCpf completo) e suas lucs de dentro do grupo de cobrança.","description":"Exclui o cliente (cnpjCpf completo) e suas lucs de dentro do grupo de cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.","parameters":[{"name":"bgroupCustId","in":"path","description":"Id do cliente (cnpjCpf completo) associado ao grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Cliente (cnpjCpf completo) removido do grupo."},"404":{"description":"Dado não encontrado para remoção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/billinggroup/billinggroupcustomer/billinggroupcustomerluc":{"post":{"tags":["BillingGroupCustomerLuc"],"summary":"Adiciona a LUC de um cliente no Grupo de Cobrança.","description":"Adiciona a LUC de um cliente no Grupo de Cobrança, juntamente com a identificação do shopping que se encontra esta LUC.<br>Usar a API de shopping para buscar o id do mesmo.<br>-  Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa. <br>- Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança e deverá ser registrada data/hora da inclusão.","parameters":[{"name":"bgroupCustId","in":"query","description":"Id do cliente na associação do grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerLucRequest"}}},"description":"Luc a ser adicionada ao grupo de cobrança."},"responses":{"201":{"description":"Luc adicionada ao grupo de cobrança.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerLuc"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/billing-account-associations/billinggroup/billinggroupcustomer/billinggroupcustomerluc/{bgroupCustLucId}":{"get":{"tags":["BillingGroupCustomerLuc"],"summary":"Retorna um luc e id de shopping associado ao um cliente de um grupo de cobrança.","description":"Retorna um luc e id de shopping associado ao um cliente de um grupo de cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.<br>Um CLIENTE/CNPJ somente poderá estar associado a um único Grupo de Cobrança.<br>**É necessário buscar por pelo menos um parâmetro.**","parameters":[{"name":"bgroupCustLucId","in":"path","description":"Id da luc associado ao cliendo do grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Luc e shopping do cliente do grupo de cobrança","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerLuc"}}}},"400":{"description":"Requisição Inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Dado não encontrado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Erro Interno.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["BillingGroupCustomerLuc"],"summary":"Altera a luc ou id de shopping associado ao cliente de um grupo de cobrança.","description":"Altera a luc ou id de shopping associado ao cliente de um grupo de cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.","parameters":[{"name":"bgroupCustLucId","in":"path","description":"Id da luc associado ao cliendo do grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerLucRequest"}}},"description":"Luc ou shopping a ser alterado no cliente do grupo de cobrança"},"responses":{"201":{"description":"Dados alterados com sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroupCustomerLuc"}}}},"409":{"description":"Conflito de cadastro. Grupo ja existente, ou Cliente ou Luc já associados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"400":{"description":"Objeto inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["BillingGroupCustomerLuc"],"summary":"Exclui a luc do cliente (cnpjCpf completo) associado a um grupo de cobrança.","description":"Exclui a luc do cliente (cnpjCpf completo) associado a um grupo de cobrança. <br>Grupo de Cobrança é um conceito utilizado pela área de recuperação de crédito da brMalls para definir um grupo de clientes que são cobrados de forma corporativa.","parameters":[{"name":"bgroupCustLucId","in":"path","description":"Id da luc associado ao grupo de cobrança.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Luc removida do cliente para o grupo de cobrança."},"404":{"description":"Dado não encontrado para remoção.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"CustomerAccountResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAccount"}}}},"CustomerAccountLineResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAccountLine"}}}},"CustomerAcctBusinessPurposeResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAcctBusinessPurpose"}}}},"LucCustomerResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LucCustomer"}}}},"CustomerAccount":{"type":"object","properties":{"custAccountId":{"type":"integer","format":"int64","description":"Id da conta do cliente. Tambem chamado de Id do cliente.","example":7577},"partyId":{"type":"integer","format":"int64","description":"Id do cabeçalho do cliente.","example":7577},"status":{"type":"string","enum":["A","I"],"example":"A","description":"Status de Ativo (A) ou Inativo (I)"},"accountNumber":{"type":"string","description":"Número da conta do cliente (raiz do CNPJ ou CPF)","example":"33041260"},"establishedDate":{"type":"string","format":"date"}}},"CustomerAccountLine":{"type":"object","properties":{"custAcctSiteId":{"type":"integer","format":"int64","description":"Id da Linha da conta do cliente. Atributo com restrição de unicidade na lista de linhas da conta do cliente.","example":2590574},"custAccountId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7577},"partySiteId":{"type":"integer","format":"int64","description":"Id da Linha (filial) do cliente.","example":2590574},"tipoInscricao":{"type":"string","description":"Tipo da Inscrição. 1=CPF ou 2=CNPJ.","example":"2"},"raizInscricao":{"type":"string","description":"Raiz do CNPJ ou CPF.<br> O tamanho da raiz de um CPNJ é de 8 digitos e do CPF 9 digitos. <BR>No EBS essa informação, somente para CNPJ está prefixada com digito 0, devido a uma regra de limite de tamanho de campo na tela do EBS. ","example":"75364570"},"filialInscricao":{"type":"string","description":"Filial da inscriacao para quando for do tipo CNPJ.","example":"0001"},"digitoInscricao":{"type":"string","description":"Digito verificador do CNPJ ou CPF.","example":"60"},"status":{"type":"string","description":"Status de Ativo (A) ou Inativo (I)","enum":["A","I"]},"companyId":{"type":"integer","format":"int64","description":"Id de organizações de um shopping.","example":106}}},"CustomerAcctBusinessPurpose":{"type":"object","properties":{"siteUseId:":{"type":"integer","format":"int64","description":"Id do objetivo comercial da conta do cliente. Atributo com restrição de unicidade na lista de objetivos comerciais da linha da conta do cliente.","example":2590574},"custAcctSiteId":{"type":"integer","format":"int64","description":"Id da linha da conta do cliente.","example":7577},"siteUseCode":{"type":"string","description":"Codigo do objetivo comercial da linha da conta do cliente.","example":"BILL_TO"},"status":{"type":"string","description":"Status de Ativo (A) ou Inativo (I)","enum":["A","I"]},"locationAlias":{"type":"string","description":"Código da LUC (Alias) da linha da conta do cliente.","example":"SNS00710"},"companyId":{"type":"integer","format":"int64","description":"Id da organizacao de um shopping.","example":106}}},"LucCustomer":{"type":"object","properties":{"luc":{"type":"string","description":"Codigo da Luc (Alias).","example":"SNS1234"},"companyId":{"type":"integer","format":"int64","description":"Id da Organização de um shopping.","example":7577},"custAccountId":{"type":"integer","format":"int64","description":"Id da conta do cliente.","example":7577},"custAcctSiteId":{"type":"integer","format":"int64","description":"Id da linha da conta do cliente.","example":7577},"partySiteId":{"type":"integer","format":"int64","description":"Id da Linha (filial) do cliente.","example":2590574},"custSiteUseId":{"type":"integer","format":"int64","description":"Id do objetivo comercial da conta do cliente.","example":2590574},"statusCustAcctBusinessPurpose":{"type":"string","description":"Status de Ativo (A) ou Inativo (I)","enum":["A","I"]}}},"BillingGroupPageResponse":{"type":"object","properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BillingGroup"}}}},"BillingGroup":{"type":"object","properties":{"bgroupId":{"type":"integer","format":"int64","description":"Id do grupo de cobrança","example":1},"groupName":{"type":"string","description":"Nome do grupo de cobrança","example":"VIA VAREJO"},"creationDate":{"type":"string","description":"Data de criação no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"updateDate":{"type":"string","description":"Data de atualização no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"billingGroupCustomers":{"type":"array","description":"Lista de CNPJ ou CPF completos de um cliente","items":{"$ref":"#/components/schemas/BillingGroupCustomer"}}}},"BillingGroupResponse":{"type":"object","properties":{"bgroupId":{"type":"integer","format":"int64","description":"Id do grupo de cobrança","example":1},"groupName":{"type":"string","description":"Nome do grupo de cobrança","example":"VIA VAREJO"},"creationDate":{"type":"string","description":"Data de criação no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"updateDate":{"type":"string","description":"Data de atualização no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"}}},"BillingGroupCustomer":{"type":"object","properties":{"bgroupCustId":{"type":"integer","format":"int64","description":"Id do relacionamento entre grupo de cobrança e cliente.","example":1},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos<br>CPF: 11 digitos.","example":"30535579000158"},"creationDate":{"type":"string","description":"Data de criação no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"updateDate":{"type":"string","description":"Data de atualização no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"billingGroupCustomerLucs":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/BillingGroupCustomerLuc"}}}},"BillingGroupCustomerResponse":{"type":"object","properties":{"bgroupCustId":{"type":"integer","format":"int64","description":"Id do relacionamento entre grupo de cobrança e cliente.","example":1},"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos<br>CPF: 11 digitos.","example":"30535579000158"},"creationDate":{"type":"string","description":"Data de criação no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"updateDate":{"type":"string","description":"Data de atualização no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"}}},"BillingGroupCustomerLuc":{"type":"object","description":"Registro da associação da Luc ao cliente","properties":{"bgroupCustLucId":{"type":"integer","description":"Id do relaciomento entre grupo, cliente e luc.","example":1},"luc":{"type":"string","description":"Codigo da Luc (Alias)","example":"SNS1234"},"shoppingId":{"type":"integer","format":"int64","description":"Id do Shopping","example":1},"creationDate":{"type":"string","description":"Data de criação no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"},"updateDate":{"type":"string","description":"Data de atualização no formato AAAA-MM-DD hh:mm:ss","format":"datetime","example":"2020-12-30 13:00:00"}}},"BillingGroupRequest":{"type":"object","properties":{"groupName":{"type":"string","description":"Nome do grupo de cobrança","example":"VIA VAREJO"}}},"BillingGroupCustomerRequest":{"type":"object","properties":{"customerInscription":{"type":"string","description":"CNPJ ou CPF completos de um cliente sem formatação.<br>CPNJ: 14 digitos<br>CPF: 11 digitos.","example":"30535579000158"}}},"BillingGroupCustomerLucRequest":{"type":"object","description":"Registro da associação da Luc ao cliente","properties":{"luc":{"type":"string","description":"Codigo da Luc (Alias)","example":"SNS1234"},"shoppingId":{"type":"integer","format":"int64","description":"Id do Shopping","example":1}}},"PageInfo":{"type":"object","properties":{"totalItems":{"description":"Total de itens","type":"integer","format":"int64","example":250},"currentPage":{"description":"Número da página corrente","type":"integer","format":"int64","example":1},"pageSize":{"type":"integer","format":"int64","example":20},"sort":{"description":"Ordenação usada de acordo com o parametro sort","type":"string","example":"companyName"}}},"Error":{"title":"Error","type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"message":{"type":"string"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://services.brmalls.com.br/token","scopes":{}}}}}},"security":[{"oauth2":[]}]}