Get 9 recent billing periods
    • 16 Jul 2023
    • 1 Minute to read
    • Dark
      Light
    • PDF

    Get 9 recent billing periods

    • Dark
      Light
    • PDF

    Article Summary

    The API returns the 9 most recent billing period in the reverse chronological order (latest billing period appearing as the first item in the list)

    URL

    GET https://contoso-prod-api.azurewebsites.net/api/billingperiods

    Request headers

    Key

    Value

    Authorization

    Bearer <access_token>

    Content-Type

    Application/json

    Request body

    The request doesn’t require any parameters / body

    Response body

    An example response for the request to get active customers is as follows:

    {
        "OperationType": null,
        "Status": "Success",
        "RequestCorrelationID": "73e71bda-50b5-49a0-a70e-a000af402487",
        "ErrorMessage": null,
        "ErrorDetail": null,
        "Data": [
            {
                "ID": 24,
                "StartDate": "2022-05-16T00:00:00",
                "EndDate": "2022-06-15T00:00:00",
                "BillingId": "20220618"
            },
            {
                "ID": 23,
                "StartDate": "2022-04-16T00:00:00",
                "EndDate": "2022-05-15T00:00:00",
                "BillingId": "20220518"
            },
    

    Here is the explanation for the properties in the response (JSON)

    Property

    Description

    OperationType

    Can be ignored

    Status

    Indicates the status of the request. Possible values – Success / Error

    RequestCorrelationID

    Internal ID generated by C3 for correspondence for troubleshooting issues, if any.

    ErrorMessage

    Message in case the request runs into an error during processing

    ErrorDetail

    Additional detail related to the error in case there is an error while processing the request

    Data

    Contains a list of billing period objects represented by the following attributes:

    • ID – Identifier for the billing period
    • StartDate – Start date of the billing period
    • EndDate – End date of the billing period
    • BillingId – Friendly representation of the billing period and is the date when invoice is generated for the billing period ( in yyyyMMdd format )

    Was this article helpful?