Document

the Document API

create a new document

post
Body
transitionIdstringRequired

transition id

targetTypeIdinteger · int64Optional

Ggf. die ID der Ziel-Belegart

Responses
chevron-right
200

OK

*/*
post
/erp/documents
200

OK

update an existing document

put
Body
Responses
chevron-right
200

OK

*/*
put
/erp/documents
200

OK

return all possible states, the document can transferred into

get
Path parameters
idinteger · int64Required

document identifier

Query parameters
languageCodestringRequired
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/states
200

OK

transfer the document into the given state

put
Path parameters
idinteger · int64Required

document identifier

Body
transitionIdstringRequired

transition id

Responses
chevron-right
200

OK

*/*
put
/erp/documents/{id}/states
200

OK

put
Path parameters
idinteger · int64Required

ID des Belegs

protocolIdinteger · int64Required

ID des Eintrags im Belegprotokoll

Body

Request zur Anlage eines manuellen Eintrags ins Belegprotokoll

customMessagestringRequired

Text für das Belegprotokoll

Responses
chevron-right
200

OK

*/*
put
/erp/documents/{id}/protocol/{protocolId}
200

OK

get
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
Responseobject
get
/erp/documents/{id}/print
200

OK

put
Path parameters
idinteger · int64Required

document identifier

Body
exportFormatstring · enumOptional

output forma für mail/file-export

Possible values:
exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

OutputReportGroup Identifier (optional), sonst Default-Group des Moduls

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Responses
chevron-right
200

successful operation

Responseobject
put
/erp/documents/{id}/print

Verlängert eine Sperre

put
Path parameters
idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der zu verlängernden Sperre

Query parameters
leasePeriodinteger · int64Required

Optionale Lease-Dauer in Sekunden

Responses
chevron-right
200

OK

*/*
put
/erp/documents/{id}/leasable-lock/{lockToken}
200

OK

Gibt ein Sperre frei

delete
Path parameters
idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der freizugebenden Sperre

Responses
chevron-right
200

OK

No content

delete
/erp/documents/{id}/leasable-lock/{lockToken}
200

OK

No content

Aktualisiert ein Paket zu einem Beleg

put
Path parameters
documentIdinteger · int64Required
parcelIdinteger · int64Required
Body

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

Responses
chevron-right
200

OK

*/*
put
/erp/documents/{documentId}/parcel/{parcelId}
200

OK

update an existing document with changed position

put
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Body
Responses
chevron-right
200

OK

*/*
put
/erp/documents/document/{documentId}/line/{lineId}
200

OK

delete a line

delete
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
delete
/erp/documents/document/{documentId}/line/{lineId}
200

OK

moves a line to a new position

put
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
positioninteger · int32Required
Responses
chevron-right
200

OK

*/*
put
/erp/documents/document/{documentId}/line/{lineId}/move/{position}
200

OK

get finance booking information for documentLine

get
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
get
/erp/documents/document/{documentId}/line/{lineId}/financebooking
200

OK

update finance booking information for documentLine

put
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Body

FiBu-Buchung

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

documentLineIdinteger · int64Optional

Id der Dokumentzeile

ledgerNumberstringOptional

FiBu-Kontonummer

transactionKeystringOptional

Buchungsschlüssel

costCenter1stringOptional

Kostenstelle

commentstringOptional

Kommentar

descriptionstringOptional

Buchungstext

Responses
chevron-right
200

OK

*/*
put
/erp/documents/document/{documentId}/line/{lineId}/financebooking
200

OK

delete finance booking information for documentLine

delete
Path parameters
documentIdinteger · int64Required
lineIdinteger · int64Required
Responses
chevron-right
200

OK

No content

delete
/erp/documents/document/{documentId}/line/{lineId}/financebooking
200

OK

No content

verify the taxIdentificationNumber

post
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{id}/verifyTaxId
200

OK

list all available document-type-states to clone the current object into

get
Path parameters
idinteger · int64Required

document identifier

Query parameters
languageCodestringRequired
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/types
200

OK

create a new document, based on an existing one

post
Path parameters
idinteger · int64Required

the document identifier used as spec for the new document

Body
transitionIdstringRequired

transition id

targetTypeIdinteger · int64Optional

Ggf. die ID der Ziel-Belegart

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{id}/types
200

OK

Creates a shipment within the vds from a given document id

post
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{id}/shipment
200

OK

Lists all protocol entries for this document

get
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/protocol
200

OK

post
Path parameters
idinteger · int64Required

ID des Belegs

Body

Request zur Anlage eines manuellen Eintrags ins Belegprotokoll

customMessagestringRequired

Text für das Belegprotokoll

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{id}/protocol
200

OK

Prüft, ob eine Resource gesperrt ist

get
Path parameters
idinteger · int64Required

ID einer Resource

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/leasable-lock
200

OK

Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer

post
Path parameters
idinteger · int64Required

ID der zu sperrenden Resource

Query parameters
leasePeriodinteger · int64Optional

Optionale Lease-Dauer in Sekunden

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{id}/leasable-lock
200

OK

Versucht einen Auftrag in Kommissionierung zu übernehmen und protokolliert das Ergebnis

post
Path parameters
documentIdinteger · int64Required
picklistTemplateIdinteger · int64Required
Responses
chevron-right
200

OK

No content

post
/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}
200

OK

No content

Liefert die Pakete zu einem Beleg

get
Path parameters
documentIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{documentId}/parcels
200

OK

Erstellt ein Paket zu einem Beleg

post
Path parameters
documentIdinteger · int64Required
Body

Pakete zu Belegen

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

positioninteger · int32Optional

Position des Pakets

weightnumberOptional

Gewicht des Pakets

lengthnumberOptional

Länge

widthnumberOptional

Breite

heightnumberOptional

Höhe

trackingNumberstringRead-onlyOptional

Trackingnummer

Responses
chevron-right
200

OK

*/*
post
/erp/documents/{documentId}/parcels
200

