Add Function


 

Parameters

Parameters are the data you will pass with the call.

 

Service

For the Add function, this field must contain one of the following

  • AddClients
  • AddHourlyServices
  • AddInvoices
  • AddPayments
  • AddBilledMisc
  • AddMiscItems
  • AddBilledHourly
  • AddSubscribers
  • AddRecurringBilling


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

_____________________________________________________________


object

This contains the necessary data for the function to do its job.

  • ClientID or all relevant new client information (Refer to Add function for Clients)
  • All BilledMisc information except for the InvoiceNumber (Refer to Add function for BilledMisc)
  • "AmountPaid":"50.24", this field must contain the amount that the client will be charged


Rules: Required

_____________________________________________________________ 


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.
_____________________________________________________________


success or AddFail

Add status message
_____________________________________________________________