Package com.mypurecloud.sdk.v2.api

Class BillingApi

java.lang.Object
com.mypurecloud.sdk.v2.api.BillingApi
public class BillingApi extends Object

  • Constructor Details

    • BillingApi

      public BillingApi()

    • BillingApi

      public BillingApi(ApiClient apiClient)

  • Method Details

    • getBillingContract

      public BillingContract getBillingContract(String contractId) throws IOException, ApiException
      Get billing contract Retrieve a single contract from the system. getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      contractId - The contract number. (required)
      Returns:
      BillingContract
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractWithHttpInfo

      public ApiResponse<BillingContract> getBillingContractWithHttpInfo(String contractId) throws IOException
      Get billing contract Retrieve a single contract from the system. getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      contractId - The contract number. (required)
      Returns:
      BillingContract
      Throws:
      IOException - if the request fails to be processed

    • getBillingContract

      public BillingContract getBillingContract(GetBillingContractRequest request) throws IOException, ApiException
      Get billing contract Retrieve a single contract from the system. getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      BillingContract
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContract

      public ApiResponse<BillingContract> getBillingContract(ApiRequest<Void> request) throws IOException
      Get billing contract Retrieve a single contract from the system. getBillingContract is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractBillingperiod

      public BillingContractPeriodDetail getBillingContractBillingperiod(String contractId, String billingPeriodId) throws IOException, ApiException
      Get contract billing period Fetch the billing information for a given Organization by billing period. getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      contractId - The contract number. (required)
      billingPeriodId - The Billing Period Id for the Org. (required)
      Returns:
      BillingContractPeriodDetail
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractBillingperiodWithHttpInfo

      public ApiResponse<BillingContractPeriodDetail> getBillingContractBillingperiodWithHttpInfo(String contractId, String billingPeriodId) throws IOException
      Get contract billing period Fetch the billing information for a given Organization by billing period. getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      contractId - The contract number. (required)
      billingPeriodId - The Billing Period Id for the Org. (required)
      Returns:
      BillingContractPeriodDetail
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractBillingperiod

      public BillingContractPeriodDetail getBillingContractBillingperiod(GetBillingContractBillingperiodRequest request) throws IOException, ApiException
      Get contract billing period Fetch the billing information for a given Organization by billing period. getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      BillingContractPeriodDetail
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractBillingperiod

      public ApiResponse<BillingContractPeriodDetail> getBillingContractBillingperiod(ApiRequest<Void> request) throws IOException
      Get contract billing period Fetch the billing information for a given Organization by billing period. getBillingContractBillingperiod is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingContracts

      public BillingContractListing getBillingContracts(String before, String after, String pageSize, LocalDate dateStart, LocalDate dateEnd, String status, String externalNumber) throws IOException, ApiException
      Get billing contracts Retrieve a list of contracts stored in the system. getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      dateStart - Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      status - Filter by the status of contracts (optional)
      externalNumber - Filter by the unique external number. (optional)
      Returns:
      BillingContractListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsWithHttpInfo

      public ApiResponse<BillingContractListing> getBillingContractsWithHttpInfo(String before, String after, String pageSize, LocalDate dateStart, LocalDate dateEnd, String status, String externalNumber) throws IOException
      Get billing contracts Retrieve a list of contracts stored in the system. getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      dateStart - Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      status - Filter by the status of contracts (optional)
      externalNumber - Filter by the unique external number. (optional)
      Returns:
      BillingContractListing
      Throws:
      IOException - if the request fails to be processed

    • getBillingContracts

      public BillingContractListing getBillingContracts(GetBillingContractsRequest request) throws IOException, ApiException
      Get billing contracts Retrieve a list of contracts stored in the system. getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      BillingContractListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContracts

      public ApiResponse<BillingContractListing> getBillingContracts(ApiRequest<Void> request) throws IOException
      Get billing contracts Retrieve a list of contracts stored in the system. getBillingContracts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceDocument

      public UrlResponse getBillingContractsInvoiceDocument(String invoiceId) throws IOException, ApiException
      Get invoice document Fetch the document for a specific invoice. getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      invoiceId - invoiceId (required)
      Returns:
      UrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceDocumentWithHttpInfo

      public ApiResponse<UrlResponse> getBillingContractsInvoiceDocumentWithHttpInfo(String invoiceId) throws IOException
      Get invoice document Fetch the document for a specific invoice. getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      invoiceId - invoiceId (required)
      Returns:
      UrlResponse
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceDocument

      public UrlResponse getBillingContractsInvoiceDocument(GetBillingContractsInvoiceDocumentRequest request) throws IOException, ApiException
      Get invoice document Fetch the document for a specific invoice. getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      UrlResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceDocument

      public ApiResponse<UrlResponse> getBillingContractsInvoiceDocument(ApiRequest<Void> request) throws IOException
      Get invoice document Fetch the document for a specific invoice. getBillingContractsInvoiceDocument is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceLines

      public BillingInvoiceItemListing getBillingContractsInvoiceLines(String invoiceId, String before, String after, String pageSize) throws IOException, ApiException
      Get invoice lines Fetch a list of all bills for the specified account. getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      invoiceId - invoiceId (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      BillingInvoiceItemListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceLinesWithHttpInfo

      public ApiResponse<BillingInvoiceItemListing> getBillingContractsInvoiceLinesWithHttpInfo(String invoiceId, String before, String after, String pageSize) throws IOException
      Get invoice lines Fetch a list of all bills for the specified account. getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      invoiceId - invoiceId (required)
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      Returns:
      BillingInvoiceItemListing
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceLines

      public BillingInvoiceItemListing getBillingContractsInvoiceLines(GetBillingContractsInvoiceLinesRequest request) throws IOException, ApiException
      Get invoice lines Fetch a list of all bills for the specified account. getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      BillingInvoiceItemListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoiceLines

      public ApiResponse<BillingInvoiceItemListing> getBillingContractsInvoiceLines(ApiRequest<Void> request) throws IOException
      Get invoice lines Fetch a list of all bills for the specified account. getBillingContractsInvoiceLines is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoices

      public BillingInvoiceListing getBillingContractsInvoices(String before, String after, String pageSize, LocalDate dateStart, LocalDate dateEnd, String paymentStatus) throws IOException, ApiException
      Get invoices Retrieve a list of invoices stored in the system. getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      dateStart - Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      paymentStatus - Payment Status (optional)
      Returns:
      BillingInvoiceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoicesWithHttpInfo

      public ApiResponse<BillingInvoiceListing> getBillingContractsInvoicesWithHttpInfo(String before, String after, String pageSize, LocalDate dateStart, LocalDate dateEnd, String paymentStatus) throws IOException
      Get invoices Retrieve a list of invoices stored in the system. getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional)
      dateStart - Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      dateEnd - End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
      paymentStatus - Payment Status (optional)
      Returns:
      BillingInvoiceListing
      Throws:
      IOException - if the request fails to be processed

    • getBillingContractsInvoices

      public BillingInvoiceListing getBillingContractsInvoices(GetBillingContractsInvoicesRequest request) throws IOException, ApiException
      Get invoices Retrieve a list of invoices stored in the system. getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      BillingInvoiceListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingContractsInvoices

      public ApiResponse<BillingInvoiceListing> getBillingContractsInvoices(ApiRequest<Void> request) throws IOException
      Get invoices Retrieve a list of invoices stored in the system. getBillingContractsInvoices is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingReportsBillableusage

      public BillingUsageReport getBillingReportsBillableusage(Date startDate, Date endDate) throws IOException, ApiException
      Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
      Parameters:
      startDate - The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (required)
      endDate - The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (required)
      Returns:
      BillingUsageReport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingReportsBillableusageWithHttpInfo

      public ApiResponse<BillingUsageReport> getBillingReportsBillableusageWithHttpInfo(Date startDate, Date endDate) throws IOException
      Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
      Parameters:
      startDate - The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (required)
      endDate - The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (required)
      Returns:
      BillingUsageReport
      Throws:
      IOException - if the request fails to be processed

    • getBillingReportsBillableusage

      public BillingUsageReport getBillingReportsBillableusage(GetBillingReportsBillableusageRequest request) throws IOException, ApiException
      Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
      Parameters:
      request - The request object
      Returns:
      BillingUsageReport
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingReportsBillableusage

      public ApiResponse<BillingUsageReport> getBillingReportsBillableusage(ApiRequest<Void> request) throws IOException
      Get a report of the billable license usages Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getBillingTrusteebillingoverviewTrustorOrgId

      public TrusteeBillingOverview getBillingTrusteebillingoverviewTrustorOrgId(String trustorOrgId, Integer billingPeriodIndex) throws IOException, ApiException
      Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/
      Parameters:
      trustorOrgId - The organization ID of the trustor (customer) organization. (required)
      billingPeriodIndex - 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. (optional, default to 0)
      Returns:
      TrusteeBillingOverview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingTrusteebillingoverviewTrustorOrgIdWithHttpInfo

      public ApiResponse<TrusteeBillingOverview> getBillingTrusteebillingoverviewTrustorOrgIdWithHttpInfo(String trustorOrgId, Integer billingPeriodIndex) throws IOException
      Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/
      Parameters:
      trustorOrgId - The organization ID of the trustor (customer) organization. (required)
      billingPeriodIndex - 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. (optional, default to 0)
      Returns:
      TrusteeBillingOverview
      Throws:
      IOException - if the request fails to be processed

    • getBillingTrusteebillingoverviewTrustorOrgId

      public TrusteeBillingOverview getBillingTrusteebillingoverviewTrustorOrgId(GetBillingTrusteebillingoverviewTrustorOrgIdRequest request) throws IOException, ApiException
      Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/
      Parameters:
      request - The request object
      Returns:
      TrusteeBillingOverview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getBillingTrusteebillingoverviewTrustorOrgId

      public ApiResponse<TrusteeBillingOverview> getBillingTrusteebillingoverviewTrustorOrgId(ApiRequest<Void> request) throws IOException
      Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed