Obter detalhes da fatura

GET

/invoices/{id}

Retorna informações detalhadas sobre uma fatura específica. Requer autenticação; retorna apenas documentos pertencentes ao usuário autenticado.

Authorizations

token

Parameters

Path Parameters

required

Document ID

integer

>= 1

ID da fatura

Responses

200

Invoice resource

Invoice details (JSON-LD)

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

Invoice ID

string

created_at

Creation date (unix timestamp)

integer

amount

Invoice amount

number

currency

Currency

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

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"
}

Invoice details

object

ID da fatura

string

created_at

Data de criação (timestamp Unix)

integer

amount

Valor da fatura

number

currency

Código da moeda

string

default: EUR

Allowed values: EUR CHF

status

Status da fatura: 0 = Nova (não paga), 1 = Sucesso (paga), 2 = Falha

integer

Allowed values: 0 1 2

payment_type

Método de pagamento: 1 = SEPA, 6 = Transferência, 7 = PayPal, 8 = Sofort, 91 = Cartão salvo, 92 = Novo cartão

integer

Allowed values: 1 6 7 8 91 92

paid_at

Data de pagamento (timestamp Unix), 0 se não pago

integer

client_name

Nome da empresa do cliente

string

client_address

Endereço do cliente

string

client_info

Linha de informação do cliente

string

vat

Percentagem de IVA

number

vat_id

Número de identificação fiscal

string

vat_val

Valor do IVA

number

fee

Percentagem de taxa

number

fee_val

Valor da taxa

number

net_val

Valor do custo líquido

number

iso2

Código de país ISO-2

string

custom_text

Texto personalizado na fatura

string

pdf

URI para baixar o PDF da fatura

string

credit_note

URI para a nota de crédito relacionada, null se não houver

string | null

key

additional properties

any

Examples

invoice_json

Invoice detail example

Example response for GET /invoices/{id}

{
  "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"
}

401

Client ID or API key isn’t active or invalid!

403

Account isn’t activated. Please wait or contact to support!

404

Resource not found

429

O endereço IP foi bloqueado temporariamente, pois durante um curto período de tempo foram enviadas várias solicitações com credenciais inválidas. Aguarde e tente mais tarde.

Code Samples

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

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN");

        var response = await client.GetStringAsync("https://api.lox24.eu/invoices/34101");
        Console.WriteLine(response);
    }
}

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.lox24.eu/invoices/34101", nil)
  req.Header.Set("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN")

  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()
  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.lox24.eu/invoices/34101"))
                .header("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN")
                .GET()
                .build();

        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

<?php

$ch = curl_init('https://api.lox24.eu/invoices/34101');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;