Ustawienia

Endpoint /settings pozwala odczytać i zmienić ustawienia konta, które wpływają na dokumenty wystawiane przez API: format daty oraz numerację dokumentów.

Wymagane zakresy uprawnień: settings:read (odczyt) i settings:update (zapis).

Odczyt ustawień#

curl -s https://prod.api.fakturnia.pl/external/v1/settings \
  -H "Authorization: Bearer $TOKEN"

{
  "success": true,
  "data": {
    "general": {
      "dateFormat": "dd.MM.yyyy",
      "newsletter": true,
      "dateFormatOptions": ["dd.MM.yyyy", "yyyy-MM-dd", "..."]
    },
    "numbering": {
      "numberingType": "MONTH",
      "numberingFormat": "/MM/YYYY",
      "numberingTypeOptions": ["MONTH", "YEAR"],
      "numberingFormatOptions": ["/MM/YYYY", "/YYYY", "..."],
      "documentSymbols": { "FakturaVAT": "FV", "FakturaKorygujaca": "KOR" }
    }
  }
}

Pola *Options to dopuszczalne wartości dla zapisu. Traktuj je jak słownik: pobierz przed wyświetleniem formularza użytkownikowi zamiast wpisywać wartości na sztywno.

Ustawienia ogólne#

curl -s -X PATCH https://prod.api.fakturnia.pl/external/v1/settings/general \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "dateFormat": "yyyy-MM-dd" }'

Numeracja dokumentów#

curl -s -X PATCH https://prod.api.fakturnia.pl/external/v1/settings/numbering \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "numberingType": "MONTH",
    "numberingFormat": "/MM/YYYY",
    "documentSymbols": { "FakturaVAT": "FV", "FakturaKorygujaca": "KOR" }
  }'

Wszystkie trzy pola są wymagane w tym żądaniu. Przy numberingType: "MONTH" format musi zawierać MM, inaczej dostaniesz 400.

Numeracja działa w połączeniu z automatycznym nadawaniem numerów przy tworzeniu dokumentów: jeśli nie podasz numeru, API nada kolejny zgodnie z tymi ustawieniami.