List Invoices

Retrieve a list of invoices belonging to an entity.

GET /v1/entities/{entity_id}/invoices

List Invoices

cURL

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/invoices

200

{
  "invoices": [
    {
      "id": "<string>",
      "billing_month": 123,
      "billing_year": 123,
      "due_date": "<string>",
      "invoice_number": "<string>",
      "state": "INVOICE_STATE_UNSPECIFIED",
      "usd_amount_paid": 123,
      "usd_amount_owed": 123,
      "invoice_items": [
        {
          "description": "<string>",
          "currency_symbol": "<string>",
          "invoice_type": "INVOICE_TYPE_UNSPECIFIED",
          "rate": 123,
          "quantity": 123,
          "price": 123,
          "average_auc": 123,
          "total": 123
        }
      ]
    }
  ]
}

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

InvoiceService invoiceService = PrimeServiceFactory.createInvoiceService(client);

ListInvoicesRequest request = new ListInvoicesRequest.Builder("ENTITY_ID_HERE").build();

ListInvoicesResponse response = invoiceService.listInvoices(request);

For more information, please visit the Prime Java SDK.

.NET

var invoiceService = new InvoiceService(client);

var request = new ListInvoicesRequest("ENTITY_ID_HERE");

var response = invoiceService.ListInvoices(request);

For more information, please visit the Prime .NET SDK.

Go

invoiceService := invoice.NewInvoiceService(client)

request := &invoice.ListInvoicesRequest{
    EntityId: "ENTITY_ID_HERE",
}

response, err := invoiceService.ListInvoices(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = ListInvoicesRequest(
    entity_id="ENTITY_ID_HERE",
)

response = prime_client.list_invoices(request)

For more information, please visit the Prime Python SDK.

CLI

primectl list-invoices --help

For more information, please visit the Prime CLI.

TS/JS

const invoicesService = new InvoicesService(client);

invoicesService.listInvoices({
    entityId: 'ENTITY_ID_HERE'
}).then(async (response) => {
    console.log('Invoices: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

entity_id · string · required

The entity ID

Query Parameters

states · enum<string>[]

Invoice states to filter the response

Available options: INVOICE_STATE_UNSPECIFIED, INVOICE_STATE_IMPORTED, INVOICE_STATE_BILLED, INVOICE_STATE_PARTIALLY_PAID, INVOICE_STATE_PAID

billing_year · integer<int32>

Filter invoices by year

billing_month · integer<int32>

Integer representing the month to filter by, 1 for January, 12 for December

cursor · integer<int32>

Cursor used for pagination (last consumed record)

limit · integer<int32>

Number of items to retrieve

Response

200 - application/json

A successful response.

invoices · Invoice · object[]

Show child attributes