Ir al contenido

Obtener detalles de la factura

GET
/invoices/{id}

Devuelve información detallada sobre una factura específica. Requiere autenticación; solo devuelve documentos pertenecientes al usuario autenticado.

id
required

Document ID

integer
>= 1

ID de la factura

Invoice resource

Invoice details (JSON-LD)

object
@id

JSON-LD ID

string
@type

JSON-LD type

string
@context
One of:
string
id

Invoice ID

string
created_at

Creation date (unix timestamp)

integer
amount

Invoice amount

number
currency

Moneda

string
default: EUR
Allowed values: EUR CHF
status

Invoice status: 0 = New (unpaid), 1 = Success (paid), 2 = Failed

integer
Allowed values: 0 1 2
payment_type

Payment method: 1 = SEPA, 6 = Bank Transfer, 7 = PayPal, 8 = Sofort, 91 = Stored Card, 92 = New Card

integer
Allowed values: 1 6 7 8 91 92
paid_at

Payment date (unix timestamp), 0 if not paid

integer
client_name

Client company name

string
client_address

Client address

string
client_info

Client info line

string
vat

VAT percentage

number
vat_id

VAT identification number

string
vat_val

VAT value

number
fee

Fee percentage

number
fee_val

Fee value

number
net_val

Net cost value

number
iso2

ISO-2 country code

string
custom_text

Custom text on the invoice

string
pdf

URI to download invoice PDF

string
credit_note

URI to related credit note, null if none

string | null
key
additional properties
any
Examples
Example invoice_jsonld

Invoice detail example (JSON-LD)

Example response for GET /invoices/{id} with Accept: application/ld+json

{
"@context": "/contexts/Invoice",
"@id": "/invoices/44969",
"@type": "Invoice",
"id": "44969",
"created_at": 1626123015,
"amount": 24.63,
"currency": "EUR",
"status": 1,
"payment_type": 7,
"paid_at": 1626123015,
"client_name": "Example Customer Ltd.",
"client_address": "Main Street 42\n12345 Example City",
"client_info": "John Doe",
"vat": 19,
"vat_id": "DE123456789",
"vat_val": 3.93,
"fee": 3.5,
"fee_val": 0.72,
"net_val": 19.98,
"iso2": "DE",
"custom_text": "PO-2024-001",
"pdf": "/invoices/44969/pdf",
"credit_note": "/credit_notes/240"
}

El ID de cliente o la clave API no están activos o no son válidos.

La cuenta no está activada. Espere o póngase en contacto con el servicio de asistencia.

No se ha encontrado el recurso

La dirección IP fue bloqueada temporalmente, ya que durante poco tiempo se enviaron muchas solicitudes con credenciales no válidas. Espere y pruebe más tarde.

Code Samples

curl -s 'https://api.lox24.eu/invoices/34101' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq