Razão Geral do FENXT blackbaud (versão prévia)
O Blackbaud Financial Edge NXT é uma solução abrangente de software contábil baseada em nuvem criada especificamente para organizações sem fins lucrativos. Use o conector do Razão Geral para gerenciar o razão geral e as entidades relacionadas encontradas no NXT do Financial Edge.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Blackbaud |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Publicador | Blackbaud, Inc. |
| Site | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| Política de privacidade | https://www.blackbaud.com/privacy-shield |
| Categorias | Vendas e CRM; Produtividade |
O Financial Edge NXT é uma solução abrangente de software contábil baseada em nuvem criada especificamente para organizações sem fins lucrativos.
Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar o razão geral e as entidades relacionadas encontradas no NXT do Financial Edge.
Para obter mais informações, veja a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta de ID do Blackbaud com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação no nível do administrador dentro do sistema para permitir que esse conector acesse seu ambiente blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de instalação inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente do Financial Edge NXT da organização e configurará suas permissões de conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas e limitações conhecidos
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às permissões do usuário dentro do ambiente.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um lote de entrada de diário |
Atualiza um lote de entrada de diário. |
| Criar um anexo de lote de entrada de diário |
Cria um novo anexo de lote de entrada de diário. |
| Criar um lote de entrada de diário |
Cria um novo lote de entrada de diário. |
| Criar uma entrada de diário (distribuição única) |
Cria uma nova entrada de diário com uma única distribuição. |
| Criar uma entrada de diário (distribuições divididas) |
Cria uma nova entrada de diário com distribuições divididas. |
| Excluir um lote de entrada de diário |
Exclui um lote de entrada de diário. |
| Limpar entradas de diário |
Remova todas as entradas de diário do lote especificado. |
| Listar entradas de diário |
Retorna uma lista de entradas de diário para um lote de entrada de diário especificado. |
| Listar lotes de entrada de diário |
Lista os lotes de entrada de diário disponíveis. |
| Obter um resumo do lote de entrada de diário |
Retorna o resumo do lote de entrada do diário. |
| Postar um lote de entrada de diário |
Posta um lote de entrada de diário. |
| Validar um lote de entrada de diário |
Valida um lote de entrada de diário. |
Atualizar um lote de entrada de diário
Atualiza um lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário a ser atualizado. |
|
Description
|
description | string |
A descrição do lote de entrada do diário. Limite de caracteres: 60. |
|
|
Situação
|
batch_status | string |
O status do lote de entrada do diário. |
|
|
Criar ajustes?
|
create_bank_account_adjustments | boolean |
Criar ajustes bancários ao postar em uma conta bancária? |
|
|
Adicionar entradas de interfinanciamento?
|
create_interfund_sets | boolean |
Criar entradas de interfinanciamento quando o lote é postado? |
|
|
Nome do sistema de origem
|
source_system_name | string |
Nome do sistema de origem que criou o lote. |
|
|
URL base de origem
|
source_base_url | string |
URL base para o sistema de origem que criou o lote. |
Retornos
Lote de entrada de diário criado
Criar um anexo de lote de entrada de diário
Cria um novo anexo de lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
parent_id | True | integer |
A ID do registro do sistema do lote de entrada do diário que contém o anexo. |
|
Tipo
|
type | True | string |
O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | True | string |
O nome do anexo. Limite de caracteres: 150. |
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e ignorado para anexos físicos. |
|
|
Conteúdo do arquivo
|
file | binary |
O conteúdo binário do anexo de arquivo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
|
|
Nome do arquivo
|
file_name | string |
O nome do arquivo para o anexo. Isso é necessário para anexos físicos e ignorado para anexos de link. |
|
|
Tipo de anexo
|
media_type | True | string |
Categoria definida pelo usuário deste anexo. Os valores disponíveis são as entradas na tabela Tipo de Mídia para o registro pai. Usar os tipos de valor definidos em /mediaTypes |
Retornos
Anexo em lote de entrada de diário criado
Criar um lote de entrada de diário
Cria um novo lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Description
|
description | True | string |
A descrição do lote de entrada do diário. Limite de caracteres: 60. |
|
Situação
|
batch_status | True | string |
O status do lote de entrada do diário. |
|
Criar ajustes?
|
create_bank_account_adjustments | boolean |
Criar ajustes bancários ao postar em uma conta bancária? |
|
|
Adicionar entradas de interfinanciamento?
|
create_interfund_sets | boolean |
Criar entradas de interfinanciamento quando o lote é postado? |
|
|
Nome do sistema de origem
|
source_system_name | string |
Nome do sistema de origem que criou o lote. |
|
|
URL base de origem
|
source_base_url | string |
URL base para o sistema de origem que criou o lote. |
Retornos
Lote de entrada de diário criado
Criar uma entrada de diário (distribuição única)
Cria uma nova entrada de diário com uma única distribuição.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
|
body
|
body | True | dynamic |
A entrada do diário a ser criada. |
Criar uma entrada de diário (distribuições divididas)
Cria uma nova entrada de diário com distribuições divididas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
|
body
|
body | True | dynamic |
A entrada do diário a ser criada. |
Excluir um lote de entrada de diário
Exclui um lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário a ser excluído. |
Limpar entradas de diário
Remova todas as entradas de diário do lote especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário a ser desmarcada. |
Listar entradas de diário
Retorna uma lista de entradas de diário para um lote de entrada de diário especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Listar lotes de entrada de diário
Lista os lotes de entrada de diário disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
status | string |
O status do lote. |
|
|
Pesquisar texto
|
search_text | string |
Pesquisar texto para corresponder à ID ou descrição do lote de entrada de diário. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 100. O máximo é 500. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtre os resultados para lotes de entrada de diário modificados na data especificada ou após a data especificada. |
Retornos
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
Obter um resumo do lote de entrada de diário
Retorna o resumo do lote de entrada do diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
Retornos
Resumo do lote de entrada de diário.
Postar um lote de entrada de diário
Posta um lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
Retornos
Resultado da validação
- Corpo
- GLApi.ValidationResult
Validar um lote de entrada de diário
Valida um lote de entrada de diário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Lote
|
batch_id | True | integer |
A ID do registro do sistema do lote de entrada do diário. |
Retornos
Resultado da validação
- Corpo
- GLApi.ValidationResult
Definições
GLApi.CreatedJournalEntryBatch
Lote de entrada de diário criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do lote de entrada de diário recém-criado. |
GLApi.CreatedJournalEntryBatchAttachment
Anexo em lote de entrada de diário criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do lote de entrada de diário recém-criado. |
GLApi.JournalEntry
Entrada de diário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de entrada do diário
|
journal_entry_id | integer |
O identificador de entrada do diário. |
GLApi.JournalEntryBatch
Lote de entrada de diário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Lote
|
batch_id | integer |
A ID do registro do sistema para o lote. |
|
ID do lote da interface do usuário
|
ui_batch_id | string |
O identificador definido pelo usuário para o lote. |
|
Description
|
description | string |
A descrição do lote de entrada do diário. |
|
Situação
|
batch_status | string |
O status do lote de entrada do diário. |
|
Criar ajustes?
|
create_bank_account_adjustments | boolean |
Criar ajustes bancários ao postar em uma conta bancária? |
|
Adicionar entradas de interfinanciamento?
|
create_interfund_sets | boolean |
Criar entradas de interfinanciamento quando o lote é postado? |
|
Nome do sistema de origem
|
source_system_name | string |
Nome do sistema de origem que criou o lote. |
|
URL base de origem
|
source_base_url | string |
URL base para o sistema de origem que criou o lote. |
|
Data de inclusão
|
date_added | date-time |
A data em que o lote foi criado. |
|
Adicionado por
|
added_by | string |
O nome do usuário que criou o lote. |
|
Data modificada
|
date_modified | date-time |
A data em que o lote foi modificado pela última vez. |
|
Modificado por
|
modified_by | string |
O nome do usuário que modificou o lote pela última vez. |
GLApi.JournalEntryBatchCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of GLApi.JournalEntryBatch |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
GLApi.JournalEntryBatchSummary
Resumo do lote de entrada de diário.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Lote
|
BatchId | integer |
A ID do registro do sistema para o lote. |
|
ID do lote da interface do usuário
|
UiBatchId | string |
O identificador definido pelo usuário para o lote. |
|
Description
|
Description | string |
A descrição do lote de entrada do diário. |
|
Situação
|
BatchStatus | string |
O status do lote de entrada do diário. |
|
Criar ajustes?
|
CreateBankAccountAdjustments | boolean |
Criar ajustes bancários ao postar em uma conta bancária? |
|
Adicionar entradas de interfinanciamento?
|
CreateInterfundSets | boolean |
Criar entradas de interfinanciamento quando o lote é postado? |
|
Total de créditos
|
TotalCredits | double |
Total de créditos no lote de entrada do diário. |
|
Total de débitos
|
TotalDebits | double |
Total de débitos no lote de entrada do diário. |
|
URL base de origem
|
SourceBaseUrl | string |
URL base para o sistema de origem em lote. |
|
Nome do sistema de origem
|
SourceSystemName | string |
Nome do sistema de origem que criou o lote. |
|
Data de inclusão
|
DateAdded | date-time |
A data em que o lote de entrada do diário foi criado. |
|
Adicionado por
|
AddedBy | string |
O nome do usuário que criou o lote de entrada do diário. |
|
Data modificada
|
DateModified | date-time |
A data em que o lote de entrada do diário foi modificado pela última vez. |
|
Modificado por
|
ModifiedBy | string |
O nome do usuário que modificou pela última vez o lote de entrada do diário. |
GLApi.JournalEntryCollection
Buscar dados de uma só vez torna-se rapidamente incontrolável. A entidade de coleção ajuda retornando partes paginadas de grandes conjuntos de dados. Essa entidade inclui metadados e propriedades úteis para paginar e iterar por meio dos dados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. |
|
value
|
value | array of GLApi.JournalEntry |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
GLApi.ValidationResult
Resultado da validação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
É válido?
|
is_valid | boolean |
O lote é válido? |
|
Errors
|
errors | array of string |
A lista de erros recebidos durante a validação. |