Gutschriften auflisten

GET

/credit_notes

Gibt eine paginierte Liste von Gutschriften für den authentifizierten Benutzer zurück. Unterstützt Filterung nach Status, Zahlungsart, Datumsbereich, Betragsbereich und bestimmten IDs.

Authorizations

• token

Parameters

Query Parameters

page

integer

default: 1 >= 1 <= 1000000

Aktuelle Seite

_order[created_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Sortierung nach Zeitstempel, wann die Entität erstellt wurde

_order[amount]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Nach Dokumentbetrag sortieren

status

integer

Allowed values: 0 1 2

Exact Filter nach dem Dokumentstatus

paymentType

integer

Allowed values: 1 6 7 8 91 92

Exact Filter nach der Zahlungsart

id

Document ID

integer

>= 1

Exact Filter nach der Dokument-ID

id[]

Array<integer>

Exact Filter nach mehreren Dokument-IDs

created_at

Creation timestamp

integer

Exact Filter nach dem Erstellungszeitstempel

created_at[]

Array<integer>

Exact und Range Filter nach den Erstellungszeitstempeln

amount

Document amount

number

Range Filter nach dem Dokumentbetrag (Realwert, z.B. 24.63 für 24.63 EUR)

amount[]

Array<number>

Exact und Range Filter nach den Dokumentbeträgen (Realwerte, z.B. 24.63 für 24.63 EUR)

paid_at

Payment timestamp

integer

Exact Filter nach dem Zahlungszeitstempel

paid_at[]

Array<integer>

Exact und Range Filter nach den Zahlungszeitstempeln

exists[paid_at]

boolean

Exists Filter für den Zahlungsstatus: true = bezahlte Dokumente, false = unbezahlte Dokumente

Responses

200

Credit Note collection

object

@context

One of:

string

string

object

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

member

Array<object>

Credit note details (JSON-LD)

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string

string

object

object

@vocab

required

string

hydra

required

string

Allowed values: http://www.w3.org/ns/hydra/core#

key

additional properties

any

id

Credit Note ID

string

created_at

Creation date (unix timestamp)

integer

amount

Credit note amount

number

currency

Ihre Währung

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

hydra:totalItems

Total number of items in the collection

integer

hydra:view

Pagination links for navigating the collection

object

@id

string format: iri-reference

@type

string

hydra:first

string format: iri-reference

hydra:last

string format: iri-reference

hydra:previous

string format: iri-reference

hydra:next

string format: iri-reference

hydra:search

Search and filtering template for the collection

object

@type

string

hydra:template

string

hydra:variableRepresentation

string

hydra:mapping

Array<object>

object

@type

string

variable

string

property

string | null

required

boolean

key

additional properties

any

Examples

Example credit_notes_jsonld

Credit note list example (JSON-LD)

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

{
  "@context": "/contexts/CreditNote",
  "@id": "/credit_notes",
  "@type": "Collection",
  "totalItems": 1,
  "member": [
    {
      "@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",
      "type": 0,
      "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"
    }
  ],
  "view": {
    "@id": "/credit_notes?page=1",
    "@type": "PartialCollectionView"
  },
  "search": {
    "@type": "IriTemplate",
    "template": "/credit_notes{?_order[created_at],_order[amount],status,status[],payment_type,payment_type[],id,id[],createdAt[between],createdAt[gt],createdAt[gte],createdAt[lt],createdAt[lte],amount[between],amount[gt],amount[gte],amount[lt],amount[lte],paidAt[between],paidAt[gt],paidAt[gte],paidAt[lt],paidAt[lte]}",
    "variableRepresentation": "BasicRepresentation",
    "mapping": [
      {
        "@type": "IriTemplateMapping",
        "variable": "_order[created_at]",
        "property": "created_at",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "_order[amount]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "status",
        "property": "status",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "status[]",
        "property": "status",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "payment_type",
        "property": "payment_type",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "payment_type[]",
        "property": "payment_type",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "id",
        "property": "id",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "id[]",
        "property": "id",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "createdAt[between]",
        "property": "createdAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "createdAt[gt]",
        "property": "createdAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "createdAt[gte]",
        "property": "createdAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "createdAt[lt]",
        "property": "createdAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "createdAt[lte]",
        "property": "createdAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "amount[between]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "amount[gt]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "amount[gte]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "amount[lt]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "amount[lte]",
        "property": "amount",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "paidAt[between]",
        "property": "paidAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "paidAt[gt]",
        "property": "paidAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "paidAt[gte]",
        "property": "paidAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "paidAt[lt]",
        "property": "paidAt",
        "required": false
      },
      {
        "@type": "IriTemplateMapping",
        "variable": "paidAt[lte]",
        "property": "paidAt",
        "required": false
      }
    ]
  }
}

Array<object>

Credit note details

object

id

Gutschrifts-ID

string

created_at

Erstellungsdatum (Unix-Zeitstempel)

integer

amount

Gutschriftsbetrag

number

currency

Währungscode

string

default: EUR

Allowed values: EUR CHF

status

Gutschriftsstatus: 0 = Neu, 1 = Erfolgreich, 2 = Fehlgeschlagen

integer

Allowed values: 0 1 2

payment_type

Zahlungsmethode: 1 = SEPA, 6 = Überweisung, 7 = PayPal, 8 = Sofort, 91 = Gespeicherte Karte, 92 = Neue Karte

integer

Allowed values: 1 6 7 8 91 92

paid_at

Zahlungsdatum (Unix-Zeitstempel), 0 wenn nicht bezahlt

integer

client_name

Name des Kundenunternehmens

string

client_address

Kundenadresse

string

client_info

Kundeninfozeile

string

vat

MwSt.-Prozentsatz

number

vat_id

USt-Identifikationsnummer

string

vat_val

MwSt.-Wert

number

fee

Gebührenprozentsatz

number

fee_val

Gebührenwert

number

net_val

Nettobetrag

number

iso2

ISO-2-Ländercode

string

custom_text

Benutzerdefinierter Text auf der Gutschrift

string

pdf

URI zum Herunterladen des Gutschrifts-PDF

string

invoice

URI zur zugehörigen Rechnung

string

key

additional properties

any

Examples

Example credit_notes_json

Credit note list example (JSON)

Example response for GET /credit_notes with Accept: application/json

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

400

Ungültige Eingabe

401

Kunden-Nr oder API Key sind ungültig oder inaktiv!

403

Account ist noch nicht innerhalb von 24h nach Registrierung aktiviert. Bitte warten oder Support kontaktieren

429

Die IP-Adresse wurde vorübergehend blockiert, da in kurzer Zeit viele Anfragen mit ungültigen Anmeldeinformationen gesendet wurden. Bitte warten Sie und versuchen Sie es später.

Code Samples

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