Listar notas de crédito

GET

/credit_notes

Retorna uma lista paginada de notas de crédito para o usuário autenticado. Suporta filtragem por status, tipo de pagamento, intervalo de datas, intervalo de valor e IDs específicos.

Authorizations

token

Parameters

Query Parameters

page

integer

default: 1 >= 1 <= 1000000

Current page

_order[created_at]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Sort by timestamp when the entity was created

_order[amount]

Sort order direction (ascending or descending)

string

default: asc

Allowed values: asc desc

Ordenar por valor do documento

status

integer

Allowed values: 0 1 2

Filtro exato por status do documento

paymentType

integer

Allowed values: 1 6 7 8 91 92

Filtro exato por tipo de pagamento

Document ID

integer

>= 1

Filtro exato por ID do documento

id[]

Array<integer>

Filtro exato por múltiplos IDs de documentos

created_at

Creation timestamp

integer

Filtro exato por timestamp de criação

created_at[]

Array<integer>

Filtro exato e por intervalo de timestamps de criação

amount

Document amount

number

Filtro por intervalo do valor do documento (valor real, ex. 24.63 para 24.63 EUR)

amount[]

Array<number>

Filtro exato e por intervalo dos valores do documento (valores reais, ex. 24.63 para 24.63 EUR)

paid_at

Payment timestamp

integer

Filtro exato por timestamp de pagamento

paid_at[]

Array<integer>

Filtro exato e por intervalo de timestamps de pagamento

exists[paid_at]

boolean

Filtro de existência para status de pagamento: true = documentos pagos, false = documentos não pagos

Responses

200

Credit Note collection

object

@context

One of:

string
object

string

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

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

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 da nota de crédito

string

created_at

Data de criação (timestamp Unix)

integer

amount

Valor da nota de crédito

number

currency

Código da moeda

string

default: EUR

Allowed values: EUR CHF

status

Status da nota de crédito: 0 = Nova, 1 = Sucesso, 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 nota de crédito

string

pdf

URI para baixar o PDF da nota de crédito

string

invoice

URI para a fatura relacionada

string

key

additional properties

any

Examples

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

Invalid input

401

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

403

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

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/credit_notes' -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");
Console.WriteLine(response);

package main
import ("fmt"; "net/http"; "io")
func main() {
    req, _ := http.NewRequest("GET", "https://api.lox24.eu/credit_notes", 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")).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");
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);