OK

Create a Job according to the Request

post
Body

Request zur Erstellung des Jobs für Abrechnungen der Verträge

blackListinteger · int64[]Optional

Ignore ID-List

whiteListinteger · int64[]Optional

Use ID-List

documentDatestring · dateOptional

Abweichendes Belegdatum

deliveryDatestring · dateOptional

Abweichendes Lieferdatum

addBillingPeriodbooleanOptional

Abrechnungszeitraum hinzufügen?

Default: true
notestringOptional

Notiz

printbooleanOptional

Drucken?

Default: false
Responses
chevron-right
200

OK

*/*
post
/erp/documents/perform-contract-evaluation
200

OK

validate a document by using the validation service

post
Path parameters
documentIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
post
/erp/documents/document/{documentId}/validate
200

OK

add new lines to an existing document

post
Path parameters
documentIdinteger · int64Required
Body
Responses
chevron-right
200

OK

*/*
post
/erp/documents/document/{documentId}/multiple_lines
200

OK

add a new line to an existing document

post
Path parameters
documentIdinteger · int64Required
Body
Responses
chevron-right
200

OK

*/*
post
/erp/documents/document/{documentId}/line
200

OK

post
Path parameters
contractIdinteger · int64Required

ID eines Vertrags

contractLineIdinteger · int64Required

ID einer Vertragsposition

Responses
chevron-right
200

OK

*/*
post
/erp/documents/contract/{contractId}/deactivate-line/{contractLineId}
200

OK

post
Path parameters
contractIdinteger · int64Required

ID eines Vertrags

contractLineIdinteger · int64Required

ID einer Vertragsposition

Responses
chevron-right
200

OK

*/*
post
/erp/documents/contract/{contractId}/activate-line/{contractLineId}
200

OK

Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
Responsestring · enum

Status einer Workflow-Instanz

Possible values:
get
/erp/documents/{refId}/workflow-state

Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
get
/erp/documents/{refId}/workflow-instances-preset
200

Workflow-Instanz gefunden

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
get
/erp/documents/{refId}/latest-workflow-instance

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

*/*
get
/erp/documents/{id}

Lists all ui-hints for this document

get
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/ui-hints
200

OK

Lists all ui-hints for this document

get
Path parameters
idinteger · int64Required

document identifier

articleIdinteger · int64Required

article identifier

Responses
chevron-right
200

OK

*/*
Responsestring[]
get
/erp/documents/{id}/ui-hints/article/{articleId}
200

OK

Lists all ui-hints for this document

get
Path parameters
idinteger · int64Required

document identifier

accountIdinteger · int64Required

account identifier

Responses
chevron-right
200

OK

*/*
Responsestring[]
get
/erp/documents/{id}/ui-hints/account/{accountId}
200

OK

return a tree of predecessors and successors of this document

get
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/types/history
200

OK

Gibt die manuellen Textbausteine für Kopf-/Fußtexte zurück, die für das Dokument Sinn ergeben

get
Path parameters
idinteger · int64Required
Query parameters
textPositionstring · enumRequiredPossible values:
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/text-templates
200

OK

Lists successor document lines for predecessor assignment

get
Path parameters
idinteger · int64Required

ID of successor document

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/successor-document-assignable-lines
200

OK

Lists predecessor document lines for predecessor assignment

get
Path parameters
idinteger · int64Required

ID of predecessor document

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/predecessor-document-assignable-lines
200

OK

return all possible storages for this documentLine

get
Path parameters
idinteger · int64Required

document id

lineIdinteger · int64Required

document line id

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines/{lineId}/storages
200

OK

get
Path parameters
idinteger · int64Required

document id

lineIdinteger · int64Required

ID of the document line

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines/{lineId}/show-price-origin
200

OK

liefert dem dEK und letzten EK für ein Artikel einer DocumentLine

get
Path parameters
idinteger · int64Required

document id

lineIdinteger · int64Required

ID of the document line

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines/{lineId}/purchase-price-statistic
200

OK

Gibt die manuellen Textbausteine für Textpositionen zurück, die für das Dokument Sinn ergeben

get
Path parameters
idinteger · int64Required

document id

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines/text-templates
200

OK

Lists all orderable document lines

get
Path parameters
idinteger · int64Required

document identifier

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines-to-transfer-to-supplier-order
200

OK

List all lines allowed to transfer in supplier delivery

get
Path parameters
idinteger · int64Required

ID of supplier order

Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/lines-to-transfer-to-supplier-delivery
200

OK

returns the flat document without

get
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{id}/flat
200

OK

Liefert alle nicht zu Paketen zugewiesenen Belegpositionsbuchungen zu einem Beleg

get
Path parameters
documentIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{documentId}/parcels/unassigned-bookings
200

OK

get
Path parameters
documentIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
get
/erp/documents/{documentId}/availability
200

OK

return all available document-state-machine starting states

get
Query parameters
languageCodestringRequired
Responses
chevron-right
200

OK

*/*
get
/erp/documents/types
200

OK

Last updated

Was this helpful?