Zum Inhalt springen
Developer

OfferAccountingType

Abrechnung4 EndpunkteBilling / OfferAccountingType

Liefert eine Liste aller OfferAccountingType-Objekte.

GET/api/invoice/offeraccountingtypes

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste aller OfferAccountingType-Objekte.array<OfferAccountingType>

Felder anzeigen (7)
  • idinteger

    Primärschlüssel des Angebots-Buchungstyps. Interne ID.

  • namestringPflicht

    Name der Buchungsart.

  • cancelled_namestring

    Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

  • typestringPflicht

    Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

  • conditionsstring

    Auf dem Angebot abgedruckte Bedingungen.

  • number_descriptionstring

    Beschreibung des Zahlenformats des Angebots.

  • deletedboolean

    Die Buchungsart wird gelöscht.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/offeraccountingtypes \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "number_description": "Text",
    "conditions": "string",
    "deleted": true
  }
]

OfferAccountingType neu anlegen

POST/api/invoice/offeraccountingtypes

Request-Body application/json

  • dataOfferAccountingType
    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Angebots-Buchungstyps. Interne ID.

    • namestringPflicht

      Name der Buchungsart.

    • cancelled_namestring

      Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

    • typestringPflicht

      Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

    • conditionsstring

      Auf dem Angebot abgedruckte Bedingungen.

    • number_descriptionstring

      Beschreibung des Zahlenformats des Angebots.

    • deletedboolean

      Die Buchungsart wird gelöscht.

Antworten

200OfferAccountingType neu anlegenOfferAccountingType

Felder anzeigen (7)
  • idinteger

    Primärschlüssel des Angebots-Buchungstyps. Interne ID.

  • namestringPflicht

    Name der Buchungsart.

  • cancelled_namestring

    Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

  • typestringPflicht

    Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

  • conditionsstring

    Auf dem Angebot abgedruckte Bedingungen.

  • number_descriptionstring

    Beschreibung des Zahlenformats des Angebots.

  • deletedboolean

    Die Buchungsart wird gelöscht.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/offeraccountingtypes \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "number_description": "Text",
    "conditions": "string"
  }
}
'
Antwort 200 application/json
{
  "name": "Beispiel",
  "type": "string",
  "id": 42,
  "cancelled_name": "Beispiel",
  "number_description": "Text",
  "conditions": "string",
  "deleted": true
}

Einzelnen OfferAccountingType abrufen

GET/api/invoice/offeraccountingtypes/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Einzelnen OfferAccountingType abrufenOfferAccountingType

Felder anzeigen (7)
  • idinteger

    Primärschlüssel des Angebots-Buchungstyps. Interne ID.

  • namestringPflicht

    Name der Buchungsart.

  • cancelled_namestring

    Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

  • typestringPflicht

    Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

  • conditionsstring

    Auf dem Angebot abgedruckte Bedingungen.

  • number_descriptionstring

    Beschreibung des Zahlenformats des Angebots.

  • deletedboolean

    Die Buchungsart wird gelöscht.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/offeraccountingtypes/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "name": "Beispiel",
  "type": "string",
  "id": 42,
  "cancelled_name": "Beispiel",
  "number_description": "Text",
  "conditions": "string",
  "deleted": true
}

OfferAccountingType aktualisieren

PUT/api/invoice/offeraccountingtypes/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataOfferAccountingType
    Felder anzeigen (7)
    • idinteger

      Primärschlüssel des Angebots-Buchungstyps. Interne ID.

    • namestringPflicht

      Name der Buchungsart.

    • cancelled_namestring

      Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

    • typestringPflicht

      Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

    • conditionsstring

      Auf dem Angebot abgedruckte Bedingungen.

    • number_descriptionstring

      Beschreibung des Zahlenformats des Angebots.

    • deletedboolean

      Die Buchungsart wird gelöscht.

Antworten

200OfferAccountingType aktualisierenOfferAccountingType

Felder anzeigen (7)
  • idinteger

    Primärschlüssel des Angebots-Buchungstyps. Interne ID.

  • namestringPflicht

    Name der Buchungsart.

  • cancelled_namestring

    Name, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.

  • typestringPflicht

    Art des Buchungstyps, zum Beispiel Angebot oder Vertrag.

  • conditionsstring

    Auf dem Angebot abgedruckte Bedingungen.

  • number_descriptionstring

    Beschreibung des Zahlenformats des Angebots.

  • deletedboolean

    Die Buchungsart wird gelöscht.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/invoice/offeraccountingtypes/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "number_description": "Text",
    "conditions": "string"
  }
}
'
Antwort 200 application/json
{
  "name": "Beispiel",
  "type": "string",
  "id": 42,
  "cancelled_name": "Beispiel",
  "number_description": "Text",
  "conditions": "string",
  "deleted": true
}