Get credit note details

GET

/credit_notes/{id}

Returns detailed information about a specific credit note. Requires authentication; only returns documents belonging to the authenticated user.

Authorizations

token

Parameters

Path Parameters

required

integer

Credit Note ID

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

Currency

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

Credit Note ID

string

created_at

Creation date (unix timestamp)

integer

amount

Credit note amount

number

currency

Currency

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_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

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

IP address was temporary blocked, because during short time from it was sent many request with invalid credentials. Please wait and try later.

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);