View Function


 

Parameters

Parameters are the data you will pass with the call.

 

Service

For the View function, this field must contain one of the following:

  • ViewUsers
  • ViewClients
  • ViewHourlyServices
  • ViewInvoices
  • ViewPayments
  • ViewBilledMisc
  • ViewMiscItems
  • ViewBilledHourly
  • ViewSubscribers
  • ViewRecurringBilling


Rules: Required
Type: String

_____________________________________________________________


apikey

This is your identifier.

Rules: Required
Type: String

_____________________________________________________________


sig

The HMAC-SHA256 Signature input is generated from appending the apikey, service, and timestamp

values together as the input and your private key as the key.

Rules: Required
Type: String

_____________________________________________________________


timestamp

The time that the function was called. It must be in YYYYMMDD HH:MM format in UTC

Rules: Required
Type: String

_____________________________________________________________


ID

If this field is specified, it will return the specified corresponding item.

Rules: Optional

_____________________________________________________________


Return Values

 

A Json string is returned containing a message and other data.

 

Error with apikey

There is an issue with the apikey.

_____________________________________________________________


Error selecting service

The service name provided could not be found.

_____________________________________________________________


Outputs data

The function was successful and returns the data.

_____________________________________________________________