InvoicesApi.md

InvoicesApi

All URIs are relative to https://api.equinix.com/metal/v1

Method	HTTP request	Description
findOrganizationInvoices	GET /organizations/{id}/invoices	Retrieve all invoices for an organization
getInvoiceById	GET /invoices/{id}	Retrieve an invoice

findOrganizationInvoices

InvoiceList findOrganizationInvoices(id, page, perPage, status)

Retrieve all invoices for an organization

Returns all invoices for an organization

Example

// Import classes:
import com.equinix.openapi.ApiClient;
import com.equinix.openapi.ApiException;
import com.equinix.openapi.Configuration;
import com.equinix.openapi.auth.*;
import com.equinix.openapi.models.*;
import com.equinix.openapi.metal.v1.api.InvoicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.equinix.com/metal/v1");
    
    // Configure API key authorization: x_auth_token
    ApiKeyAuth x_auth_token = (ApiKeyAuth) defaultClient.getAuthentication("x_auth_token");
    x_auth_token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //x_auth_token.setApiKeyPrefix("Token");

    InvoicesApi apiInstance = new InvoicesApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Organization UUID
    Integer page = 56; // Integer | page number
    Integer perPage = 56; // Integer | per page
    String status = "status_example"; // String | filter by status
    try {
      InvoiceList result = apiInstance.findOrganizationInvoices(id, page, perPage, status);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvoicesApi#findOrganizationInvoices");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	UUID	Organization UUID
page	Integer	page number	[optional]
perPage	Integer	per page	[optional]
status	String	filter by status	[optional]

Return type

InvoiceList

Authorization

x_auth_token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ok	-
401	unauthorized	-
404	not found	-

getInvoiceById

Invoice getInvoiceById(id)

Retrieve an invoice

Returns the invoice identified by the provided id

Example

// Import classes:
import com.equinix.openapi.ApiClient;
import com.equinix.openapi.ApiException;
import com.equinix.openapi.Configuration;
import com.equinix.openapi.auth.*;
import com.equinix.openapi.models.*;
import com.equinix.openapi.metal.v1.api.InvoicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.equinix.com/metal/v1");
    
    // Configure API key authorization: x_auth_token
    ApiKeyAuth x_auth_token = (ApiKeyAuth) defaultClient.getAuthentication("x_auth_token");
    x_auth_token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //x_auth_token.setApiKeyPrefix("Token");

    InvoicesApi apiInstance = new InvoicesApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Invoice UUID
    try {
      Invoice result = apiInstance.getInvoiceById(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InvoicesApi#getInvoiceById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	UUID	Invoice UUID

Return type

Invoice

Authorization

x_auth_token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ok	-
401	unauthorized	-
404	not found	-