updateAccount

Adaptive Planning

updateAccount

Categoria	Modifica dei metadati
Descrizione	Aggiornare un conto esistente nel sistema. Questa API restituisce un messaggio di errore quando la convalida o l'aggiornamento non riesce oppure restituisce i metadati per l'account aggiornato in caso di esito positivo. Questa API supporta solo i seguenti tipi di conto: Conto di ipotesi, Conto CoGe e Conto personalizzato. Non supporta i conti di sistema o collegati.
Autorizzazioni necessarie per richiamare	Modello per conti CoGe e personalizzati Ipotesi per ipotesi
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 disporre dell'autorizzazione Modello o Ipotesi per eseguire la creazione del conto. La richiesta XML viene convalidata per ogni campo e in base a determinate logiche aziendali. I messaggi di errore vengono restituiti come parte della risposta quando la creazione non riesce. L'operazione può essere interrotta e viene visualizzato un messaggio di avviso quando viene rilevata un'operazione rischiosa. La richiesta deve essere inoltrata di nuovo con l'attributo "ignoreWarnings" impostato su 1 per completare l'aggiornamento del conto.

Formato richiesta

Lo schema della richiesta viene fornito nel formato Relax NG Compact.


default namespace = ""
start =
    element account {
        attribute id { xsd:integer }, #account id
        attribute name { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute code { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute description { xsd:string { maxLength="2048"} }?, #Potentially empty string with a maximum length of 2048 characters.
    attribute shortName { xsd:string { maxLength="64"} }?, #Potentially empty string with a maximum length of 64 characters.
    attribute exchangeRateType { xsd:string }?, #displayAs must be CURRENCY (only if multicurrency is enabled) attribute hasSalaryDetail { string "0" | string "1" }?, #0=No, 1=Yes
    attribute dataPrivacy { string "PRIVATE" | string "PUBLIC_TOP" | string "PUBLIC_ALL" }?,
    attribute isBreakbackEligible { string "0" | string "1" }?, #0=No, 1=Yes
    attribute proceedWithWarnings { string "0" | string "1" }?, #0=No, 1=Yes
    element attributes{
        element attribute{
            attribute attributeId{ xsd:integer },
            attribute valueId{ xsd:integer }
        }* 
    }?
}

Esempio


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccount" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <account
        id="48"
        name="Account Name"
        code="Account_Code"
        description="Account Description"
        shortName="Short Name"
        exchangeRateType="A"
        hasSalaryDetail="1"
        dataPrivacy="PRIVATE" >
        <attributes>
            <attribute attributeId="20" valueId="170" />
        </attributes>
    </account>
</call>

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 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. Può essere utilizzato per identificare i conti in altre chiamate API, ad esempio exportDimensionFamilies.	16
nome	S	Il nome del conto, come appare nei report e nei fogli.	Attività correnti
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
descrizione	N	La descrizione testuale del conto.	Totale attività correnti
shortName	N	Il nome abbreviato del conto.	CA
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.	E
hasSalaryDetail	N	La visualizzazione delle suddivisioni dei conti richiede l'autorizzazione per i dettagli dello stipendio. 0 per no, 1 per sì.	1
dataPrivacy	N	Scegliere se il valore del conto è privato (PRIVATE), pubblico solo al primo livello (PUBLIC_TOP) o pubblico a tutti i livelli (PUBLIC_ALL). L'impostazione predefinita è PRIVATO.	PRIVATO
isBreakbackEligible	N	Disponibile con ripartizione retroattiva. 0 per no, 1 per sì. Applicabile solo per le ipotesi.	0
procedereWithWarnings	N	Indica se l'utente desidera ignorare i messaggi di avviso e procedere con l'operazione di aggiornamento: 0 per no, 1 per sì. Se sono presenti avvisi e proceWithWarnings=0, il conto non verrà aggiornato. Impostare proceWithWarnings=1 per aggiornare il conto quando sono presenti avvisi.	1
Contenuto dell'elemento
Un elemento attributi facoltativo se si desidera modificare uno o più attributi del conto associati al conto.

elemento attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Rappresenta un elemento attributo conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
attributeID	S	L'ID dell'attributo conto generato dal sistema.	20
valueID	S	L'ID univoco del valore attributo conto generato dal sistema. Se questo valore è 0, l'attributo verrà rimosso dal conto.	170
Contenuto dell'elemento
nessuno

Formato risposta

Questi sono esempi di risposte per l'aggiornamento di un conto riuscito e non riuscito.

Esempio di successo


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <messages>
        <message type="WARNING" key="warning-unpublished-changes" values="" accountId="1">You have unpublished changes. 
            Your changes will not be visible every where until it is published.</message>
    </messages>
    <output>
        <accounts>
            <account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY" accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" formula="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
               <attributes>
                   <attribute
                   name="AP Eligible"
                   attributeId="17"
                   value="Yes"
                   valueId="170" />
               </attributes>
               </account>
        </accounts>
    </output>
</response>

Esempio di errore


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
       <message type="ERROR" key="invalid-account-id" values="441" accountId="-50">Invalid account id: "-50"</message>
    </messages>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo e/o un singolo elemento di output facoltativo.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di conti. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

elemento messaggi
Nome tag	messaggi
Descrizione	Contenitore per uno o più elementi del messaggio.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del messaggio.

elemento messaggio
Nome tag		messaggio
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore quando le richieste non hanno esito positivo, per i messaggi di avviso quando le richieste hanno esito positivo e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
type	S	Il tipo è un metodo per identificare il tipo di messaggio. I diversi tipi sono INFO, WARNING ed ERROR. Il tipo ERROR indica che la richiesta non è stata elaborata.	AVVISO
chiave	S	Una chiave è un modo per identificare un particolare messaggio o tipo di messaggio, utile ai fini della registrazione automatica degli errori e del ripristino nei programmi client. Le chiavi non cambiano nelle diverse impostazioni internazionali delle richieste, anche quando cambia la lingua del messaggio. Inoltre, è improbabile che le chiavi cambino in futuro a causa di rettifiche di testo o modifiche della terminologia.	warning-invalid-timespan-start
valori	N	Quando vengono specificati, i valori rappresentano le variabili utilizzate nel testo del messaggio.	199,12
parentId	N	Se disponibile, l'ID del nuovo conto padre fornito nella richiesta.	50
Contenuto dell'elemento
Il testo del messaggio. Questo testo è nella lingua delle impostazioni internazionali specificate nella richiesta (supponendo che le impostazioni internazionali siano supportate). Il testo può anche contenere informazioni variabili come il numero di righe elaborate o la colonna o il valore specifico che ha causato un errore.

elemento conti
Nome tag	conti
Descrizione	Contenitore per uno o più elementi del conto.
Attributi dell'elemento
(nessuno)
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 exportAccounts. 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

nome

Il nome del conto, come appare nei report e nei fogli.

Corrente

Attività

codice

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

Il numero ID di sistema interno per il conto. Può essere utilizzato per identificare i conti in altre chiamate API, ad esempio exportDimensionFamilies.

accountTypeCode

Il codice lettera corrispondente al conto del tipo di dati.

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

La descrizione testuale del conto.

Totale

attività correnti

shortName

Il nome abbreviato del conto, se presente, immesso in Amministrazione conto.

timeStratum

Supportato nell'API v16+

Lo strato temporale del conto, come codice dello strato temporale. Per i conti cubo, i conti modellati e i conti CoGe inseriti nel cubo, lo strato temporale è determinato dallo strato temporale del foglio proprietario. Tutti gli altri conti utilizzano lo strato temporale predefinito impostato nell'interfaccia utente di Time Admin.

Month

displayAs

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

"0" o "1", a indicare se il conto è un'ipotesi. È impostato su "1" per i conti ipotesi e tassi di cambio.

suppressZeroes

Flag che indica se il conto consente agli utenti di sopprimere o meno gli zeri nei fogli. 0 non è consentito, 1 è consentito. Fornito solo per i conti che hanno una proprietà Elimina zeri in Amministrazione conti.

isDefaultRoot

"0" o "1", a indicare se il conto o il gruppo di conti è una radice predefinita.

decimalPrecision

Numero di posizioni decimali da visualizzare per i numeri in questo conto. Il valore predefinito è 0. Il valore speciale 99 viene utilizzato per indicare un Conto collegato che eredita la precisione decimale della destinazione. Un valore pari a -1 indica che il conto è un conto in valuta e utilizza la precisione della valuta visualizzata.

planBy

Per i conti cumulativi, indica se il conto è piano per saldo (SALDO) o piano per delta (DELTA).

SALDO

exchangeRateType

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.

isImportable

Indica se il conto è in grado di accettare i dati importati. 0 significa che il conto non è importabile e 1 è importabile. Presente solo se nella richiesta è specificato versionName o versionId.

Nota: isImportable indica solo che un conto è disponibile per l'importazione nella versione specificata, non che l'utente che effettua la chiamata API dispone dell'autorizzazione per l'importazione nella versione o nel conto. Utilizzare exportVersions per vedere quali versioni sono disponibili per l'importazione.

hasSalaryDetail

La visualizzazione delle suddivisioni dei conti richiede l'autorizzazione per i dettagli dello stipendio. 0 per no, 1 per sì.

balanceType

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

Indica il tipo di immissione dati di un conto. STANDARD o CUBE. Un valore vuoto indica che il tipo di immissione dati non è applicabile a un conto. Ad esempio, un conto collegato o un conto modellato avrà un tipo di immissione dati vuoto.

CUBO

timeRollUp

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

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

0 o 1 per indicare se il conto ha frazionamenti che richiedono l'autorizzazione Accesso ai dettagli stipendio per la visualizzazione. Questo campo sarà vuoto se non applicabile a questo conto.

dataPrivacy

Indica i livelli in cui i valori del conto sono pubblici e possono essere referenziati in altri livelli durante la scrittura delle formule. Può essere PRIVATE in modo che i valori del conto siano privati, PUBLIC_TOP in modo che i valori del conto siano pubblici solo al livello superiore o PUBLIC_ALL in modo che i valori del conto siano pubblici a tutti i livelli. I presupposti non hanno un'impostazione dataPrivacy perché sono sempre pubblici.

PRIVATO

subType

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.

PERIODIC

startExpanded

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.

isBreakbackEligible

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.

levelDimRollup

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

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

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

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.

isGroup

0 o 1 per indicare se si tratta o meno di un gruppo di conti.

isIntercompany

0 o 1 per indicare se il conto è un conto interaziendale o meno.

formula

La formula per il conto, se presente.

ACCT.Revenue - ACCT.Expenses

isLinked

0 o 1 per indicare se il conto è collegato o meno.

isSystem

0 o 1 per indicare se il conto è un conto di sistema o meno.

owningSheetId

Per i conti che possono trovarsi in fogli modellati e cubo, il numero ID sistema interno del foglio in cui si trova il conto. Questo campo sarà vuoto se non si tratta di un conto di questo tipo o se si tratta di un conto di questo tipo ma non è attualmente assegnato a un foglio.

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 attributi
Nome tag		attributi
Descrizione		Contenitore per uno o più elementi attributo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi attributo.

elemento attributo
Nome tag		attributo
Descrizione		Rappresenta una singola mappatura di attributi conto non vuoti a cui è associato un conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Il nome dell'attributo conto.	Report SEC
valore	S	Il nome dell'attributo del conto associato al conto.	Sì
attributeId	S	Il numero ID sistema interno dell'attributo conto.	10
valueId	S	Il numero ID sistema interno del valore attributo conto.	108
Contenuto dell'elemento
Nessuno.