Obtener detalles de la nota de crédito

GET

/credit_notes/{id}

Devuelve información detallada sobre una nota de crédito específica. Requiere autenticación; solo devuelve documentos pertenecientes al usuario autenticado.

Authorizations

token

Parameters

Path Parameters

required

Document ID

integer

>= 1

ID de la nota de crédito

Responses

200

Credit Note resource

Credit note details (JSON-LD)

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

Credit Note ID

string

created_at

Creation date (unix timestamp)

integer

amount

Credit note amount

number

currency

Moneda

string

default: EUR

Allowed values: EUR CHF

status

Credit note status: 0 = New, 1 = Success, 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 credit note

string

pdf

URI to download credit note PDF

string

invoice

URI to the related invoice

string

key

additional properties

any

Examples

credit_note_jsonld

Credit note detail example (JSON-LD)

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

{
  "@context": "/contexts/CreditNote",
  "@id": "/credit_notes/240",
  "@type": "CreditNote",
  "id": "240",
  "created_at": 1770140830,
  "amount": 0.01,
  "currency": "EUR",
  "status": 1,
  "payment_type": 6,
  "paid_at": 0,
  "client_name": "Example Customer Ltd.",
  "client_address": "Main Street 42\n12345 Example City",
  "client_info": "John Doe",
  "vat": 19,
  "vat_id": "DE123456789",
  "vat_val": 0,
  "fee": 0,
  "fee_val": 0,
  "net_val": 0.01,
  "iso2": "DE",
  "custom_text": "CN-2024-001",
  "pdf": "/credit_notes/240/pdf",
  "invoice": "/invoices/79484"
}

Credit note details

object

ID de la nota de crédito

string

created_at

Fecha de creación (timestamp Unix)

integer

amount

Importe de la nota de crédito

number

currency

Código de moneda

string

default: EUR

Allowed values: EUR CHF

status

Estado de la nota de crédito: 0 = Nueva, 1 = Exitosa, 2 = Fallida

integer

Allowed values: 0 1 2

payment_type

Método de pago: 1 = SEPA, 6 = Transferencia, 7 = PayPal, 8 = Sofort, 91 = Tarjeta guardada, 92 = Nueva tarjeta

integer

Allowed values: 1 6 7 8 91 92

paid_at

Fecha de pago (timestamp Unix), 0 si no pagado

integer

client_name

Nombre de la empresa del cliente

string

client_address

Dirección del cliente

string

client_info

Línea de información del cliente

string

vat

Porcentaje de IVA

number

vat_id

Número de identificación fiscal

string

vat_val

Valor del IVA

number

fee

Porcentaje de comisión

number

fee_val

Valor de la comisión

number

net_val

Valor del coste neto

number

iso2

Código de país ISO-2

string

custom_text

Texto personalizado en la nota de crédito

string

pdf

URI para descargar el PDF de la nota de crédito

string

invoice

URI a la factura relacionada

string

key

additional properties

any

Examples

credit_note_json

Credit note detail example

Example response for GET /credit_notes/{id}

{
  "id": "240",
  "created_at": 1770140830,
  "amount": 0.01,
  "currency": "EUR",
  "status": 1,
  "payment_type": 6,
  "paid_at": 0,
  "client_name": "Example Customer Ltd.",
  "client_address": "Main Street 42\n12345 Example City",
  "client_info": "John Doe",
  "vat": 19,
  "vat_id": "DE123456789",
  "vat_val": 0,
  "fee": 0,
  "fee_val": 0,
  "net_val": 0.01,
  "iso2": "DE",
  "custom_text": "CN-2024-001",
  "pdf": "/credit_notes/240/pdf",
  "invoice": "/invoices/79484"
}

401

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

403

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

404

No se ha encontrado el recurso

429

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/credit_notes/7' -H 'X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN' | jq

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN");
var response = await client.GetStringAsync("https://api.lox24.eu/credit_notes/7");
Console.WriteLine(response);

package main
import ("fmt"; "net/http"; "io")
func main() {
    req, _ := http.NewRequest("GET", "https://api.lox24.eu/credit_notes/7", nil)
    req.Header.Set("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN")
    resp, _ := http.DefaultClient.Do(req)
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

import java.net.http.*;
import java.net.URI;
var request = HttpRequest.newBuilder().uri(URI.create("https://api.lox24.eu/credit_notes/7")).header("X-LOX24-AUTH-TOKEN", "YOUR_API_TOKEN").build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

<?php
$ch = curl_init("https://api.lox24.eu/credit_notes/7");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-LOX24-AUTH-TOKEN: YOUR_API_TOKEN"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
curl_close($ch);