---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# FinancialsWidgetUtil - com escopo

# FinancialsWidgetUtil - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 min. de leitura

A inclusão de script FinancialsWidgetUtil fornece métodos para personalizar widgets na seção Finanças de Espaço do projeto e Planejamento estratégico Espaço.  
Os widgets a seguir estão disponíveis em Espaço do projeto e Planejamento estratégico Espaço por padrão.

* Orçamento
* Estimativa na Conclusão
* Custo planejado
* Custo real até o momento

{#FinancialsWidgetUtilScopedAPI__ul_hdz_bxw_21c}Você pode usar a inclusão de script FinancialsWidgetUtil para adicionar widgets secundários que mostram valores para um período ou tipo de despesa especificado.  
Figura 1. Seção Finanças em Espaço do projeto

Neste exemplo de Espaço do projeto, o widget Custo planejado tem widgets secundários que mostram valores CapEx e OpEx, enquanto o widget Orçamento não tem widgets secundários.

Para usar esta inclusão de script, [crie um widget secundário](https://www.servicenow.com/docs/access?context=configure-widget-project-financials&version=xanadu&pubname=xanadu-it-business-management&ft:locale=en-US) com um dos widgets financeiros disponíveis como primário. Use os métodos desta inclusão de script no campo Script do registro do widget secundário.

A inclusão de script FinancialsWidgetUtil requer a aplicação Financials Core (sn_invst_pln), bem como a aplicação Planejamento estratégico (sn_apw_advanced) ou Espaço do projeto (sn_pw). Esta inclusão de script é fornecida no namespace `sn_invst_pln`.

## FinancialsWidgetUtil - FinancialsWidgetUtil(GlideRecord InvestmentGr, objeto timeScope, cadeia de caracteres ExpenseType) {#ariaid-title2}

Instancia um objeto FinancialsWidgetUtil.
Este objeto é usado para obter valores agregados, como orçamento e custo planejado para um investimento.
{#FinWU-FinancialsWidgetUtil_O_O_S__table_f1z_33y_yzb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| investimentoGr | [GlideRecord](https://servicenow-prod.fluidtopics.net/FBR_zQLvGAsgQtw7~4MAGA#c_GlideRecordScopedAPI "A API GlideRecord com escopo é usada para operações de banco de dados.") | Investimento para obter valores agregados para. Localizado na tabela Investimento \[sn_invst_pln_invst_investment\]. |
| timeScope | Objeto | Objeto que contém os períodos fiscais a serem usados como datas de início e término da agregação. { "startFiscalPeriodSysId": "String", "endFiscalPeriodSysId": "String" } |
| timeScope.startFiscalPeriodSysId | Cadeia de caracteres | Sys_id do período fiscal a ser usado como data de início para a agregação. Localizado na tabela Período fiscal \[fiscal_period\]. |
| timeScope.endFiscalPeriodSysId | Cadeia de caracteres | Sys_id do período fiscal a ser usado como data de término para a agregação. Localizado na tabela Período fiscal \[fiscal_period\]. |
| Tipo de despesa | Cadeia de caracteres | Opcional. Tipo de despesa a ser incluída na agregação, como despesa de capital (CapEx) ou despesa operacional (OpEx). Valores válidos: * CAPEX * opex {#FinWU-FinancialsWidgetUtil_O_O_S__ul_cbz_s3z_yzb} |
[Tabela 1. Parâmetros]

{#FinWU-FinancialsWidgetUtil_O_O_S__table_f1z_33y_yzb}  
Este exemplo instancia um objeto FinancialsWidgetUtil que pode ser usado para retornar valores agregados para um investimento em que o tipo de despesa é CapEx e o período é `context.timeScope`.

    var context = JSON.parse(context);
    var investment = context.investment;
    (function initializeFWU() {
       var invGr = new GlideRecord('sn_invst_pln_invst_investment');
       if (invGr.get(investment.sys_id)) {
          var capexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'capex');
       }
    })();

## FinancialsWidgetUtil -- getActuals() {#ariaid-title3}

Retorna o custo real de todos os itens de planejamento e itens de trabalho vinculados a um investimento.
Para usar este método, [crie um widget secundário](https://www.servicenow.com/docs/access?context=configure-widget-project-financials&version=xanadu&pubname=xanadu-it-business-management&ft:locale=en-US) com o widget Custo real até o momento como primário. Use este método no campo Script do registro do widget secundário.

O custo real retornado por este método é para o período de tempo e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.
{#FinancialsWidgetUtil-getActuals__table_blj_t3y_yzb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 2. Parâmetros]

{#FinancialsWidgetUtil-getActuals__table_blj_t3y_yzb} {#FinancialsWidgetUtil-getActuals__table_xwh_m3y_yzb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém o valor de exibição e o valor do custo real. { "displayValue": "String", "value": Number } |
| \<Object\>.displayValue | Valor de exibição do custo real, como `US$ 1,00 K`. Tipo de dados: cadeia de caracteres |
| \<Object\>.valor | Valor do custo real, como `1000`. Tipo de dados: número |
[Tabela 3. Retorna]

{#FinancialsWidgetUtil-getActuals__table_xwh_m3y_yzb}  
Este exemplo adiciona um widget secundário ao widget Custo real até o momento que mostra o custo real somente para OpEx.

    var context = JSON.parse(context);
    var investment = context.investment;
    (function getCost() {
       var invGr = new GlideRecord('sn_invst_pln_invst_investment');
       if (invGr.get(investment.sys_id)) {
          var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getActuals();
          return {
             displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
             value: opexCost.value
          };
       }
    })();

## FinancialsWidgetUtil - getBudget() {#ariaid-title4}

Retorna o orçamento de todos os itens de planejamento e itens de trabalho vinculados a um investimento.
Para usar este método, [crie um widget secundário](https://www.servicenow.com/docs/access?context=configure-widget-project-financials&version=xanadu&pubname=xanadu-it-business-management&ft:locale=en-US) com o widget Orçamento como primário. Use este método no campo Script do registro do widget secundário.

O orçamento retornado por este método é para o período de tempo e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.
{#FinancialsWidgetUtil-getBudget__table_wwh_m3y_yzb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 4. Parâmetros]

{#FinancialsWidgetUtil-getBudget__table_wwh_m3y_yzb} {#FinancialsWidgetUtil-getBudget__table_xwh_m3y_yzb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém o valor de exibição e o valor do orçamento. { "displayValue": "String", "value": Number } |
| \<Object\>.displayValue | Valor de exibição do orçamento, como `$ 2,50 K`. Tipo de dados: cadeia de caracteres |
| \<Object\>.valor | Valor do orçamento, como `2500`. Tipo de dados: número |
[Tabela 5. Retorna]

{#FinancialsWidgetUtil-getBudget__table_xwh_m3y_yzb}  
Este exemplo adiciona um widget secundário ao widget Orçamento que mostra o orçamento somente para OpEx.

    var context = JSON.parse(context);
    var investment = context.investment;
    (function getCost() {
       var invGr = new GlideRecord('sn_invst_pln_invst_investment');
       if (invGr.get(investment.sys_id)) {
          var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getBudget();
          return {
             displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
             value: opexCost.value
          };
       }
    })();

## FinancialsWidgetUtil -- getEAC() {#ariaid-title5}

Retorna o valor da estimativa na conclusão (EAC) para todos os itens de planejamento e itens de trabalho vinculados a um investimento.
Para usar este método, [crie um widget secundário](https://www.servicenow.com/docs/access?context=configure-widget-project-financials&version=xanadu&pubname=xanadu-it-business-management&ft:locale=en-US) com o widget Estimativa na conclusão como primário. Use este método no campo Script do registro do widget secundário.

O valor de EAC retornado por este método é para o período de tempo e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.
{#FinancialsWidgetUtil-getEAC__table_gbs_43y_yzb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 6. Parâmetros]

{#FinancialsWidgetUtil-getEAC__table_gbs_43y_yzb} {#FinancialsWidgetUtil-getEAC__table_xwh_m3y_yzb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém o valor de exibição e o valor do EAC. { "displayValue": "String", "value": Number } |
| \<Object\>.displayValue | Valor de exibição do EAC, como `$ 2,38 K`. Tipo de dados: cadeia de caracteres |
| \<Object\>.valor | Valor do EAC, como `2380`. Tipo de dados: número |
[Tabela 7. Retorna]

{#FinancialsWidgetUtil-getEAC__table_xwh_m3y_yzb}  
Este exemplo adiciona um widget secundário ao widget Estimar na conclusão que mostra o EAC somente para OpEx.

    var context = JSON.parse(context);
    var investment = context.investment;
    (function getCost() {
       var invGr = new GlideRecord('sn_invst_pln_invst_investment');
       if (invGr.get(investment.sys_id)) {
          var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getEAC();
          return {
             displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
             value: opexCost.value
          };
       }
    })();

## FinancialsWidgetUtil -- getPlannedCost() {#ariaid-title6}

Retorna o custo planejado para todos os itens de planejamento e itens de trabalho vinculados a um investimento.
Para usar este método, [crie um widget secundário](https://www.servicenow.com/docs/access?context=configure-widget-project-financials&version=xanadu&pubname=xanadu-it-business-management&ft:locale=en-US) com o widget Custo planejado como primário. Use este método no campo Script do registro do widget secundário.

O custo planejado retornado por este método é para o período de tempo e o tipo de despesa especificados ao instanciar o objeto FinancialsWidgetUtil.
{#FinancialsWidgetUtil-getPlannedCost__table_jzp_q3y_yzb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 8. Parâmetros]

{#FinancialsWidgetUtil-getPlannedCost__table_jzp_q3y_yzb} {#FinancialsWidgetUtil-getPlannedCost__table_xwh_m3y_yzb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto que contém o valor de exibição e o valor do custo planejado. { "displayValue": "String", "value": Number } |
| \<Object\>.displayValue | Valor de exibição do custo planejado, como `US$ 4,05 mil`. Tipo de dados: cadeia de caracteres |
| \<Object\>.valor | Valor do custo planejado, como `4050`. Tipo de dados: número |
[Tabela 9. Retorna]

{#FinancialsWidgetUtil-getPlannedCost__table_xwh_m3y_yzb}  
Este exemplo adiciona um widget secundário ao widget Custo planejado que mostra o custo planejado somente para OpEx.

    var context = JSON.parse(context);
    var investment = context.investment;
    (function getCost() {
       var invGr = new GlideRecord('sn_invst_pln_invst_investment');
       if (invGr.get(investment.sys_id)) {
          var opexCost = new sn_invst_pln.FinancialsWidgetUtil(invGr, context.timeScope, 'opex').getPlannedCost();
          return {
             displayValue: PPMCurrencyHelper.getFormattedAmountWithCurrency(opexCost.value),
             value: opexCost.value
          };
       }
    })();