Class RequestBuilder.Invoice

java.lang.Object
com.eqixiac.equinix.core.model.RequestBuilderBase<RequestBuilder.Invoice>
com.eqixiac.equinix.customerportal.client.RequestBuilder.Invoice
All Implemented Interfaces:
OptionalRequestBuilder<RequestBuilder.Invoice>
Enclosing class:
RequestBuilder
public static class RequestBuilder.Invoice extends RequestBuilderBase<RequestBuilder.Invoice>
Query filter for billing v2 GET /v2/invoices and GET /v2/invoices/details.

Every filter is optional in the billing v2 spec; only the filters that were set are sent. accountNumbers and transactionIds are declared style: form, explode: false in the spec, so several values are sent as one comma-separated parameter (accountNumbers=1,2).

  • Constructor Details

    • Invoice

      public Invoice()

  • Method Details

    • builder

      public static RequestBuilder.Invoice builder()
      Starts an empty invoice filter.
      Returns:
      a new builder

    • withStart

      public RequestBuilder.Invoice withStart(LocalDate startDate)
      Sets startDate.
      Parameters:
      startDate - start date of the invoice, or null to leave unset
      Returns:
      this builder

    • withEnd

      public RequestBuilder.Invoice withEnd(LocalDate endDate)
      Sets endDate.
      Parameters:
      endDate - end date of the invoice, or null to leave unset
      Returns:
      this builder

    • withAccountNumber

      public RequestBuilder.Invoice withAccountNumber(String accountNumber)
      Adds an account number to filter by; null or blank values are ignored.
      Parameters:
      accountNumber - billing account number
      Returns:
      this builder

    • withTransactionId

      public RequestBuilder.Invoice withTransactionId(String transactionId)
      Adds a transaction id to filter by; null or blank values are ignored.
      Parameters:
      transactionId - invoice or credit-memo transaction id
      Returns:
      this builder

    • build

      public RequestBuilder.Invoice build()
      Builds the query parameters from the filters that were set.
      Returns:
      this builder, marked as built