Get a list of available billing cycles

get/billing-cycles
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "startDayOfPeriod": 2,
    • "wholePeriod": false,
    • "lengthOfPeriod": 1,
    • "periodUnit": "DAILY",
    • "maxDaysBeforeCloseable": 15,
    • "maxDaysAfterCloseable": 15,
    • "maxBackDateableUsageInDays": 0,
    • "currencyCode": "GBP",
    • "defaultInvoiceDate": "TODAY",
    • "completionType": "DISABLED",
    • "autoCloseHour": 23,
    • "autoCloseMinute": 59,
    • "autoCloseOffsetDays": -15,
    • "autoCloseUserId": 1,
    • "billingCycleRules": [
      • {
        • "id": 1,
        • "type": "REVENUE",
        • "thresholdPercentage": 1,
        • "thresholdMinValue": 50000,
        • "thresholdMaxValue": 50000,
        • "active": true,
        • "comparisonPeriod": "THREE_PERIODS",
        • "comparisonBasedOn": "VALUE"
        }
      ],
    • "billingCycleStats": [
      • {
        • "type": "REVENUE",
        • "value": 0,
        • "comparisonPeriod": "THREE_PERIODS"
        }
      ]
    }
]