updateAccounts
Supportato nell'API v20 +
Categoria | Modifica dei metadati |
Descrizione | Aggiornare un insieme di conti CoGe esistenti o creare nuovi conti CoGe. È possibile aggiornare più conti con più valori in un'unica chiamata. In caso di esito positivo, l'API restituisce i dettagli per i conti che sono stati aggiornati/creati. Se l'API non riesce, viene restituito un elenco completo degli errori e delle relative cause. |
Autorizzazioni necessarie per richiamare | Modello e autorizzazioni a ogni livello |
Parametri obbligatori su richiesta | Credenziali |
La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. L'utente deve avere il "Modello" Concetto: Set di autorizzazioni e l'autorizzazione richiesta per amministrare i conti in aggiornamento.
Best practice: richiamare exportAccounts per recuperare il file
Adaptive Planning
ID conto necessari per la richiesta updateAccounts. Fare del proprio meglio per ridurre al minimo il tempo tra le chiamate exportAccounts e le richieste updateAccount.HTTP | Descrizione |
|---|---|
Method | Post |
Content-Type | text/xml |
Esempio di arricciatura
curl -H "Content-Type: text/xml" -d @C:/temp/updateAccounts.xml -X POST https://api.adaptiveplanning.com/api/v20
updateAccounts.xml
Formato richiesta
<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <accounts proceedWithWarnings="0"> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="1" exchangeRateType="E" isIntercompany="0" planBy="DELTA" timeRollup="LAST" hasSalaryDetail="0" dataPrivacy="PRIVATE" subType="CUMULATIVE" enableActuals="1" propagateToDescendants="1"> <attribute name="SEC Reporting" value="Yes" /> <attribute name="GAAP Reporting" value="No" /> </account> </account> </accounts> </call>
Per i payload di grandi dimensioni, è possibile pubblicare file XML compressi (compressi). Scopri come fare qui.
Per updateAccounts si applicano le seguenti condizioni:
- I conti vengono identificati per l'aggiornamento tramite il loro numero ID interno.
- Per creare nuovi conti, assegnare loro una proprietà ID vuota o mancante.
- È possibile spostare un elemento esistente (non nuovo) in modo che diventi figlio di un nuovo elemento. In questo modo si crea il nuovo elemento e si sposta l'elemento esistente sotto di esso come figlio.
- Per API v31 e successive, è possibile creare un nuovo conto padre tra un conto padre esistente e i relativi conti figlio.
Conti di nuova genitorialità
- updateAccountserrori se il valore dell'attributo per un figlio non è compatibile con il nuovo attributo padre. Esempio: l'attributo reparentedAccount1 ha il valore SEC Reporting=No e non è compatibile perché newParentAccount2 SEC Reporting value=Sì.
- updateAccountscorregge i valori degli attributi non compatibili in modo che corrispondano al nuovo padre durante la nuova assegnazione del padre quandoproceedWithWarnings=1.
- I conti di nuova genitorialità non possono formare una relazione ciclica.
- La ridefinizione del padre non è consentita per i conti radice generati dal sistema:Assets, Liabilities and Equities, Net Income, PL Income, Non-Operating Income, PL COGS, PL Expense, Non-Operating Expenses.
A seconda della versione dell'API,
updateAccounts
consente di creare un nuovo conto padre tra un conto padre esistente e i relativi conti figlio: Conto di origine | Spostato sotto | API v30 e precedenti | API v31 + |
|---|---|---|---|
radice | radice | impedito | impedito |
radice | padre | impedito | impedito |
radice | foglia | impedito | impedito |
padre | radice | consentito | consentito |
padre | padre | consentito | consentito |
padre | una foglia esistente come primo figlio | impedito | impedito |
padre | una foglia esistente come non primo figlio | consentito | consentito |
padre | un nuovo primo conto figlio di un padre esistente | impedito | consentito |
padre | un nuovo conto non primo, figlio di un padre esistente | consentito | consentito |
foglia | radice | consentito | consentito |
foglia | padre | consentito | consentito |
foglia | una foglia esistente come primo figlio | impedito | impedito |
foglia | una foglia esistente come non primo figlio | consentito | consentito |
foglia | un nuovo primo conto figlio di un padre esistente | impedito | consentito |
foglia | un nuovo conto non primo, figlio di un padre esistente | consentito | consentito |
foglia | un nuovo primo conto figlio di una foglia esistente | impedito | impedito |
foglia | un nuovo conto non primo, figlio di una foglia esistente | consentito | consentito |
Figli conti foglia
- Il primo figlio di un conto foglia può essere solo un nuovo conto. Un conto CoGe esistente non può essere spostato sotto un conto foglia esistente.
- Quando un conto ottiene il primo figlio durante la nuova parentela, la mappatura dei conti in Integrazione > Importa mappature conti viene eliminata.
- Quando si ridefiniscono i conti,balanceTypeesubTypele proprietà vengono ereditate dal conto CoGe padre.
Conti cubo e dati immessi nel cubo
- I conti inseriti nel cubo possono essere riassegnati al padre.
- Solo i conti senza dati inseriti nel cubo nelle sottostrutture di origine e di destinazione possono essere riassegnati.
- Non è possibile modificare il padre per i conti CUBE/MIXED ACCOUNT.
- Non sono consentiti nuovi conti con un CUBE ACCOUNT. Sono consentiti nuovi conti con un ACCOUNT STANDARD/MIXED.
Formato richiesta per la creazione di un nuovo conto
Per creare un nuovo conto, includerne il padre tramite l'ID. Ad esempio, per aggiungere un nuovo conto figlio al di sotto della L
ocalAssets
conto che ha id 1441
, è possibile utilizzare:<?xml version='1.0' encoding='UTF-8'?> <call method="updateAccounts" callerName="Steve C"> <credentials login="sampleuser@company.com" password="my_password"/> <accounts> <account id="1441"> <account id="" code="newLocalAssets" name="new Local Assets" description="new local assets account for this area" shortName="" > </account> </account> </accounts> </call>
Questo metodo non modifica nulla del conto
id 1441
. Crea un nuovo figlio denominato new Local Assets
per id 1441
. Tutti i figli non menzionati di LocalAssets
spostarsi alla fine dell'elenco figlio. Equivale a "impostare il padre" per il nuovo conto.Gestione di più rinominazioni in un'unica chiamata updateAccounts
In un sistema remoto possono essere eseguite più rinominazioni della stessa entità
updateAccounts
chiamate I nomi delle entità nel sistema remoto possono essere scambiati con gli stessi ID entità. Quando updateAccounts
le chiamate avvengono dopo lo scambio del nome, il updateAccounts
call gestisce queste modifiche monitorando gli ID delle modifiche al nome. La chiamata può anche gestire l'introduzione di un nuovo ID che utilizza un nome esistente.Affinché ciascuno degli esempi abbia esito positivo, è necessario che avvenga lo scambio completo degli ID con i valori univoci.
Esempio 1: un semplice scambio di nomi nel sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB AA
Esempio 2: una sequenza di tre rinominazioni nel sistema remoto.
ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA
Esempio 3: una nuova entità che utilizza un valore univoco esistente.
ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB
elemento credenziali | |||
Nome tag | credenziali | ||
Descrizione | Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
accedere | S | Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo. | sampleuser@company.com |
password | S | La password dell'utente che richiama il metodo API. | my_password |
impostazioni internazionali | N | Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano). | fr_FR |
instanceCode | N | Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning, questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances. | MYINSTANCE1 |
Contenuto dell'elemento | |||
(nessuno) | |||
elemento conti | |||
Nome tag | conti | ||
Descrizione | È consentita una sola richiesta di elemento conti per payload. Contiene uno o più elementi del conto. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
procedereWithWarnings | N | procedeWithWarnings="1" indica che l'API updateAccounts deve rettificare l'attributo e le proprietà del conto in base alle modifiche alla nuova parentela. procedeWithWarnings="0" indica che l'API updateAccounts non deve rettificare l'attributo e le proprietà del conto in base alle modifiche apportate alla nuova parentela. UpdateAccounts segnala gli errori con un messaggio che indica il motivo dell'errore. Ad esempio, la mappatura degli attributi non sarà più valida dopo la nuova creazione dei genitori. Il valore predefinito è 0 se mancante. | 1 |
retainExistingOrder Disponibile nell'API v26 + | N | retainExistingOrder="1" indica che l'API updateAccounts deve ignorare l'ordine degli elementi nel payload XML e l'ordine definito esistente verrà mantenuto. retainExistingOrder="0" indica che l'API updateAccounts deve aggiornare l'ordine degli elementi in base alla posizione del tag rispetto ad altri elementi di pari livello nel payload XML. L'attributo retainExistingOrder viene ignorato nelle versioni API precedenti all'API v26. Il valore predefinito per retainExistingOrder è "0" per la versione 26. Per le versioni API v27 e successive, il valore predefinito per retainExistingOrder è "1". | 1 |
displayNameEnabled
Disponibile solo nell'API v32+ per le istanze che abilitano il nome visualizzato. | N | displayNameEnabled=1 indica che updateAccounts deve rispettare le proprietà del nome visualizzato di code , displayNameType e description quando Abilita nome visualizzato è attivo per l'istanza.displayNameEnabled=0 indica che l'API updateAccounts deve continuare a seguire il contratto API precedente alla versione 32 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API updateAccounts ignora le proprietà del nome visualizzato code , displayNameType e description .Il valore predefinito per displayNameEnabled è "0". | 1 |
Contenuto dell'elemento | |||
Contiene uno o più elementi del conto. | |||
elemento conto | |||
Nome tag | account | ||
Descrizione | Specifica un conto da creare. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
ID | S | Il numero ID di sistema interno per il conto. | 16 |
codice
| N | Solo il codice del conto, i caratteri alfanumerici e i trattini bassi. Non deve fornire un attributo di codice per i gruppi di conti.
| Cur_Assets |
nome
| S | Il nome del conto, come appare nei report e nei fogli.
| Attività correnti |
shortName | N | Il nome abbreviato del conto. | CA |
descrizione | N | La descrizione testuale del conto. La lunghezza massima dei caratteri è 2048. | Totale attività correnti |
subType | N | Indica se il conto è PERIODICO o CUMULATIVO. Se un conto è periodico, il suo valore in un determinato mese è uguale all'attività netta del mese. Gli esempi includono i conti dei ricavi e delle spese. Se un conto è cumulativo, il suo valore è uguale al saldo finale di un determinato mese. Questo è il valore del mese precedente più o meno qualsiasi attività nel mese specificato. I conti di stato patrimoniale sono cumulativi. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. Sola lettura, identificata in base al conto padre. | Cumulativo |
planBy | N | Per i conti cumulativi, indica se il conto è piano per saldo (SALDO) o piano per delta (DELTA). Il valore predefinito è DELTA. La modifica di planBy in DELTA NON è consentita quando il conto ha frazionamenti nelle versioni non effettive. Applicabile solo ai conti foglia. updateAccountesclude gli errori quando l'utente tenta di impostare planBy per un conto non foglia. | DELTA |
importi effettiviBy | N | Per i conti cumulativi, indica se il conto è composto da importi effettivi per saldo (SALDO) o importi effettivi per delta (DELTA). Il valore predefinito è SALDO. Applicabile solo ai conti foglia. updateAccountesclude gli errori quando l'utente tenta di impostare importi effettiviBy per un conto non foglia. | SALDO |
enableActuals | N | 0 per mostrare solo i dati del piano per il conto. 1 per importare gli importi effettivi nel conto. Per i conti collegati, 0 mostrerà gli importi effettivi solo se il conto collegato li ha e 1 abiliterà gli importi effettivi per il conto collegato. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. L'interfaccia utente di amministrazione CoGe di Planning utilizza il termine "overlay importi effettivi". Il valore predefinito è 0 quando il conto corrente è un gruppo. Il valore predefinito è 1 quando il conto corrente è foglia | 1 |
balanceType
Aggiornato nell'API v33 | N | Indica il tipo di saldo di un conto: DEBIT o CREDITO. balanceType è vuoto se al conto non è associato un tipo di saldo. Solo i conti CoGe hanno un tipo di saldo. Per l'API v32 e precedenti, balanceType è una proprietà di sola lettura identificata nel conto padre. Per l'API v33+, i conti figlio possono utilizzare un balanceType diverso rispetto ai conti padre. | CREDITO |
timeStratum | N | Il codice dello strato temporale del conto. Per i conti modellati e cubo, viene ereditato dal foglio proprietario del conto. Consultare Procedura: Modificare i calendari per ulteriori informazioni sulla struttura temporale e sui codici periodo. Proprietà di sola lettura selezionata dalla struttura temporale, dal foglio modellato o dal foglio cubo. | month |
displayAs | N | L'impostazione di visualizzazione dell'output del conto: NUMBER, CURRENCY o PERCENT. Fornito solo per i conti che hanno una proprietà Visualizza come in Amministrazione conti. Proprietà di sola lettura per i conti CoGe. | NUMBER |
decimalPrecision | N | Il numero di posizioni decimali da visualizzare per i numeri in questo conto. Il valore speciale 99 indica un Conto collegato che eredita la precisione decimale della destinazione. Il valore -1 indica che il conto è un conto in valuta e utilizza la precisione della valuta visualizzata. Valori consentiti: -1, 0, 1-9, 99 Il valore predefinito è 0. | 0 |
exchangeRateType | N | Presente solo per le istanze con multivaluta abilitata e per i conti con displayAs="CURRENCY". Valori possibili: qualsiasi codice del tipo di tasso di cambio presente nell'istanza, come configurato in Gestione valute. "A"=Media mensile, "E"=Fine mese. Se mancante, utilizzare A per PERIODICO ed E per CUMULATIVO. | E |
suppressZeroes | N | Indica se il conto consente agli utenti di eliminare gli zeri nei fogli. Se 0 gli utenti non possono eliminare gli zeri. Se 1 gli utenti possono sopprimere gli zeri. Fornito solo per i conti con la proprietà "Elimina nei fogli" attivata nell'amministratore Conti. Se mancante, il valore predefinito è 1. | 1 |
startExpanded | N | Indica se un conto e i relativi elementi figlio iniziano in uno stato esteso al primo caricamento del foglio. Si applica solo ai conti padre. 1 per espansa, 0 per compressa. Se mancante, il valore predefinito è 1. | 1 |
dataEntryType aggiornato nell'API v29 | N | Indica il tipo di immissione dati per un conto foglia. STANDARD o CUBE. Se il dataEntryType padre è CUBE, il nuovo conto verrà impostato automaticamente su dataEntryType CUBE. In caso contrario, i nuovi conti avranno per impostazione predefinita dataEntryType STANDARD. Le modifiche dataEntryType ai conti non foglia vengono ignorate. Il sistema calcola automaticamente i nuovi dataEntryType per tutti i conti non foglia. L'API v29 e le versioni successive supportano l'aggiunta di nuovi conti con dataEntryType=CUBE. | STANDARD |
hasSalaryDetail | N | Indica se il conto ha frazionamenti che richiedono l'autorizzazione Accesso ai dettagli stipendio per la visualizzazione. Vuoto se non applicabile a questo conto. hasSalaryDetail=1 non è consentito per i conti di gruppo di conti/non foglia. To make hasSalaryDetail=1:
Si verifica un errore quando dataEntryType è NOT STANDARD. Errore quando dataEntryType=1 per i conti non foglia. Errori per conti non CoGe e personalizzati. | 1 |
dataPrivacy | N | Indica i livelli in cui i valori del conto sono pubblici e aggiornabili in altri livelli quando si scrivono le formule. PRIVATE indica che i valori del conto sono privati. PUBLIC_TOP indica che i valori del conto sono pubblici solo al primo livello o PUBLIC_ALL in modo che i valori del conto siano pubblici a tutti i livelli. I presupposti sono sempre pubblici e non hanno un'impostazione dataPrivacy. Se mancante, il valore predefinito è PRIVATO. Errori per gruppi di conti e conti di ipotesi. | PRIVATO |
isIntercompany | N | Indica se il conto è un conto interaziendale o meno. Le modifiche alla proprietà isIntercompany non sono supportate. | 0 |
propagateToDescendants | N | Indica la propagazione delle modifiche alla mappatura degli attributi ai discendenti. Se mancante, il valore predefinito è 0. Viene visualizzato un errore se vuoto o contiene un valore diverso da 1 o 0. Proprietà che si propagano ai discendenti:
| 1 |
Contenuto dell'elemento | |||
Un elemento attributi facoltativo se si desidera modificare uno o più attributi del conto associati al conto. | |||
elemento attributo | |||
Nome tag | attributo | ||
Descrizione | Specifica un attributo da aggiornare. Contrassegna il conto con l'attributo se il modello include attributi conto. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
nome | S | Il nome dell'attributo. Errore se il nome non esiste già nel sistema. Viene visualizzato un errore se il nome esiste ma l'attributo non è un attributo del conto. Viene visualizzato un errore se il nome dell'attributo è vuoto o mancante. | Location |
valore
aggiornato nell'API v34 | S | Il valore dell'attributo per questo attributo. Consente a un valore vuoto di rimuovere il valore corrente o qualsiasi valore attributo conto definito. Il valore dell'attributo deve essere compatibile con l'attributo assegnato al conto. Per API v32 e v33, questo attributo è significativo solo quando l'impostazione Nome visualizzato è disattivata per l'istanza. Per API v34 e versioni successive:
| 170 |
valueCode
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34. | S | Il codice univoco del valore dell'attributo.
L'input valueCode è significativo solo quando displayNameEnabled=1 e l'impostazione Nome visualizzato è ON per l'istanza in API v32 e API v33. Codici valore attributo non validi:
| SFO |
valueName
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. Non supportato nell'API v34. | N | Il nome di un nuovo valore attributo creato automaticamente.
L'attributo valueName è significativo solo quando:
| San Francisco |
Contenuto dell'elemento | |||
(nessuno) | |||
Elaborazione payload dall'alto verso il basso
Gli attributi dei conti raggruppano logicamente i valori e contrassegnano i conti. Poiché l'API updateAccounts elabora il payload XML dall'alto verso il basso, assegnare l'attributo conto a un conto padre prima di modificare gli attributi del conto figlio. I conti figlio possono essere contrassegnati con qualsiasi valore attributo quando il valore attributo del conto padre è vuoto. Se gli attributi del conto figlio non si allineano con l'attributo padre, si verifica un errore di convalida della compatibilità.
Si consideri la struttura ad albero seguente in cui la "Linea di prodotti" padre ha due conti figlio "A" e "B-Ste". I conti "A" e "B-Ste" sono fratelli.
Product Line|__A __A |__B-Ste __B-Ste |__B1 __Product B-1 |__B2 __Product B-2 |__B3 __Product B-3
Esempio di XML richiesta originale con attributi conto
Si noti che il valore dell'attributo conto "A" è assegnato sia ad "Altri conti" che a "Banca svizzera".
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="A" /> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="A" /> </account> </account> </accounts>
Esempio di ordine errato per elaborazione payload
Il payload XML seguente genera un errore "
The attribute value B-1 is not compatible with the parent's attribute value
". L'elaborazione del payload dall'alto verso il basso considera "Altri conti" padre come valore "A" del blocco di codice precedente ed elabora "B-1" come figlio di "A". L'errore viene generato perché il figlio "Swiss Bank" può avere solo i valori attributo "A" o "B-Ste", come indicato nella struttura ad albero. <accounts> <account id="60" code="70140" name="Other Accounts"> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change ignored due to placement order--> </account> </accounts>
Esempio di ordine valido per elaborazione payload
La riorganizzazione dell'ordine di posizionamento di "B-Ste" sotto "Altri conti" consente all'API di elaborare prima l'attributo del conto padre "B-Ste", consentendo a "Banca svizzera" di avere valori "B-Ste" o uno dei suoi figli.
<accounts> <account id="60" code="70140" name="Other Accounts"> <attribute name="Product Line" value="B-Ste" /> <!-- Account Attribute change processed due to correct placement order--> <account id="91" code="70150" name="Swiss Bank"> <attribute name="Product Line" value="B-1" /> </account> </account> </accounts>
Formato risposta
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <messages> <message type="INFO">Accounts were saved successfully.</message> </messages> <output> <accounts> <account id="1441" code="LocalAssets" name="LocalAssets" shortName="" description="Local Assets"displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> <account id="1610" code="LocalCashAssets" name="Local Cash Assets" shortName="" description="cash assets" displayAs="CURRENCY" decimalPrecision="0" suppressZeroes="true" exchangeRateType="E" formula="" isIntercompany="0" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="true" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="true"> </account> </accounts> </output> </response>
elemento di output | |
Nome tag | output |
Attributi dell'elemento | |
(nessuno) | |
Contenuto dell'elemento | |
Un singolo elemento conti obbligatorio. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita. | |
elemento conti | |||
Nome tag | conti | ||
Descrizione | Contenitore per uno o più elementi del conto. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
Contenuto dell'elemento | |||
Uno o più elementi del conto. | |||
elemento conto | |||||
Nome tag | account | ||||
Descrizione | Rappresenta un singolo conto restituito nella risposta a una chiamata API updateAccounts. Se questo elemento si trova direttamente all'interno dell'elemento conti di inclusione della risposta (ovvero non è racchiuso in un altro elemento conto), questo elemento conto rappresenta un conto radice (un conto senza padre). | ||||
Attributi dell'elemento | |||||
Nome attributo | Obbligatorio? | Valore | Esempio | ||
ID | S | Il numero ID di sistema interno per il conto. Può essere utilizzato per identificare i conti in altre chiamate API, ad esempio exportDimensionFamilies. | 16 | ||
codice | S | Il codice del conto, come appare quando si fa riferimento nelle formule. | Cur_Assets | ||
nome | S | Il nome del conto, come appare nei report e nei fogli. | Attività correnti | ||
accountTypeCode | N | Il codice lettera corrispondente al tipo di dati del conto | |||
Digitare il codice | Tipo di conto | Classe conto | |||
A | Attività | CoGe | |||
B | Attività correnti | CoGe | |||
C | Passività e capitale netto | CoGe | |||
CUBO | Cubo | Cubo | |||
IT | Utili/perdite da inizio anno | CoGe | |||
F | Attività | CoGe | |||
G | Costo del venduto | CoGe | |||
I | Income | CoGe | |||
J | Utile non operativo | CoGe | |||
K | Rettifica conversione cumulativa | Sistema | |||
L | Passività | CoGe | |||
M | Passività correnti | CoGe | |||
MI | Percentuali di consolidamento | Predefinito | |||
MT | Metrica | Metrica | |||
N | Utile netto | CoGe | |||
O | Altre attività | CoGe | |||
Q | Capitale netto | CoGe | |||
R | Attività a lungo termine | CoGe | |||
S | Ipotesi | Ipotesi | |||
T | Passività a lungo termine | CoGe | |||
W | Modellato | Modellato | |||
X | Spese | CoGe | |||
XR | cambio budget | Predefinito | |||
S | Spese non operative | CoGe | |||
Z | Personalizzato | Personalizzato | |||
descrizione | N | La descrizione testuale del conto, se presente, immessa in Amministrazione conto | Totale attività correnti | ||
shortName | N | Il nome abbreviato del conto, se presente, immesso in Amministrazione conto | CA | ||
timeStratum | N | Il codice dello strato temporale del conto. Per i conti modellati e cubo, viene ereditato dal foglio proprietario del conto. | Month | ||
displayAs | N | L'impostazione di visualizzazione dell'output del conto: NUMBER, CURRENCY o PERCENT. Fornito solo per i conti che hanno una proprietà Visualizza come in Amministrazione conti. | NUMBER | ||
isPrestazioni | N | "0" o "1", a indicare se il conto è un'ipotesi. È impostato su 1 per i conti ipotesi e tassi di cambio. | 1 | ||
suppressZeroes | N | Indica se il conto consente agli utenti di eliminare gli zeri nei fogli. Se 0 gli utenti non possono eliminare gli zeri. Se 1 gli utenti possono sopprimere gli zeri. Fornito solo per i conti con la proprietà "Elimina nei fogli" attivata nell'amministratore Conti. | 1 | ||
isDefaultRoot | N | "0" o "1", a indicare se il conto o il gruppo di conti è una radice predefinita. | 1 | ||
decimalPrecision | N | Numero di posizioni decimali da visualizzare per i numeri in questo conto. Il valore speciale 99 indica un Conto collegato che eredita la precisione decimale della destinazione. Il valore -1 indica che il conto è un conto in valuta e utilizza la precisione della valuta visualizzata. Valori consentiti: -1, 0, 1-9, 99 Il valore predefinito è 0. | 0 | ||
planBy | N | Per i conti cumulativi, indica se il conto è piano per saldo (SALDO) o piano per delta (DELTA). | SALDO | ||
exchangeRateType | N | Presente solo per i conti con displayAs="CURERENCY". Valori possibili: qualsiasi codice del tipo di tasso di cambio presente nell'istanza, come configurato in Gestione valute. "A"=Media mensile, "E"=Fine mese. | E | ||
balanceType | N | Indica il tipo di saldo di un conto, DEBIT o CREDITO. Questo attributo è vuoto se al conto non è associato un tipo di saldo. Solo i conti CoGe hanno un tipo di saldo. | DEBIT | ||
dataEntryType aggiornato nell'API v29 | N | Indica il tipo di immissione dati per il conto. STANDARD o CUBE. Un valore vuoto indica che il tipo di immissione dati non è applicabile al conto. Il sistema calcola automaticamente i nuovi dataEntryType per tutti i conti non foglia. Per API v29 e versioni successive:
| STANDARD | ||
timeRollUp | N | Indica il comportamento del conto in caso di rollup in un periodo di tempo. Può essere SUM, WEIGHTED_AVERAGE, LAST o AVERAGE. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. | SUM | ||
timeWeightAcctId | N | Se il conto ha un timeRollup di WEIGHTED_AVERAGE, questo sarà il numero ID sistema interno del conto da cui vengono determinate le ponderazioni. Il valore sarà vuoto se non esiste un conto di ponderazione o se il conto non ha un timeRollup di WEIGHTED_AVERAGE. | 133 | ||
hasSalaryDetail | N | Indica se il conto ha frazionamenti che richiedono l'autorizzazione Accesso ai dettagli stipendio per la visualizzazione. Vuoto se non applicabile a questo conto. | 1 | ||
dataPrivacy | N | Indica i livelli in cui i valori del conto sono pubblici e aggiornabili in altri livelli quando si scrivono le formule. PRIVATE indica che i valori del conto sono privati. PUBLIC_TOP indica che i valori del conto sono pubblici solo al primo livello o PUBLIC_ALL in modo che i valori del conto siano pubblici a tutti i livelli. I presupposti sono sempre pubblici e non hanno un'impostazione dataPrivacy. | PRIVATO | ||
subType | N | Indica se il conto è PERIODICO o CUMULATIVO. Se un conto è periodico, il suo valore in un determinato periodo di tempo è uguale all'attività netta per il periodo di tempo. Gli esempi includono i conti dei ricavi e delle spese. Se un conto è cumulativo, il suo valore è uguale al saldo finale per un determinato periodo di tempo. Questo è il valore del periodo di tempo precedente più o meno qualsiasi attività nel periodo di tempo specificato. I conti di stato patrimoniale sono cumulativi. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. | PERIODIC | ||
startExpanded | N | Ciò indica se un conto e i relativi elementi figlio iniziano in uno stato esteso al primo caricamento di un foglio. Ciò si applica solo ai conti padre. Questo sarà vuoto per i conti foglia. | 1 | ||
isBreakbackEligible | N | 0 o 1 per indicare se il conto può essere utilizzato in una ripartizione retroattiva. Ciò si applica solo alle ipotesi standard. Questo campo sarà vuoto per gli altri tipi di conto. | 0 | ||
levelDimRollup | N | Indica il comportamento del conto quando viene eseguito il rollup lungo un livello o una dimensione. Può essere SUM, WEIGHTED_AVERAGE, TEXT o NONBLANK_AVERAGE. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. | NONBLANK_AVERAGE | ||
levelDimWeightAcctId | N | Se il conto ha un livelloDimRollup di WEIGHTED_AVERAGE, questo sarà il numero ID sistema interno del conto da cui vengono determinate le ponderazioni. Questo campo sarà vuoto se non esiste un conto di ponderazione o se il livello del contoDimRollup non è WEIGHTED_AVERAGE. | 118 | ||
rollupText | N | Se il conto ha un levelDimRollup di TEXT, questa è la stringa di testo che verrà visualizzata nella cella che indica il valore di rollup del conto. | Nessuno | ||
enableActuals | N | 0 per mostrare solo i dati del piano per il conto. 1 per importare gli importi effettivi nel conto. Per i conti collegati, 0 mostrerà gli importi effettivi solo se il conto collegato li ha e 1 abiliterà gli importi effettivi per il conto collegato. Questo campo sarà vuoto per i gruppi di conti e i conti metrica. | 1 | ||
isGroup | S | 0 o 1 per indicare se si tratta o meno di un gruppo di conti. | 1 | ||
isContra
Disponibile nell'API v34+ | N | 0 o 1 per indicare se si tratta di un conto di contropartita. | 1 | ||
isIntercompany | N | 0 o 1 per indicare se il conto è un conto interaziendale o meno. | 1 | ||
isLinked | N | 0 o 1 per indicare se il conto è collegato o meno. | 1 | ||
isSystem | N | 0 o 1 per indicare se il conto è un conto di sistema o meno. | 1 | ||
stato | S | Lo stato del conto dopo l'aggiornamento. Per gli avvisi e gli errori, l'elemento del messaggio contiene il contenuto del messaggio. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
| Aggiornato | ||
messaggio | N | Il messaggio di errore per l'input del conto. | Il conto ModAccount33 è duplicato nel payload o esiste già nel sistema con ID 8 | ||
Contenuto dell'elemento | |||||
Un elemento conto nidificato per ogni conto figlio diretto di questo conto. Un elemento attributi se al conto sono associati uno o più attributi. | |||||
elemento attributo | |||
Nome tag | attributo | ||
Descrizione | Indica la codifica degli attributi per il conto. | ||
Attributi dell'elemento | |||
Nome attributo | Obbligatorio? | Valore | Esempio |
nome | S | Il nome dell'attributo conto | Tipo di istruzione |
valore
aggiornato nell'API v34 | S | Il valore dell'attributo conto.
Per API v32 e API v33, questo attributo è significativo solo quando l'impostazione Nome visualizzato è disattivata per l'istanza. | Tech1 |
valueCode
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. | S | Il codice univoco del valore dell'attributo.
Per API v32 e API v33, valueCode è significativo solo quando:
| |
valueName
Disponibile solo in API v32 e API v33 per le istanze che abilitano il nome visualizzato. | N | Il nome di un nuovo valore attributo creato automaticamente.
L'attributo valueName è significativo solo quando:
| |
stato | S | Lo stato dell'attributo dopo l'aggiornamento. Per gli avvisi e gli errori, l'elemento del messaggio contiene il contenuto del messaggio. Lo stato di aggiornamento non restituisce alcun contenuto del messaggio.
| aggiornato |
messaggio | N | Il messaggio di errore per un attributo non valido. | |
Contenuto dell'elemento | |||
(nessuno) | |||