Skip to main content
GET
/
v1
/
c
/
invoice
cURL
curl --request GET \
  --url http://127.0.0.1:8080/v1/c/invoice \
  --header 'wb-key: <api-key>'
{
  "current_page": 123,
  "hits": [
    {
      "detailed_invoice_status": "pending_validation",
      "invoice": {
        "currency": "usd",
        "customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
        "date": "2023-11-07T05:31:56Z",
        "deposit_transaction_status": "not_processed",
        "due_date": "2023-11-07T05:31:56Z",
        "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
        "invoice_number": {
          "number": "<string>"
        },
        "status": "pending_validation",
        "total": "<string>",
        "deposit_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
        "external_reference": "<string>"
      },
      "payment_execution_provider": "stripe",
      "payment_execution_status": "pending"
    }
  ],
  "total": 123,
  "total_pages": 123,
  "backward": "<string>",
  "first": "<string>",
  "forward": "<string>",
  "last": "<string>"
}

Authorizations

​
wb-key
string
header
required

Query Parameters

​
customer
string

Unique identifier of an object. Consists of object class prefix and a UUID

Example:

"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"

​
date_before
string<date> | null
​
date_after
string<date> | null
​
limit
integer<int32>
Required range: x >= 0
​
offset
string | null
​
direction
enum<string>

Pagination direction:

  • Forward - from first entry to last
  • Backward - from last entry to first
Available options:
forward,
backward

Response

200 - application/json

List of invoices

A paginated result of the requested resource This is based on Keyset Pagination https://vladmihalcea.com/sql-seek-keyset-pagination/

​
current_page
integer
required

Number of the current page

​
hits
object[]
required
​
total
integer
required

Total number of results

​
total_pages
integer
required

Number of pages in the result

​
backward
string

Index of the previous page in the result set

​
first
string

Index of the first element in the result set

​
forward
string

Index of the next page in the result set

​
last
string

Index of the last element in the result set