Contracts - billingCalendar

Introduction

When editing Contracts, and Custom Billing Frequencies are enabled, you can predefine a Billing Calendar and select it in the Contract settings. In the API, the effect is observed in the billingCalendar field of the /contracts endpoint.

When the setting is enabled, and a Contract exists that doesn’t utilize it, its value will be null. But if a Contract does have it set, its value will be the ID of a Billing Calendar.

Billing Calendars can be created and updated using the endpoints:

  • contract-billing-calendars

  • contract-billing-calendar-dates

The ID held in contracts.billingCalendar, is the ID of a record in contract-billing-calendars.

Enable Custom Billing Frequencies

A new setting in the left panel navigation of Settings will appear:

Sans titre-20250305-200402.png

Configure a Billing Calendar

To be able to select a Billing Calendar in a contract, and have its ID assigned as a billingCalendar value, you need to create one first:

And then it becomes available as a choice when editing a Contract:

You may also create a Billing Calendar as two steps via the API by POSTing to contract-billing-calendars and contract-billing-calendar dates. Documentation on those two endpoints are:

contract-billing-calendars
https://profservices.staffr.net/rest/v1/2020-01-01/back-office-suite/common#tag/contract-billing-calendars

contract-billing-calendar-dates
https://profservices.staffr.net/rest/v1/2020-01-01/back-office-suite/common#tag/contract-billing-calendar-dates

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more