/Documents/{documentKey}
Description
Reads a document using the document key. This is made up of the type and number of the document.
Request
URI Parameters
documentKey
string
Required
Body Parameters
None.
Response
Resource Description
ExtraFieldsWithType
Collection of ExtraFieldWithType
Nur lesen
The extra fields of the document with the information on the data type.
Number
string
Länge: einschließlich zwischen 0 und 10
Nur lesen
[Beleg.Belegnummer]
KindFlag
string
Länge: einschließlich zwischen 0 und 1
Nur lesen
[Beleg.Belegtyp] A - Angebot Kunde | B - Bestellung | E - Eingangsrechnung | F - Auftrag | G - Gutschrift | I - Inventur | L - Lieferschein | N - Anfrage | P - Packzettel | R - Rechnung
GrossAmount
decimal number
Nur lesen
[BELEG.Brutto]
GrossAmountInEuro
decimal number
Nur lesen
[BELEG.EuroBrutto]
ForeignCurrencyGrossAmount
decimal number
Nur lesen
[BELEG.FremdwaehrungBrutto]
NetAmount
decimal number
Nur lesen
[BELEG.Netto]
NetAmountInEuro
decimal number
Nur lesen
[BELEG.EuroNetto]
ForeignCurrencyNetAmount
decimal number
Nur lesen
[BELEG.FremdwaehrungNetto]
TaxAmount
decimal number
Nur lesen
[BELEG.Steuer]
TaxAmountInEuro
decimal number
Nur lesen
[BELEG.EuroSteuer]
ForeignCurrencyTaxAmount
decimal number
Nur lesen
[BELEG.FremdwaehrungSteuer]
ProceedsAmount
decimal number
Nur lesen
Roherlös [BELEG.Erloes]
ProceedsAmountInEuro
decimal number
Nur lesen
Roherlös [BELEG.ErloesEuro]
OutstandingTakeoverAmount
decimal number
Nur lesen
[BELEG.UebernahmeOffen]
TaxIdentifierNumber
string
Länge: einschließlich zwischen 0 und 20
[BELEG.UStID]
ProjectId
integer
Nur lesen
[BELEG.Projekt]
InvoiceKind
string
Länge: einschließlich zwischen 0 und 15
Nur lesen
[BELEG.RTyp] A - Abschlagsrechnung | T - Teilrechnung |S - Schlussrechnung
IsExtendedManufacturingOrder
boolean
Nur lesen
[BELEG.WerkauftragErweitert]
OriginKindFlag
integer
Nur lesen
[BELEG.Herkunft] -1 - Beleg zum Lesen bereitgestellt | 0 - Unbekannte Herkunft, Makroassi, Importassi | 1 - Belegdialoge, Übernahme 2 - COM | 3 - EDI | 4 - CSV 5 - SL.mobile 6 - Vorschlagsliste Wartungsbelege | 7 - Vorschlagsliste Verträge | 8 - Leistungserfassung 9 - Komplettbestellung, Geteilte Bestellung | 10 - Vorschlagsliste Werkaufträge | 11 - Einzahlungsscheine
OutstandingPositionStatus
string
Nur lesen
OP Status
ContractNumber
string
Nur lesen
Open status
MetaData
Nur lesen
Clients for the data rate
Version
integer
Nur lesen
Versionsnummer
Weight
decimal number
[BELEG.Gewicht]
ExtraText
string
Nur lesen
Extra text
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)
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 (economic group) fields are only required for the CH version. WIR is a complementary currency (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
AlternativeWirCurrencyPercent
decimal number
WIR (economic group) fields are only required for the CH version. WIR is a complementary currency (http://de.wikipedia.org/wiki/Komplement%C3%A4rw%C3%A4hrung#Schweiz)
AlternativeWirCurrencyKind
string
Länge: einschließlich zwischen 0 und 1
WIR (economic group) fields are only required for the CH version. WIR is a complementary currency (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)
TrafficRouteKind
string
Länge: einschließlich zwischen 0 und 1
[BELEG.Verkehrszweig] 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
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
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
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]
ROW
integer
Time stamp
Response Formats
application/json
Example:
{
"ROW": 1,
"ExtraFieldsWithType": [
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
},
{
"Name": "sample string 1",
"Value": "sample string 2",
"Type": "sample string 3"
}
],
"Number": "sample string 1",
"KindFlag": "sample string 2",
"GrossAmount": 3.1,
"GrossAmountInEuro": 4.1,
"ForeignCurrencyGrossAmount": 5.1,
"NetAmount": 6.1,
"NetAmountInEuro": 7.1,
"ForeignCurrencyNetAmount": 8.1,
"TaxAmount": 9.1,
"TaxAmountInEuro": 10.1,
"ForeignCurrencyTaxAmount": 11.1,
"ProceedsAmount": 12.1,
"ProceedsAmountInEuro": 13.1,
"OutstandingTakeoverAmount": 14.1,
"TaxIdentifierNumber": "sample string 15",
"ProjectId": 16,
"InvoiceKind": "sample string 17",
"IsExtendedManufacturingOrder": true,
"OriginKindFlag": 19,
"OutstandingPositionStatus": "sample string 20",
"ContractNumber": "sample string 21",
"MetaData": {
"CreationDate": "2024-12-27T02:05:28.408412+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-27T02:05:28.408412+01:00",
"ModificationUserToken": "sample string 2"
},
"Version": 22,
"Weight": 23.1,
"ExtraText": "sample string 24",
"Date": "2024-12-27T02:05:28.408412+01:00",
"BusinessPartner": {
"BusinessPartnerReferenceNumber": "sample string 1",
"ReferenceAddressNumber": "sample string 2",
"BusinessPartnerContract": "sample string 3",
"BusinessPartnerContractDate": "2024-12-27T02:05:28.408412+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-27T02:05:28.408412+01:00",
"FinancialAccountClause": "sample string 15",
"IsPaymentLock": true,
"CostCenterNumber": "sample string 17"
},
"IsPrinted": true,
"EmployeeNumber": "sample string 26",
"EmployeeLabel": "sample string 27",
"SalesmanNumber": "sample string 28",
"SalesmanLabel": "sample string 29",
"WarehouseNumber": "sample string 30",
"WarehouseLabel": "sample string 31",
"CurrencyCode": "sample string 32",
"CurrencyLabel": "sample string 33",
"CurrencyExchangeRate": 34.1,
"DeliveryTermNumber": "sample string 35",
"DeliveryTermLabel": "sample string 36",
"DeliveryText": "sample string 37",
"DeliveryText2": "sample string 38",
"PriceGroupNumber": "sample string 39",
"PriceGroupLabel": "sample string 40",
"PriceKindFlag": "sample string 41",
"DiscountGroupNumber": "sample string 42",
"DiscountGroupLabel": "sample string 43",
"DiscountAmount": 44.1,
"CashDiscountDays": 45,
"CashDiscountDaysKind": 46,
"CashDiscountPercent": 47.1,
"CashDiscountLabel": "sample string 48",
"CashDiscount2Days": 49,
"CashDiscount2DaysKind": 50,
"CashDiscount2Percent": 51.1,
"CashDiscount2Label": "sample string 52",
"AlternativeWirCurrencyAmount": 53.1,
"AlternativeWirCurrencyPercent": 54.1,
"AlternativeWirCurrencyKind": "sample string 55",
"DeliveryDate": "2024-12-27T02:05:28.408412+01:00",
"StatusLabel": "sample string 56",
"OurReference": "sample string 57",
"LanguageCode": "sample string 58",
"LanguageLabel": "sample string 59",
"DeliveryDocumentNumber": "sample string 60",
"MaintenanceContractReference": 61,
"DefaultPrintTemplate": "sample string 62",
"BillingAddress": "sample string 63",
"RateKind": 64,
"FixedRate": 65.1,
"EuropeanCountryCode": "sample string 66",
"TrafficRouteKind": "sample string 67",
"TrafficRouteKindLabel": "sample string 68",
"InternationalLocationNumber": "sample string 69",
"NativeInvoiceRecipientNumber": "sample string 70",
"EdiStatusKind": "sample string 71",
"EdiStatusLabel": "sample string 72",
"ValutaDate": "2024-12-27T02:05:28.408412+01:00",
"WarehouseLocationNumber": "sample string 73",
"WarehouseLocationLabel": "sample string 74",
"PositionTotalRoundNearest": 75,
"TotalRoundNearest": 76,
"AssociationRegulatorNumber": "sample string 77",
"DelcrederePercent": 78.1,
"StockTransferCode": "sample string 79",
"DisplayName": "sample string 80",
"ReturnMerchandiseAuthorizationNumber": "sample string 81",
"ReportCountryCode": "sample string 82",
"CustomField": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-12-27T02:05:28.408412+01:00",
"Date2": "2024-12-27T02:05:28.408412+01:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
},
"StatusFlag": "sample string 83",
"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 84",
"HeaderText": "sample string 85",
"FooterText": "sample string 86",
"SurchargeArticleNumber": "sample string 87"
}