/Documents/{documentKey}
Description
Processes a document using the document key.
- Uses backend process
Request
URI Parameters
documentKey
string
Required
Body Parameters
ExtraFields
Dictionary of string [key]
and string [value]
The extra fields of the document.
PositionExtraFields
Dictionary of string [key]
and Dictionary of string [key]
and string [value] [value]
The extra fields of the document.
Date
date
[Beleg.Datum]
BusinessPartner
Business partner details
Payment
Payment details for documents
IsPrinted
boolean
[BELEG.Gedruckt]
EmployeeNumber
string
Länge: einschließlich zwischen 0 und 6
[BELEG.Mitarbeiter]
EmployeeLabel
string
Employee designation
SalesmanNumber
string
Länge: einschließlich zwischen 0 und 6
[BELEG.Vertreter]
SalesmanLabel
string
Representative designation
WarehouseNumber
string
Länge: einschließlich zwischen 0 und 10
[BELEG.Lager]
WarehouseLabel
string
Storage name
CurrencyCode
string
Länge: einschließlich zwischen 0 und 3
[BELEG.Waehrungscode]
CurrencyLabel
string
Currency designation
CurrencyExchangeRate
decimal number
[BELEG.Waehrungsfaktor]
DeliveryTermNumber
string
Länge: einschließlich zwischen 0 und 6
[BELEG.Lieferbedingung]
DeliveryTermLabel
string
Supply conditions designation
DeliveryText
string
Länge: einschließlich zwischen 0 und 80
[BELEG.LText1]
DeliveryText2
string
Länge: einschließlich zwischen 0 und 80
[BELEG.LText2]
PriceGroupNumber
string
Länge: einschließlich zwischen 0 und 2
[BELEG.Preisgruppe]
PriceGroupLabel
string
Price groups designation
PriceKindFlag
string
Länge: einschließlich zwischen 0 und 1
[BELEG.PreisTyp]
N - NetAmountto | B - Brutto | S - steuerfrei | E -EG (nur Eingangsbelege)
N - NetAmountto | B - Brutto | S - steuerfrei | E -EG (nur Eingangsbelege)
DiscountGroupNumber
string
Länge: einschließlich zwischen 0 und 6
[BELEG.Rabattgruppe]
DiscountGroupLabel
string
Discount groups designation
DiscountAmount
decimal number
[BELEG.Belegrabatt]
CashDiscountDays
integer
[BELEG.Skontotage1]
CashDiscountDaysKind
integer
[BELEG.Skontotage1typ]
CashDiscountPercent
decimal number
[BELEG.Skontoprozent1]
CashDiscountLabel
string
CashDiscount1designation
CashDiscount2Days
integer
[BELEG.Skontotage2]
CashDiscount2DaysKind
integer
[BELEG.Skontotage2typ]
CashDiscount2Percent
decimal number
[BELEG.Skontoprozent]
CashDiscount2Label
string
CashDiscount2designation
AlternativeWirCurrencyAmount
decimal number
WIR (Wirtschaftsring)-Felder werden nur für die CH-Version benötigt.
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
AlternativeWirCurrencyPercent
decimal number
WIR (Wirtschaftsring)-Felder werden nur für die CH-Version benötigt.
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
AlternativeWirCurrencyKind
string
Länge: einschließlich zwischen 0 und 1
WIR (Wirtschaftsring)-Felder werden nur für die CH-Version benötigt.
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
WIR ist eine Komplementärwährung (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
DeliveryDate
date
[BELEG.Liefertermin]
StatusLabel
string
Status name
OurReference
string
Länge: einschließlich zwischen 0 und 40
[BELEG.UnserZeichen]
LanguageCode
string
Länge: einschließlich zwischen 0 und 6
[BELEG.Sprache]
LanguageLabel
string
Language name
DeliveryDocumentNumber
string
Länge: einschließlich zwischen 0 und 40
[BELEG.LieferBelegNr]
MaintenanceContractReference
integer
Reference to maintenance contract (V)
DefaultPrintTemplate
string
Länge: einschließlich zwischen 0 und 260
Previous or standard printing template
BillingAddress
string
Länge: einschließlich zwischen 0 und 13
[BELEG.RechAdresse]
RateKind
integer
[BELEG.Kurstyp]
FixedRate
decimal number
[BELEG.Fixkurs]
EuropeanCountryCode
string
Länge: einschließlich zwischen 0 und 2
[BELEG.EULand]
benötigt für Intrastat (Innergemeinschaftliche Handelsstatistik)
benötigt für Intrastat (Innergemeinschaftliche Handelsstatistik)
TrafficRouteKind
string
Länge: einschließlich zwischen 0 und 1
[BELEG.Verkehrszweig]
benötigt für Intrastat (Innergemeinschaftliche Handelsstatistik)
benötigt für Intrastat (Innergemeinschaftliche Handelsstatistik)
TrafficRouteKindLabel
string
Mode of transport designation
InternationalLocationNumber
string
Länge: einschließlich zwischen 0 und 35
Die Global Location Number (GLN) dient zur weltweit eindeutigen Identifikation von Unternehmen. Früher wurde sie International Location Number (ILN) genannt. [BELEG.ILNNummer]
NativeInvoiceRecipientNumber
string
Länge: einschließlich zwischen 0 und 35
[BELEG.Orignummer]
EdiStatusKind
string
Länge: einschließlich zwischen 0 und 1
[BELEG.EDIStatus]
O - offen | B - versandbereit | V - versendet
O - offen | B - versandbereit | V - versendet
EdiStatusLabel
string
Status name
ValutaDate
date
[BELEG.ValutaDatum]
WarehouseLocationNumber
string
Länge: einschließlich zwischen 0 und 10
[BELEG.Standort]
WarehouseLocationLabel
string
Location name
PositionTotalRoundNearest
integer
[BELEG.RundungPos]
TotalRoundNearest
integer
[BELEG.RundungBel]
AssociationRegulatorNumber
string
Länge: einschließlich zwischen 0 und 10
[BELEG.VerbandsKLNr]
DelcrederePercent
decimal number
[BELEG.Delkredere]
StockTransferCode
string
Länge: einschließlich zwischen 0 und 12
[BELEG.Umlagerung]
Format: Belegtyp|Belegnummer
Format: Belegtyp|Belegnummer
DisplayName
string
Länge: einschließlich zwischen 0 und 80
[BELEG.Anzeigename]
ReturnMerchandiseAuthorizationNumber
string
Länge: einschließlich zwischen 0 und 10
[BELEG.RMANummer]
ReportCountryCode
string
Länge: einschließlich zwischen 0 und 2
[BELEG.Meldeland]
CustomField
The 'free fields' of document.
StatusFlag
string
[BELEG.Status]
0 - Offen / Bearbeitung abgeschlossen | 1 - Bei Werkaufträgen begonnen | 2 - Erledigt | 3 - Manuell erledigt
4 - Storniert bei Kassenbelegen | 5 - In Bearbeitung | 6 - Geparkt
0 - Offen / Bearbeitung abgeschlossen | 1 - Bei Werkaufträgen begonnen | 2 - Erledigt | 3 - Manuell erledigt
4 - Storniert bei Kassenbelegen | 5 - In Bearbeitung | 6 - Geparkt
DeliveryAddress
The differing supply address
PaymentReference
string
[Beleg.Zahlungsreferenz]
HeaderText
string
Header text
FooterText
string
Footer
SurchargeArticleNumber
string
Länge: einschließlich zwischen 0 und 18
[BELEG.Belegaufschlagsartikel]
Request Formats
application/json
Example:
{
"ExtraFields": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"PositionExtraFields": {
"sample string 1": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"sample string 2": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
"Date": "2024-12-27T00:16:39.5901439+01:00",
"BusinessPartner": {
"BusinessPartnerReferenceNumber": "sample string 1",
"ReferenceAddressNumber": "sample string 2",
"BusinessPartnerContract": "sample string 3",
"BusinessPartnerContractDate": "2024-12-27T00:16:39.5901439+01:00",
"ContactPersonId": 4,
"LastName": "sample string 5",
"Company": "sample string 6",
"Salutation": "sample string 7",
"FirstName": "sample string 8",
"Address": {
"Number": "sample string 1",
"Street": "sample string 2",
"City": "sample string 3",
"ZipCode": "sample string 4",
"CountryId": "sample string 5",
"AdditionalInformation1": "sample string 6",
"AdditionalInformation2": "sample string 7",
"AdditionalInformation3": "sample string 8"
}
},
"Payment": {
"BankingDetailsId": 1,
"BankAccount": "sample string 2",
"IsCashSale": true,
"PaymentTerm": "sample string 4",
"PaymentTermLabel": "sample string 5",
"PaymentPeriod": 6,
"PaymentPeriodLabel": "sample string 7",
"PaymentPeriodKind": 8,
"PaymentDocumentReferenceNumber": "sample string 9",
"FinancialAccountNumber": "sample string 10",
"BankAccountGroup": "sample string 11",
"BankAccountGroupLabel": "sample string 12",
"CostCenterLabel": "sample string 13",
"FinancialAccountExportDate": "2024-12-27T00:16:39.5901439+01:00",
"FinancialAccountClause": "sample string 15",
"IsPaymentLock": true,
"CostCenterNumber": "sample string 17"
},
"IsPrinted": true,
"EmployeeNumber": "sample string 2",
"EmployeeLabel": "sample string 3",
"SalesmanNumber": "sample string 4",
"SalesmanLabel": "sample string 5",
"WarehouseNumber": "sample string 6",
"WarehouseLabel": "sample string 7",
"CurrencyCode": "sample string 8",
"CurrencyLabel": "sample string 9",
"CurrencyExchangeRate": 10.1,
"DeliveryTermNumber": "sample string 11",
"DeliveryTermLabel": "sample string 12",
"DeliveryText": "sample string 13",
"DeliveryText2": "sample string 14",
"PriceGroupNumber": "sample string 15",
"PriceGroupLabel": "sample string 16",
"PriceKindFlag": "sample string 17",
"DiscountGroupNumber": "sample string 18",
"DiscountGroupLabel": "sample string 19",
"DiscountAmount": 20.1,
"CashDiscountDays": 21,
"CashDiscountDaysKind": 22,
"CashDiscountPercent": 23.1,
"CashDiscountLabel": "sample string 24",
"CashDiscount2Days": 25,
"CashDiscount2DaysKind": 26,
"CashDiscount2Percent": 27.1,
"CashDiscount2Label": "sample string 28",
"AlternativeWirCurrencyAmount": 29.1,
"AlternativeWirCurrencyPercent": 30.1,
"AlternativeWirCurrencyKind": "sample string 31",
"DeliveryDate": "2024-12-27T00:16:39.5901439+01:00",
"StatusLabel": "sample string 32",
"OurReference": "sample string 33",
"LanguageCode": "sample string 34",
"LanguageLabel": "sample string 35",
"DeliveryDocumentNumber": "sample string 36",
"MaintenanceContractReference": 37,
"DefaultPrintTemplate": "sample string 38",
"BillingAddress": "sample string 39",
"RateKind": 40,
"FixedRate": 41.1,
"EuropeanCountryCode": "sample string 42",
"TrafficRouteKind": "sample string 43",
"TrafficRouteKindLabel": "sample string 44",
"InternationalLocationNumber": "sample string 45",
"NativeInvoiceRecipientNumber": "sample string 46",
"EdiStatusKind": "sample string 47",
"EdiStatusLabel": "sample string 48",
"ValutaDate": "2024-12-27T00:16:39.5901439+01:00",
"WarehouseLocationNumber": "sample string 49",
"WarehouseLocationLabel": "sample string 50",
"PositionTotalRoundNearest": 51,
"TotalRoundNearest": 52,
"AssociationRegulatorNumber": "sample string 53",
"DelcrederePercent": 54.1,
"StockTransferCode": "sample string 55",
"DisplayName": "sample string 56",
"ReturnMerchandiseAuthorizationNumber": "sample string 57",
"ReportCountryCode": "sample string 58",
"CustomField": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-12-27T00:16:39.5901439+01:00",
"Date2": "2024-12-27T00:16:39.5901439+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
},
"StatusFlag": "sample string 59",
"DeliveryAddress": {
"Number": 1,
"Salutation": "sample string 2",
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Company": "sample string 6",
"Department": "sample string 7",
"Function": "sample string 8",
"Priority": 9,
"InternationalLocationNumber": "sample string 10",
"Address": {
"Street": "sample string 1",
"City": "sample string 2",
"ZipCode": "sample string 3",
"CountryFlag": "sample string 4",
"AdditionalInformation1": "sample string 5",
"AdditionalInformation2": "sample string 6",
"AdditionalInformation3": "sample string 7"
},
"PostOfficeBox": {
"Number": "sample string 1",
"ZipCode": "sample string 2",
"City": "sample string 3",
"CountryId": "sample string 4"
},
"Contact": {
"FaxNumber": "sample string 1",
"TelephoneNumber1": "sample string 2",
"TelephoneNumber2": "sample string 3",
"TelephoneNumber3": "sample string 4",
"EMail": "sample string 5",
"HomePageUrl": "sample string 6"
}
},
"PaymentReference": "sample string 60",
"HeaderText": "sample string 61",
"FooterText": "sample string 62",
"SurchargeArticleNumber": "sample string 63"
}
Response
Resource Description
None.