The xAssets API - Method : LookupAccountingPeriod

Summary

Returns a list of accounting periods for use in dropdowns and searches

Parameters

Parameter : sArguments

0
BACKWARD, FORWARD, BACKWARDFORECAST, FOREWARDFORECAST, ALLSTART, ALLEND
1
AccountingPeriodSetID

Use BACKWARD to list accounting periods which occur before the current period

Use FORWARD to list accounting periods which occur after the current period

Use BACKWARDFORECAST to list accounting periods which occur before the current budget period

Use FORWARDFORECAST to list accounting periods which occur before the current budget period

Use ALLSTART to return all accounting period start dates

Use ALLEND to return all accounting period end dates

Returns

A lookup list of accounting periods for use in dropdowns

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Lookup Accounting Periods in Accounting Period Set number 3, where the date is before the current period


    Imports System.Text
    Imports Newtonsoft.Json.Linq
    Public Module Module1

        Public Sub Main()

            Try

                '   Enter your API key and company database name in these variables

                Dim _db As String = "mycompany"
                Dim apikey As String = "YOURAPIKEY"

                '   Open a web client to login

                Dim web As New System.Net.WebClient()

                Dim urlroot as String = "https://" & _db & ".hosted.xassets.net/api"
                Dim json As String = web.DownloadString(urlroot & "/api.ashx?apikey=" & apikey & "&database=" & _db & "&command=apilogon")

                '   Check the login for errors

                Dim o As JObject = JObject.Parse(json)
                Dim e As String = GetResultFromJson(o, "error")
                If e <> "" Then
                    Throw New Exception(e)
                End If

                '   Store the login hash, nonce and noncedate

                Dim hash As String = GetResultFromJson(o, "hash")
                Dim nonce As String = GetResultFromJson(o, "nonce")
                Dim noncedate As Date = CDate(GetResultFromJson(o, "noncetime"))

                If hash = "" Then
                    Throw New Exception("Unexpected error - a hash was not returned from the API logon process")
                End If

                Console.WriteLine("Logged on OK")

                '   Open a new web client to perform the API call

                web = New System.Net.WebClient()

                '   Add the authorization header

                web.Headers.Add("Authorization", "Bearer " & hash)
                web.Headers.Add("Sec", _db & "|" & nonce & "|" & Format(noncedate, "dd-MMM-yyyy HH:mm:ss") & "|" & Format(noncedate, "fff"))

                '   Perform the actual API call

                Dim url as String = urlroot & "/api.ashx?command=LookupAccountingPeriod&arg0=BACKWARD&arg1=3
                Dim data As String = web.DownloadString(url.ToString)

                '   Parse and output the data

                Dim ob As JObject = JObject.Parse(data)
                Dim err As String = GetResultFromJson(ob, "error")
                If err <> "" Then
                    Throw New Exception(err)
                End If
            
                Dim xml As String = GetResultFromJson(ob, "returncode")

                Console.WriteLine(xml)
                Console.WriteLine("Finished - Press enter to close")
            
                Catch ex As Exception
                Console.WriteLine("Error:" & ex.Message & " - Press enter to close")
            End Try

            Console.ReadLine()

        End Sub

        Private Function GetResultFromJson(o As JObject, sFind As String) As String

            For Each res As JObject In o.SelectTokens("data[*]")
                If res("type").Value(Of String) = sFind Then
                    Return res("value").ToString
                End If
            Next

            Return ""

        End Function
    End Module
                

SOAP Syntax with Microsoft Visual Basic

Example 1 - Lookup Accounting Periods in Accounting Period Set number 3, where the date is before the current period



    Try

        ErrorMessage = ""

        Return w.WebCommandProcessorArray(_hash, _username, _db, _ip, "LookupAccountingPeriod", {"BACKWARD", "3"}, _dns, _port, _scheme, _nonce, _noncedate)

    Catch ex As Exception
        ErrorMessage = ex.Message
        Return ""
    End Try
                        

AMSX Syntax

Example 1 - Lookup Accounting Periods in Accounting Period Set number 3, where the date is before the current period


    Set xml = CommandProcessor "LookupAccountingPeriod", "BACKWARD", "3"
                        

XCS Syntax

Example 1 - Lookup Accounting Periods in Accounting Period Set number 3, where the date is before the current period


    Dim xml As String = Server.API("LookupAccountingPeriod", "BACKWARD", "3")
                        

Download the Visual Studio API Samples Project

Return to the API Index Page