Sets optional billing data for a department. Each time you SetDepartmentBilling for a given department, the prior billing information is archived and automatically inactivated. If you pass in data we already had on file, the change will be ignored.

Please direct questions about how to use the billing values in this method to your Berke Account Manager.

Parameter Value
Required. 1-50 characters. Case-sensitive. Visit Settings | API:Security to change your API token (Berke login required). Your API token is a server-side authentication value. Do not embed it in client-side Javascript or submit it to Berke via an insecure connection.
Optional. Null or 1-50 characters. Your API Token is mapped to a default user. Use this field to change from the default API user to a specific user. The user must exist in your Berke account and is active. Null defaults to default API user. Visit Settings | API:Security to change your default API user (Berke login required).
Required, 1-50 characters. The ID of the department for which to set billing information. Use the GetDepartmentTree method to retrieve your SourceDepartmentId values if you do not know them. You can also find your SourceDepartmentId values in the Berke site. (Berke login required)
Required, true or false. If true, then utcBillingStart, billingPlanId, and billingPeriodId must be set.

Null or decimal-numeric. Optional except when isBillingEnabled is true. Time will be set to 00:00:00 for the day we receive. Must be formatted in Unix time offset to UTC. Visit EpochConverter.com for a demonstration and code samples for converting to/from UTC Unix time.

  • Current Time: 12/19/2018 9:34:56 AM Eastern Standard Time
  • Current Time UTC: 12/19/2018 2:34:56 PM UTC
  • Current Time Unix UTC: 1545230096.37814
Optional. Null or decimal-numeric. Time will be set to 23:59:59 for the day we receive. If not set and utcBillingStart has already occurred, then billing will be enabled. Must be formatted in Unix time offset to UTC. Visit EpochConverter.com for a demonstration and code samples for converting to/from UTC Unix time.
Required, integer, valid settings include:
  • 1 = not set - note: this value cannot be selected when isBillingEnabled is true
  • 2 = subscription
If billingPlanId is 1 (not set), then billingPeriodId must be 1 (not set). If billingPlanId is not 1, then billingPeriodId cannot be 1. Either set both values to 1 (not set) or set both to a plan and a period.
Required, integer, valid settings include:
  • 1 = not set - note: this value cannot be selected when isBillingEnabled is true
  • 2 = per month
  • 3 = per quarter
  • 4 = per year
If billingPeriodId is 1 (not set), then billingPlanId must be 1 (not set). If billingPeriodId is not 1, then billingPlanId cannot be 1. Either set both values to 1 (not set) or set both to a period and a plan.
Required, decimal. Set to 0.0 or greater if billingPlanId or billingPeriodId are not equal to 1 (not set). Set to 0.0 if billingPlanId is 1 (not set) and billingPeriodId is 1 (not set). Do not include any currency symbols or commas. All currency is in USD.
Optional, null or 1-500 characters. Do not, under any circumstances, include any card data or other sensitive information in this field.
Optional, recommended.
Optional, recommended. Must be a valid email address.
Optional, recommended.
Optional, but highly recommended, null or 1-500 characters. Accountants appreciate good documentation when a billing record changes.
Optional. Defaults to first value in list if not supplied. This value sets format in which to return the results of the method. All formats return the same data and hierarchical layout.
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="ok" responseCode="200">
  <departmentBilling wasChanged="true" changeSummary="[Example change summary... Billing changes recorded: 1: Billing Period Amount changed from [0.00] to [500.00]" reasonForChange="[Example reason... Upgraded from Basic Plan]" billingStatus="Enabled" billingWarning="BillingEnabledButOrganizationDisabled" billingSummary="Summarizes status, plans, etc." billingRecordId="35412" sourceDepartmentId="[sourceDepartmentId]" isBillingEnabled="true" utcBillingStart="1545230096.3937643" utcBillingThrough="1576766096.3937643" billingPlan="Subscription" billingPlanId="2" billingPeriod="Month" billingPeriodId="2" billingPeriodAmount="500.0" billingNotes="[Example notes... $500 per month, unlimited]" billingContact="Bilbo Baggins" billingContactEmail="Bilbo@BagEnd.co.uk" billingContactPhone="555-555-5555" />
</berkeResponse>
{
  "departmentBilling": {
    "wasChanged": true,
    "changeSummary": "[Example change summary... Billing changes recorded: 1: Billing Period Amount changed from [0.00] to [500.00]",
    "reasonForChange": "[Example reason... Upgraded from Basic Plan]",
    "billingStatus": "Enabled",
    "billingWarning": "BillingEnabledButOrganizationDisabled",
    "billingSummary": "Summarizes status, plans, etc.",
    "billingRecordId": 35412,
    "sourceDepartmentId": "[sourceDepartmentId]",
    "isBillingEnabled": true,
    "utcBillingStart": 1545230096.3937643,
    "utcBillingThrough": 1576766096.3937643,
    "billingPlan": "Subscription",
    "billingPlanId": 2,
    "billingPeriod": "Month",
    "billingPeriodId": 2,
    "billingPeriodAmount": 500.0,
    "billingNotes": "[Example notes... $500 per month, unlimited]",
    "billingContact": "Bilbo Baggins",
    "billingContactEmail": "Bilbo@BagEnd.co.uk",
    "billingContactPhone": "555-555-5555"
  },
  "status": "ok",
  "response": null,
  "responseCode": "200"
}
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="[!=ok]" response="[Error Message], [Parameter]=[[ParameterValue]]" responseCode="[!=200]" />
{
  "status": "[!=ok]",
  "response": "[Error Message], [Parameter]=[[ParameterValue]]",
  "responseCode": "[!=200]"
}
Successful Example Response

            

