Skip to main content
GET
/
v1
/
{tenantUUID}
/
invoices
/
{invoiceUUID}
Get invoice
curl --request GET \
  --url https://apigw.ipxo.com/billing/v1/{tenantUUID}/invoices/{invoiceUUID} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "string",
  "tenant_uuid": "string",
  "invoice_number": "string",
  "date": 0,
  "date_due": 0,
  "date_paid": 0,
  "subtotal": 0,
  "subtotal_with_taxes": 0,
  "total": 0,
  "total_left_to_pay": 0,
  "total_paid": 0,
  "total_tax": 0,
  "status": "string",
  "items_count": 0,
  "items": [
    {
      "invoice_uuid": 0,
      "service_uuid": 0,
      "description": "string",
      "amount": 0,
      "taxed": 0,
      "period_start": 0,
      "period_end": 0,
      "type": "string",
      "metadata": {
        "<key1>": {},
        "<key2>": {},
        "<key..>": {},
        "<keyN>": {}
      }
    }
  ],
  "taxes": [
    {
      "description": "string",
      "percentage": 0,
      "amount": 0,
      "order": 0,
      "stacks": 0
    }
  ],
  "transactions": [
    {
      "invoice_uuid": 0,
      "service_uuid": 0,
      "description": "string",
      "amount": 0,
      "taxed": 0,
      "period_start": 0,
      "period_end": 0,
      "type": "string",
      "metadata": {
        "<key1>": {},
        "<key2>": {},
        "<key..>": {},
        "<keyN>": {}
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tenantUUID
string
required

UUID

Pattern: ^[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}$
​
invoiceUUID
string
required

UUID

Pattern: ^[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}$

Response

Invoice

​
uuid
string
​
tenant_uuid
string
​
invoice_number
string
​
date
integer
​
date_due
integer
​
date_paid
integer
​
subtotal
number<float>
​
subtotal_with_taxes
number<float>
​
total
number<float>
​
total_left_to_pay
number<float>
​
total_paid
number<float>
​
total_tax
number<float>
​
status
string
​
items_count
integer
​
items
object[]
​
taxes
object[]
​
transactions
object[]