Neue API-Version v7.8.64 wurde veröffentlicht! 🎉
REST Dokumentation
PATCH Beleg aktualisieren

Beleg aktualisieren

Mit diesem Endpunkt können Sie einen bestehenden Beleg aktualisieren. Alle Felder sind optional; es werden nur die übermittelten Felder aktualisiert.

Request

PATCH /api/v1/receipts/:id
curl --request PATCH \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/receipts/123' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
  "note": "Berlin -> Hamburg (Deutsche Bahn) - Geschäftsreise",
  "project_task_id": 42
}'

Optionale Felder

Alle Felder sind optional. Sie können einzelne oder mehrere Felder gleichzeitig aktualisieren:

  • employee_id (string): Benutzername des Mitarbeiters (max. 255 Zeichen)
  • date (string): Belegdatum im Format YYYY-MM-DD
  • performance_date (string, nullable): Leistungsdatum im Format YYYY-MM-DD
  • receipt_type_id (string): Belegart-Kennung (max. 255 Zeichen)
  • project_id (integer): Projekt-ID
  • project_task_id (integer, nullable): Projektaufgaben-ID
  • payment_method (string): Zahlungsmethode (max. 255 Zeichen)
  • currency (string): Währungscode, z.B. EUR, USD (max. 32 Zeichen)
  • is_amount_net (boolean): Gibt an, ob der Betrag netto (true) oder brutto (false) ist
  • is_invoice_amount_net (boolean, nullable): Gibt an, ob der Rechnungsbetrag netto (true) oder brutto (false) ist. Erforderlich, wenn ein receiptAmount einen invoicing_share > 0 hat
  • note (string, nullable): Notizen zum Beleg (max. 255 Zeichen)
  • receiptAmounts (array): Array von Belegbeträgen
    • tax (number): Steuersatz in Prozent (0-100)
    • quantity (number): Menge (mindestens 1)
    • amount (number): Betrag (mindestens 0)
    • private_share (number, nullable): Privatanteil (mindestens 0)
    • invoicing_share (number, nullable): Abrechnungsanteil (mindestens 0)

Response

{
	"data": {
		"id": 123,
		"employee_id": "max.mustermann",
		"date": "2024-11-15",
		"receipt_type_id": "Fahrkarte",
		"currency": "EUR",
		"invoice_amount_currency": null,
		"note": "Berlin -> Hamburg (Deutsche Bahn) - Geschäftsreise",
		"payment_method": "privat",
		"breakfast": 0,
		"lunch_or_dinner": 0,
		"location": null,
		"is_amount_net": false,
		"is_invoice_amount_net": false,
		"billing_status": null,
		"performance_date": "2024-11-15",
		"client_id": null,
		"created": "2024-11-15T14:23:45.000000Z",
		"modified": "2024-11-16T09:12:30.000000Z",
		"invoice_item_id": null,
		"project_id": 456,
		"project_task_id": 42,
		"ticket_id": null,
		"subtask_id": null,
		"filename": "beleg_2024_11_15.pdf"
	}
}

Fehlercodes

  • 401 Unauthorized: Ungültige oder fehlende Authentifizierung
  • 404 Not Found: Beleg mit der angegebenen ID wurde nicht gefunden
  • 422 Unprocessable Entity: Validierungsfehler - überprüfen Sie die Request-Daten

Beispiele

Nur Notiz aktualisieren

PATCH /api/v1/receipts/123
{
	"note": "Aktualisierte Beschreibung für den Beleg"
}

Projekt und Projektaufgabe ändern

PATCH /api/v1/receipts/123
{
	"project_id": 789,
	"project_task_id": 15
}

Belegbeträge aktualisieren

PATCH /api/v1/receipts/123
{
	"is_invoice_amount_net": true,
	"receiptAmounts": [
		{
			"tax": 19.0,
			"quantity": 1,
			"amount": 95.00,
			"private_share": 0,
			"invoicing_share": 95.00
		}
	]
}

Mehrere Felder gleichzeitig aktualisieren

PATCH /api/v1/receipts/123
{
	"date": "2024-11-20",
	"performance_date": "2024-11-20",
	"payment_method": "Firmenkreditkarte",
	"note": "Korrigierte Angaben nach Rücksprache",
	"project_task_id": 28
}