If successful, the response will include a departmentBilling node that contains the data you submitted.

If you pass in the exact data we already had on file, your submission will be ignored and the departmentBilling.wasChanged value will be false. departmentBilling.activeFromUtc will always reflect the last time a change was recorded.

activeFromUtc and activeThroughUtc dates are formatted in Unix time offset to UTC. Visit EpochConverter.com for a demonstration and code samples for converting to/from UTC Unix time.

billingRecordId is a non-contiguous, unique, permanent identifier that can used by accounting personnel to reference a specific billing record.

Handing Errors

All API requests include two extended HTTP headers in the response:

  • X-Response-Code
    Contains the HTTP status code (400, 200, etc.) and a Berke status code.
    The format is [Http Status Code].[Berke Status Code].
  • X-Response-Message
    Contains a message describing the X-Response-Code header.

If your request was successful, X-Response-Code will be 200.0. If the Berke response code is 1000 or greater, then an error occurred. For example, 403.1003 tells you that there was a HTTP 403 error (Forbidden). The 1003 Berke status code tells you the API key is invalid.

When an error occurs, further information can be found in the X-Response-Message header. For example, X-Response-Message will return API key '[API.Key.Sent.To.Berke]' is invalid or inactive if the API key was not authenticated.

The most common errors returned for this method are listed below.

Status Code Failed Example Responses

                
Most API exceptions are due to invalid parameters. Review the notes below each parameter as well as the output and HTTP response code from the error message. If all values are appropriate, the failure is likely authentication-related. Authentication failure types include, but are not limited to,:
  • Too many failed calls
  • Maximum per minute or per day API calls reached
  • API call made via insecure connection
  • Invalid API key
  • API is not enabled for target company
  • API is disabled for all companies (typically during maintenance)
  • Company is inactive or expired
  • Invalid username
  • User is inactive or expired
)
sourceDepartmentId was not found.
Most API exceptions are due to invalid parameters. Review the notes below each parameter as well as the output and HTTP response code from the error message. If all values are appropriate, the failure is likely authentication-related. Authentication failure types include, but are not limited to,:
  • Too many failed calls
  • Maximum per minute or per day API calls reached
  • API call made via insecure connection
  • Invalid API key
  • API is not enabled for target company
  • API is disabled for all companies (typically during maintenance)
  • Company is inactive or expired
  • Invalid username
  • User is inactive or expired
  • Unknown sourceJobId - check your API job assignments in the primary Berke customer site
  • Invalid assessment complete action

        
<?xml version="1.0" encoding="utf-16"?>
<berkeResponse status="[!=ok]" response="[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2018-12-19T14:34:55.7093897Z] to [2018-12-19T14:34:56.3093897Z]." responseCode="429" callDeniedDateTime="2018-12-19T14:34:56.4093897Z" callExpiresOnCompletion="true" countCallsExceeded="3" estimatedMillisecondsToNextAllowedCall="423" firstCallDeniedDateTime="2018-12-19T14:34:56.1093897Z" isDailyLimit="false" maximumCallsPerTimeFrame="120" timeFrameMilliseconds="60000" />
{
  "callDeniedDateTime": "2018-12-19T14:34:56.4093897Z",
  "callExpiresOnCompletion": true,
  "countCallsExceeded": 3,
  "estimatedMillisecondsToNextAllowedCall": 423,
  "firstCallDeniedDateTime": "2018-12-19T14:34:56.1093897Z",
  "isDailyLimit": false,
  "maximumCallsPerTimeFrame": 120,
  "timeFrameMilliseconds": 60000,
  "status": "[!=ok]",
  "response": "[API Method] API method requests exceeded burst limit of 120 occurrences within 60000 milliseconds. Excess requests occurred 3 times from [2018-12-19T14:34:55.7093897Z] to [2018-12-19T14:34:56.3093897Z].",
  "responseCode": "429"
}
API requests exceeded the maximum allowed per time-frame or the maximum allowed at any point in time.

API throttle limits are set per-company. Please login and return to this area to see your company's specific throttle configuration.

Your application can use the following API method response information to determine its course of action when HTTP status code 429 is returned by an API method call:

  • callDeniedDateTime: The date and time that the API method call was denied execution.
  • callExpiresUponCompletion: If this value is true then too many simultaneous calls occurred to a particular group of API methods. If this value is false then too many requests occurred for a particular time frame (daily or short-term).
  • countCallsExceeded: The count of calls that exceeded the maximum number of allowed API calls for the time frame.
  • estimatedMillisecondsToNextAllowedCall: The estimated number of milliseconds, from the callDeniedDateTime, before an API call will be allowed to execute. If callExpiresUponCompletion is true then this value will be zero as the time is dependent on numerous factors. If callExpiresUponCompletion is false then this value indicates the amount of time your application(s) should wait before attempting to make the same API method call. If a daily API call limit has been exceeded the this value indicates the amount of time your application(s) should wait before calling any API method.
  • firstCallDeniedDateTime: The date and time that the first call, of potentially many calls, was denied for the time frame. For example, if an application was denied ten calls within a time frame then firstCallDeniedDateTime indicates date and time that the first of the ten calls was denied.
  • isDailyLimit: If this value is true then the response indicates that the maximum number of API methods calls for the current day has been exceeded. If this value is false then the response indicates that the maximum number of API method calls for a time frame, other than daily, has been exceeded.
  • maximumCallsPerTimeFrame: Indicates the maximum number of times an API method can be called for daily, short-term or simultaneous call limits.
  • timeFrameMilliseconds: Indicates the number of milliseconds in which maximumCallsPerTimeFrame API method calls is allowed.