...
...
...
...
Info |
---|
Die PEIQ Ad API bietet Zugang den Daten aus dem PEIQ PRINT Werbemarkt:
Mit der PEIQ Ad API können Geschäftspartner- und kaufmännische Anzeigendaten übertragen, geändert und abgerufen werden. Strukturdaten, Anzeigenmotive und Seitenbelege können ebenso abgerufen werden. |
...
Die PEIQ Ad API ist nach dem restful Prinzip und nach OpenAPI Specification aufgebaut.
PEIQ entwickelt eine Ad API für die zentralen Usecases des PEIQ Werbemarkt.
Nicht alle Funktionen des PEIQ Werbemarktes sind über die Ad API steuerbar. Funktionen, die über die API ausgeführt werden können, können auch im PEIQ Werbemarkt benutzt werden. Funktionen, die dem PEIQ Werbemarkt vorbehalten sind, werden durch die Ad API nicht beeinflusst.
Empfohlene Workflows für Anbindung an die PEIQ Ad API
...
Note |
---|
Bei der Vorliegenden Dokumentation zur Ad API handelt es sich um eine generische API. Es kann sein, dass bestimmte Anwendungsfälle nicht durch die API abgedeckt sind. Demzufolge kann es vorkommen, dass nicht alle in der API beschriebenen Felder in NGEN wiedergefunden werden können. Kundenspezifische Konfigurationen können beispielsweise auch dazu führen, dass hier beschriebene Felder in NGEN nicht zur Verfügung stehen und nicht verwendet werden können. |
Bereiche der Ad API
Der aktuelle Funktionsumfang kann über Swagger UI eingesehen werden:
Info |
---|
Ad API Swagger-UI (Beta) |
Die Bereitstellung der Zugangsdaten zur Authentizifierung erfolgt durch PEIQ.
Inhaltsverzeichnis API-Ebenen
Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|
API-
...
Endpunkt “Structure data”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
|
| /ads/values/categories | Get tree of all categories for ads. | |||
|
| /ads/values/ |
assignments | Get a list of all |
assignments | |||||
|
| /ads/values/types | Get all ad types | |||
|
| /ads/values/producttypes | Get all ad product types | |||
|
| /ads/values/billingclients | Get all billing clients | ||||||
| /ads/values/bookableissues | Get all bookable issues | ||||||
Level of Ad API
Name
Description
Function
Structure data - Categories
values
Returns a list with all values of the addressed endpoint.
Structure data - Categories; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Categories; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Categories; "values"
subitems
Lists child entries of a related record.
Structure data - Categories; "values"; "subitems"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Categories; "values"; "subitems"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Categories; "values"; "subitems"
subitems
Lists child entries of a related record.
Structure data - Categories; "values"; "subitems"; "subitems"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Categories; "values"; "subitems"; "subitems"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Editions
values
Returns a list with all values of the addressed endpoint.
Structure data - Editions; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Editions; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Types
values
Returns a list with all values of the addressed endpoint.
Structure data - Types; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Types; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Types; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Types; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Product Types
values
Returns a list with all values of the addressed endpoint.
Structure data - Product Types; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Product Types; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Product Types; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Product Types; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients
values
Returns a list with all values of the addressed endpoint.
Structure data - Billing clients; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients; "values"
id
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
Structure data - Billing clients; "values"
label
Name of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
API-Ebene “Business Partners”
...
Status | ||||
---|---|---|---|---|
|
...
/businesspartners
...
Create Business Partner
...
Status | ||||
---|---|---|---|---|
|
...
/businesspartners/{number}
...
Update Business Partner by unique (NGEN) number
...
Status | ||||
---|---|---|---|---|
|
...
/businesspartners/{number}
...
Get Business Partner Information by unique (NGEN) number
...
Status | ||||
---|---|---|---|---|
|
...
/businesspartners/search
...
Search for Business Partner
...
Status | ||||
---|---|---|---|---|
|
...
/businesspartners/events
...
Get changed Business Partner Information since last retrieval
...
...
Level of Ad API
...
Name
...
Description
...
Function
...
Business Partners
...
number
...
Unique number of the business partner (in NGEN).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Business Partners
...
number_remote
...
Unique number of the business partner (remote System).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Business Partners
...
type
...
Classification of the present business partner by type.
Examples:
Is it a private, or business customer?
Is it an agency, an employee, or an agent?
...
Controls the functions in the system, which depend on the business partner type.
...
Business Partners
...
acronym
...
Unique identifier of the business partner.
...
Assignment of editorial content to author/honoree.
...
Business Partners
...
status
...
Status of the business partner.
...
Controls whether the business partner is active, or inactive (e.g. whether orders can be entered for him).
...
Business Partners
...
website
...
The website of the business partner.
...
Business Partners
...
vat_id
...
The tax identification number of the business partner.
...
Business Partners
...
vat_type
...
Value added tax rate.
...
VAT rate that applies to this customer by default.
...
Business Partners
...
address
...
Information about the address data of the business partner.
...
Business Partners; "address"
...
main
...
Lists information about the address type "main address".
...
Business Partners; "address"; "main"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "main"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "main"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "main"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "main"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "main"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "main"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "main"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "main"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "main"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "main"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "main"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "main"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "main"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "main"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "main"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "main"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "main"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "main"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "main"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners; "address"
...
billing
...
Lists information about the address type "billing address".
...
Business Partners; "address"; "billing"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "billing"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "billing"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "billing"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "billing"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "billing"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "billing"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "billing"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "billing"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "billing"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "billing"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "billing"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "billing"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "billing"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "billing"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "billing"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "billing"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "billing"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "billing"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"; "purposes"
...
name
...
Der Name einer Firma, oder eines Verbandes.
Der Nachname, im Falle einer Person.
...
Der Name einer Firma, oder eines Verbandes.
Der Nachname, im Falle einer Person.
...
Business Partners; "address"; "billing"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners; "address"
...
document
...
Lists information about the address type "document address".
...
Business Partners; "address"; "document"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "document"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "document"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "document"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "document"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "document"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "document"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "document"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "document"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "document"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "document"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "document"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "document"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "document"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "document"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "document"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "document"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "document"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "document"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "document"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners; "address"
...
cipher
...
Lists information about the address type "cipher address".
...
Business Partners; "address"; "cipher"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "cipher"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "cipher"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "cipher"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "cipher"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "cipher"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "cipher"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "cipher"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "cipher"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "cipher"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "cipher"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "cipher"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "cipher"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "cipher"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "cipher"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "cipher"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "cipher"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "cipher"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "cipher"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "cipher"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners; "address"
...
home
...
Lists information about the address type "private address".
...
Business Partners; "address"; "home"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "home"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "home"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "home"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "home"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "home"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "home"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "home"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "home"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "home"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "home"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "home"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "home"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "home"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "home"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "home"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "home"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "home"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "home"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "home"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners; "address"
...
other
...
Lists information about the address type "other address".
...
Business Partners; "address"; "other"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Business Partners; "address"; "other"
...
addresses
...
The address data of the business partner.
...
Business Partners; "address"; "other"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Business Partners; "address"; "other"; "addresses"
...
title
...
The title of the business partner.
...
Business Partners; "address"; "other"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Business Partners; "address"; "other"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "other"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners; "address"; "other"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Business Partners; "address"; "other"; "addresses"
...
name_extension
...
Name affix.
...
Business Partners; "address"; "other"; "addresses"
...
street_name
...
Specification of the street name.
...
Business Partners; "address"; "other"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Business Partners; "address"; "other"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Business Partners; "address"; "other"; "addresses"
...
po_box
...
Post office box number.
...
Business Partners; "address"; "other"; "addresses"
...
zip
...
Zip code.
...
Business Partners; "address"; "other"; "addresses"
...
city
...
City.
...
Business Partners; "address"; "other"; "addresses"
...
country
...
Country,
...
Business Partners; "address"; "other"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Business Partners; "address"; "other"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Business Partners; "address"; "other"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners; "address"; "other"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Business Partners
...
business_partner_information
...
Business Partner Information.
...
Business Partners; "business_partner_information"
...
billing_client
...
Invoice client (sales organization).
...
Controls validity of this record for a given invoice client.
...
Business Partners; "business_partner_information"
...
client_name
...
Client.
...
Assignment to client in case of client separation.
...
Business Partners; "business_partner_information"
...
customer_group
...
Customer group.
...
Group can be used for price calculations.
...
Business Partners; "business_partner_information"
...
tariff_class
...
Tariff class.
...
Group can be used for price calculations.
...
Business Partners; "business_partner_information"
...
credit_limit
...
Credit Limit.
...
Total amount of open items above which a credit check is triggered.
...
Business Partners; "business_partner_information"
...
credit_rating_category
...
Credit Rating Class.
...
Informative, can be used for checks during order entry.
...
Business Partners; "business_partner_information"
...
credit_rating_index
...
Credit Rating Index.
...
Informative, can be used for checks during order entry.
...
Business Partners; "business_partner_information"
...
dunning_block
...
Dunning block.
...
Informative, can be used for checks during order entry.
...
Business Partners; "business_partner_information"
...
discount
...
Amount of discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Business Partners; "business_partner_information"
...
additional_discount_type
...
Type of additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Business Partners; "business_partner_information"
...
additional_discount
...
Amount of the additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Business Partners; "business_partner_information"
...
agency_commission
...
Agency Commission.
...
Is taken over when creating new orders and can be used for price calculation.
...
Business Partners; "business_partner_information"
...
invoice_type
...
Billing type.
...
Controls whether the order is included in a collective invoice, whether it is invoiced individually, or whether no invoice is created at all.
...
Business Partners; "business_partner_information"
...
invoicing_period
...
Billing rhythm.
...
Controls whether the order is charged intermediately, or only at the end of the month.
...
Business Partners; "business_partner_information"
...
invoice_copies
...
Number of invoice copies.
...
Business Partners; "business_partner_information"
...
invoice_delivery
...
Invoice delivery method.
...
Specifies the way an invoice is to be delivered.
...
Business Partners; "business_partner_information"
...
payment_method
...
Payment method.
...
Specifies how the invoice is to be paid.
...
Business Partners; "business_partner_information"
...
invoice_proof_type
...
Document category for invoicing.
...
Controls what type of receipt is sent when an invoice is created.
...
Business Partners; "business_partner_information"
...
invoice_proof_quantity
...
Number of vouchers for invoicing.
...
Controls how many receipts are sent with invoices.
...
Business Partners; "business_partner_information"
...
publication_proof_type
...
Document category on appearance.
...
Controls what type of receipt is sent on appearance.
...
Business Partners; "business_partner_information"
...
publication_proof_quantity
...
Number of vouchers on appearance.
...
Controls how many vouchers are sent on appearance.
...
Business Partners; "business_partner_information"
...
discount_agreement
...
Percentage of the discount.
...
Business Partners; "business_partner_information"
...
term_of_payment_discount
...
Payment term discount in days.
...
Business Partners; "business_partner_information"
...
term_of_payment_net_amount
...
Payment term Net amount in days.
...
Business Partners; "business_partner_information"
...
topics
...
Set of topics assigned to the customer.
...
Business Partners; "business_partner_information"; "topics"
...
name
...
Individual topics assigned to the customer.
...
Business Partners; "business_partner_information"
...
external_balance
...
External balance.
...
Business Partners; "business_partner_information"
...
valexternal_balance_dateid_from
...
Date of the external balance.
...
Business Partners; "business_partner_information"
...
economic_sectors
...
Lists information about industries, the customer is assigned to.
...
Business Partners; "business_partner_information"; "economic_sectors"
...
name
...
Entries for individual industries.
...
Business Partners; "business_partner_information"
...
credit_amount
...
Credit Limit.
...
Business Partners; "business_partner_information"
...
text
...
Business Partners; "business_partner_information"
...
compendium
...
Business Partners; "business_partner_information"
...
proof_type_manually
...
Manual receipt delivery.
...
Business Partners; "business_partner_information"
...
block_automatically
...
Automatically set lock indicator.
...
Business Partners; "business_partner_information"
...
block_manually
...
Manually set lock indicator.
...
Business Partners; "business_partner_information"
...
field1
...
Business Partners; "business_partner_information"
...
field2
...
Business Partners; "business_partner_information"
...
term_of_payment
...
Term of payment.
...
Business Partners; "business_partner_information"
...
agents
...
List of representatives assigned in the invoice client-specific customer data.
...
Business Partners; "business_partner_information"; "agents"
...
number
...
Unique business partner number of a representative.
...
Business Partners
...
contact_persons
...
Number of contact persons.
...
Business Partners; "contact_persons"
...
number
...
Unique number of the advertisement.
...
Allows unique identification of the advertisement, e.g. during searches, or during updates.
...
Business Partners - Search
...
offset
...
Specifies the offset for the query.
...
If no offset is specified, the IDs of the first changed records are returned.
...
Business Partners - Search
...
data
...
Listing of the data set for the specified search criteria.
...
Business Partners - Search; "data"
...
number
...
Unique number of the business partner (in NGEN).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Business Partners - Search; "Parameters (search criteria)"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Business Partners - Search; "Parameters (search criteria)"
...
first_name
...
The first name (Only if it is a person).
...
Business Partners - Search; "Parameters (search criteria)"
...
street_name
...
Specification of the street name.
...
Business Partners - Search; "Parameters (search criteria)"
...
zip
...
Zip code.
...
Business Partners - Search; "Parameters (search criteria)"
...
city
...
City.
...
Business Partners - Search; "Parameters (search criteria)"
...
country
...
Country,
...
Business Partners - Search; "Parameters (search criteria)"
...
phone_number
...
Phone number of the business partner.
...
Business Partners - Search; "Parameters (search criteria)"
...
country_code
...
Country code of the business partner.
...
Business Partners - Search; "Parameters (search criteria)"
...
area_code
...
Area code of the business partner.
...
Business Partners - Search; "Parameters (search criteria)"
...
...
E-Mail of the business partner.
...
Business Partners - Search; "Parameters (search criteria)"
...
offset
...
Specifies the offset for the query.
...
If no offset is specified, the IDs of the first changed records are returned.
...
Business Partners - Search; "Parameters (search criteria)"
...
limit
...
Limit value.
...
Limit value for the length of the result array used for paging (Default is 1. Max limit is 100.).
...
Business Partners - Events
...
data
...
Listing of the data set for the specified search criteria.
...
Business Partners - Events; "data"
...
number
...
Unique number of the business partner (in NGEN).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Business Partners - Events; "Parameters (search criteria)"
...
limit
...
Limit value.
...
Limit value for the length of the result array used for paging (Default is 1. Max limit is 100.).
...
Business Partners - Events; "Parameters (search criteria)"
...
offset
...
Specifies the offset for the query.
...
If no offset is specified, the IDs of the first changed records are returned.
API-Ebene “Account Details” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/accountdetails/{number}
...
Update SEPA account details
...
Status | ||||
---|---|---|---|---|
|
...
/accountdetails/{number}
...
Get SEPA account details
...
...
Level of Ad API
...
Name
...
Description
...
Function
...
Account Details
...
billing_client
...
Invoice client (sales organization).
...
Controls validity of this record for a given invoice client.
...
Account Details
...
iban
...
International Bank Account Number.
...
Account Details
...
address
...
Address data of the bank.
...
Lists information about the address data of the bank.
...
Account Details; "address"
...
name
...
The name of the Bank.
...
Account Details; "address"
...
zip
...
Zip code.
...
Account Details; "address"
...
city
...
City.
...
Account Details; "address"
...
country
...
Country,
...
Account Details
...
account_holder
...
Account holder.
...
Specifies the account holder of the bank account.
...
Account Details
...
authorisation_through
...
Authorized until [...].
...
Specifies the authorization date of the bank account.
...
Account Details
...
valid_from
...
Bank account valid from [...].
...
Indicates that this bank account will be used from this date.
...
Account Details
...
mandate_reference
...
Mandate reference.
...
Account Details
...
is_default
...
Bank account is default account.
...
Specifies that this bank account is automatically used as the default.
API-Ebene “Advertisements” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/ads
...
Create new ad
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/ads/{number}
...
Update ad by unique (NGEN) number
...
Status | ||||
---|---|---|---|---|
|
...
/ads/{number}
...
Get ad by unique (NGEN) number
...
Status | ||||
---|---|---|---|---|
|
...
/ads/search
...
Search for ads
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/ads/events
...
Get changed ads since last retrieval
...
Status | ||||
---|---|---|---|---|
|
...
/ads/images/{number}
...
Update image data for ad
...
Status | ||||
---|---|---|---|---|
|
...
/ads/images/{number}/{resolution}
...
Get an image of the advertisement by unique NGEN number
...
...
Level of Ad API
...
Name
...
Description
...
Function
...
Advertisements
...
order
...
Unique number of the order.
...
Specifies the unique number of the order, the advertisement belongs to.
...
Advertisements
...
type
...
Classification of the present advertisement according to type.
Examples:
Is it a text-, word-, or customer supplied advertisement?
...
Controls the functions in the system that depend on the advertisement type.
...
Advertisements
...
status
...
Status of the advertisement.
...
Controls if the ad is still in the planning stage or if it is ready for printing/exposure.
...
Advertisements
...
assignment
...
Assignment.
...
Specifies the amount of issues, or a combo with different issues, in which the ad should appear.
...
Advertisements
...
category
...
Advertisement section.
...
Controls in which section the advertisement appears.
...
Advertisements
...
product_type
...
Product type.
...
Controls in which part of a product the ad appears (e.g. ad section, or text section).
...
Advertisements
...
issues
...
Individual bookings of the advertisement.
...
Advertisements; "IssueModel"
...
edition
...
Edition.
...
Edition of the respective booking.
...
Advertisements; "IssueModel"
...
date
...
Publication date.
...
Publication date of the respective booking.
...
Advertisements; "IssueModel"
...
category
...
Category.
...
Category of the respective booking.
...
Advertisements; "IssueModel"
...
combi_number
...
Combi number.
...
Specifies to which combi the respective appearance belongs to.
...
Advertisements; "IssueModel"
...
combi_name
...
Combi name.
...
Name of the combi the appearance belongs to.
...
Advertisements
...
width_booked_unit
...
Booked width (unit).
...
Specifies the unit of the width specification in the "width_booked_value" field.
...
Advertisements
...
width_booked_value
...
Booked width (value).
...
Specifies the value for the booked width.
...
Advertisements
...
height_booked_unit
...
Booked height (unit).
...
Specifies the unit of the height specification in the "height_booked_value" field.
...
Advertisements
...
height_booked_value
...
Booked height (value).
...
Specifies the value for the booked height.
...
Advertisements
...
word_count
...
Word count.
...
Specifies the number of words that are relevant for the price calculation in the ad text.
...
Advertisements
...
word_count_extra
...
Word count - extra.
...
Specifies the number of words to be calculated with a special price.
...
Advertisements
...
colors_booked
...
Booked colors.
...
Specifies which colors are booked.
...
Advertisements
...
colors_to_charge
...
Number of colors to be calculated.
...
Specifies how many colors should be included in the price calculation.
...
Advertisements
...
url
...
Web address.
...
URL to be opened when the ad is clicked in the e-paper.
...
Advertisements
...
design_notes
...
Set of design characteristics.
...
Relevant for both ad production and price calculations.
...
Advertisements; "Design Notes"
...
note
...
Single design characteristic.
...
Specifies information about the layout of the advertisement.
...
Advertisements
...
placement_note
...
Placement Information.
...
Free text for the planner.
...
Advertisements
...
heading
...
Invoice text.
...
Keyword of the advertisement for invoice text, or list view.
...
Advertisements
...
online_start
...
Start date.
...
Specifies when the advertisement will be published online.
...
Advertisements
...
online_end
...
End date.
...
Specifies when the advertisement will go offline.
...
Advertisements
...
cipher
...
Cipher data for the advertisement.
...
Amount of data needed for a cipher.
...
Advertisements; "CipherModel"
...
number
...
Cipher number.
...
Number to assign cipher responses.
...
Advertisements; "CipherModel"
...
delivery_type
...
Delivery method.
...
Delivery method for cipher responses.
...
Advertisements
...
production_status
...
Production status.
...
Specifies the current status of the production of the advertisement motif.
...
Advertisements
...
height_booked_mm
...
Booked height in milimeters.
...
Advertisements
...
width_booked_mm
...
Booked width in milimeters.
...
Advertisements
...
category_long
...
Long name of the category.
...
Advertisements
...
height_fix
...
Fixed height.
...
If "false", the height of the advertisement is variable from the ad production point of view.
...
Advertisements
...
columns
...
Number of columns.
...
Advertisements
...
production_timestamp
...
Timestamp for ad production.
...
Specifies the time of the last change, relevant for the ad production.
...
Advertisements
...
production_status_timestamp
...
Timestamp for production status.
...
Advertisements
...
proof_emails
...
Amount of e-mail addresses for the galley proof ("copy proof").
...
Advertisements; "proof_emails"
...
mail_address
...
Single e-mail address for the galley proof ("copy proof").
...
Advertisements
...
proof
...
Galley proof.
...
If "true", a proof is needed.
...
Advertisements
...
bleed
...
Bleed flag.
...
If "true", the ads must be produced with bleed frames.
...
Advertisements
...
placement_rule
...
Placement rule.
...
Placement rule for automatic placement of ads by the planner.
...
Advertisements
...
sort_criterion_1
...
Sort criterion 1.
...
Sort criterion for the ad pagination.
...
Advertisements
...
sort_criterion_2
...
Sort criterion 2.
...
Sort criterion for the ad pagination.
...
Advertisements
...
production_note
...
Production Notice.
...
Textual note for ad production.
API-Ebene “Ad cipher number” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/ads/cipher_number
...
Get a unique cipher number
...
API-Ebene “Supplements” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/supplements
...
Create new supplement
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/supplements/{number}
...
Update supplement by unique (NGEN) number
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/supplements/{number}
...
Get supplement by unique (NGEN) number
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/supplements/search
...
Search for supplements
Status | ||||
---|---|---|---|---|
|
...
API-Ebene “Sales” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/sales
...
Create new sale
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/sales/{number}
...
Update sale by unique (NGEN) number
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/sales/{number}
...
Get sale by unique (NGEN) number
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/sales/search
...
Search for sales
Status | ||||
---|---|---|---|---|
|
...
API-Ebene “Orders” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/orders
...
Create new order
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/orders/{number}
...
Update order by unique (NGEN) number
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/orders/{number}
...
Get adorder by unique (NGEN) number
...
Status | ||||
---|---|---|---|---|
|
...
/orders/search
...
Search for orders
Status | ||||
---|---|---|---|---|
|
...
...
Level of Ad API
...
Name
...
Description
...
Function
...
Orders
...
type
...
Classification of the given order by type.
...
Controls the functions in the system that depend on the order type.
...
Orders
...
status
...
Status of the order.
...
Specifies the different states of the order.
...
Orders
...
billing_client
...
Invoice client (sales organization).
...
Assigns this order to a specific sales organization.
...
Orders
...
contact
...
Note to contact client.
...
Note to the client at the customer.
...
Orders
...
comment
...
Comment.
...
Orders
...
tariff_class
...
Tariff class.
...
Group can be used for price calculations.
...
Orders
...
tariff_previous
...
Previous tariff class.
...
Orders
...
acceptance_type
...
Acceptance type.
...
Orders
...
invoicing_period
...
Billing rhythm.
...
Controls whether the order is charged intermediately, or only at the end of the month.
...
Orders
...
invoice_copies
...
Number of invoice copies.
...
Orders
...
payment_method
...
Payment method.
...
Specifies how the invoice is to be paid.
...
Orders
...
invoice_delivery
...
Invoice delivery method.
...
Specifies the way an invoice is to be delivered.
...
Orders
...
vat_type
...
Value added tax rate.
...
VAT rate that applies to this customer by default.
...
Orders
...
advertising_tax
...
Advertising tax.
...
Orders
...
invoice_type
...
Billing type.
...
Controls whether the order is included in a collective invoice, whether it is invoiced individually, or whether no invoice is created at all.
...
Orders
...
publication_proof_type
...
Document category on appearance.
...
Controls what type of receipt is sent on appearance.
...
Orders
...
publication_proof_quantity
...
Number of vouchers on appearance.
...
Controls how many vouchers are sent on appearance.
...
Orders
...
invoice_proof_type
...
Document category for invoicing.
...
Controls what type of receipt is sent when an invoice is created.
...
Orders
...
invoice_proof_quantity
...
Number of vouchers for invoicing.
...
Controls how many receipts are sent with invoices.
...
Orders
...
discount
...
Amount of discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Orders
...
agency_commission
...
Agency Commission.
...
Is taken over when creating new orders and can be used for price calculation.
...
Orders
...
additional_discount_type
...
Type of additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Orders
...
additional_discount
...
Amount of the additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Orders
...
campaign
...
Campaign.
...
Orders
...
discount_agreement
...
Percentage of the discount.
...
Orders
...
term_of_payment_discount
...
Payment term discount in days.
...
Orders
...
term_of_payment_net_amount
...
Payment term Net amount in days.
...
Orders
...
comment
...
Comment.
...
Orders
...
term_of_payment
...
Term of payment.
...
Orders
...
billing_type
...
Billing type.
...
Specifies how the order is to be charged.
Example: For billing only; Without billing
...
Orders
...
responsible
...
Amount of internal supervisors/responsible parties.
...
Responsible in the office, respectively representative and commission recipient.
...
Orders; "responsible"
...
number
...
Unique number of the business partner.
...
Allows unique identification of the business partner, e.g. during searches or updates.
...
Orders
...
contact_persons
...
Number of contact persons.
...
Orders; "contact_persons"
...
number
...
Unique business partner number of a contact person.
...
Specifies the unique business partner number of a contact person.
...
Orders
...
business_partners
...
Unique number of the business partner (debtor).
...
Customer number of the debtor.
...
Orders; "business_partners"
...
debtor
...
Debtor.
...
Orders; "business_partners"
...
advertiser
...
Advertiser.
...
Specifies the advertiser's customer number.
...
Orders; "business_partners"
...
agency
...
Agency.
...
Agency customer number.
...
Orders
...
ads
...
Lists ads for the order.
...
Amount of advertisements belonging to the order.
...
Orders; "ads"
...
number
...
Unique number of the advertisement.
...
Allows unique identification of the advertisement, e.g. during searches, or during updates.
...
Orders
...
supplements
...
Lists supplements for the order.
...
Amount of supplements belonging to the order.
...
Orders; "supplements"
...
number
...
Unique number of the supplement.
...
Allows unique identification of the supplement, e.g. during searches, or when updating.
...
Orders
...
sales
...
Sales.
...
Lists sales for the order.
...
Orders; "sales"
...
number
...
Unique number of the sale.
...
Allows unique identification of the sale, e.g. during searches, or when updating.
...
Orders - Search; "Parameters (search criteria)"
...
billing_client
...
Invoice client (sales organization).
...
Assigns this order to a specific sales organization.
...
Orders - Search; "Parameters (search criteria)"
...
order_type
...
Types of order.
...
The values are OR-combined, so only one of the values must match.
...
Orders - Search; "Parameters (search criteria)"
...
order_status
...
Status of order.
...
The values are OR-combined, so only one of the values must match.
...
Orders - Search; "Parameters (search criteria)"
...
order_number
...
Unique numbers of orders.
...
The values are OR-combined, so only one of the values must match.
...
Orders - Search; "Parameters (search criteria)"
...
businesspartner
...
Unique numbers of business partners.
...
The values are OR-combined, so only one of the values must match.
...
Orders - Search; "Parameters (search criteria)"
...
element_status
...
Status of elements, e.g. ads/supplements/sales.
...
The values are OR-combined, so only one of the values must match.
...
Orders - Search; "Parameters (search criteria)"
...
offset
...
Specifies the offset for the query.
...
If no offset is specified, the IDs of the first changed records are returned.
API-Ebene “Order price calculation” (Beta)
...
Status | ||||
---|---|---|---|---|
|
...
/orders/calculate_price
...
Calculate the price for an order.
...
Status | ||||
---|---|---|---|---|
|
...
/orders/calculate_price/{number}
...
Calculate the price for the given order.
...
...
Level of Ad API
...
Name
...
Description
...
Function
...
Order price calculation; "order"
...
type
...
Classification of the given order by type.
...
Controls the functions in the system that depend on the order type.
...
Order price calculation; "order"
...
status
...
Status of the order.
...
Specifies the different states of the order.
...
Order price calculation; "order"
...
billing_client
...
Invoice client (sales organization).
...
Assigns this order to a specific sales organization.
...
Order price calculation; "order"
...
contact
...
Note to contact client.
...
Note to the client at the customer.
...
Order price calculation; "order"
...
tariff_class
...
Tariff class.
...
Group can be used for price calculations.
...
Order price calculation; "order"
...
tariff_previous
...
Previous tariff class.
...
Order price calculation; "order"
...
acceptance_type
...
Acceptance type.
...
Order price calculation; "order"
...
invoicing_period
...
Billing rhythm.
...
Controls whether the order is charged intermediately, or only at the end of the month.
...
Order price calculation; "order"
...
invoice_copies
...
Number of invoice copies.
...
Order price calculation; "order"
...
payment_method
...
Payment method.
...
Specifies how the invoice is to be paid.
...
Order price calculation; "order"
...
invoice_delivery
...
Invoice delivery method.
...
Specifies the way an invoice is to be delivered.
...
Order price calculation; "order"
...
vat_type
...
Value added tax rate.
...
VAT rate that applies to this customer by default.
...
Order price calculation; "order"
...
advertising_tax
...
Advertising tax.
...
Order price calculation; "order"
...
invoice_type
...
Billing type.
...
Controls whether the order is included in a collective invoice, whether it is invoiced individually, or whether no invoice is created at all.
...
Order price calculation; "order"
...
publication_proof_type
...
Document category on appearance.
...
Controls what type of receipt is sent on appearance.
...
Order price calculation; "order"
...
publication_proof_quantity
...
Number of vouchers on appearance.
...
Controls how many vouchers are sent on appearance.
...
Order price calculation; "order"
...
discount
...
Amount of discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "order"
...
agency_commission
...
Agency Commission.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "order"
...
additional_discount_type
...
Type of additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "order"
...
additional_discount
...
Amount of the additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "order"
...
campaign
...
Campaign.
...
Order price calculation; "order"
...
discount_agreement
...
Percentage of the discount.
...
Order price calculation; "order"
...
term_of_payment_discount
...
Payment term discount in days.
...
Order price calculation; "order"
...
term_of_payment_net_amount
...
Payment term Net amount in days.
...
Order price calculation; "order"
...
comment
...
Comment.
...
Order price calculation; "order"
...
term_of_payment
...
Term of payment.
...
Order price calculation; "order"
...
billing_type
...
Billing type.
...
Specifies how the order is to be charged.
Example: For billing only; Without billing
...
Order price calculation; "order"
...
responsible
...
Amount of internal supervisors/responsible parties.
...
Responsible in the office, respectively representative and commission recipient.
...
Order price calculation; "order"; "responsible"
...
number
...
Unique number of the business partner.
...
Allows unique identification of the business partner, e.g. during searches or updates.
...
Order price calculation; "order"
...
contact_persons
...
Number of contact persons.
...
Order price calculation; "order"; "contact_persons"
...
number
...
Unique business partner number of a contact person.
...
Specifies the unique business partner number of a contact person.
...
Order price calculation; "order"
...
business_partners
...
Unique number of the business partner (debtor).
...
Customer number of the debtor.
...
Order price calculation; "order"; "business_partners"
...
debtor
...
Debtor.
...
Order price calculation; "order"; "business_partners"
...
advertiser
...
Advertiser.
...
Specifies the advertiser's customer number.
...
Order price calculation; "order"; "business_partners"
...
agency
...
Agency.
...
Agency customer number.
...
Order price calculation
...
business_partner
...
Lists information about the business partner.
...
Order price calculation; "business_partner"
...
number
...
Unique number of the business partner (in NGEN).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Order price calculation; "business_partner"
...
number_remote
...
Unique number of the business partner (remote System).
...
Enables unique identification of the business partner, e.g. during searches or updates.
...
Order price calculation; "business_partner"
...
type
...
Classification of the present business partner by type.
Examples:
Is it a private, or business customer?
Is it an agency, an employee, or an agent?
...
Controls the functions in the system, which depend on the business partner type.
...
Order price calculation; "business_partner"
...
acronym
...
Unique identifier of the business partner.
...
Assignment of editorial content to author/honoree.
...
Order price calculation; "business_partner"
...
status
...
Status of the business partner.
...
Controls whether the business partner is active, or inactive (e.g. whether orders can be entered for him).
...
Order price calculation; "business_partner"
...
website
...
The website of the business partner.
...
Order price calculation; "business_partner"
...
vat_id
...
The tax identification number of the business partner.
...
Order price calculation; "business_partner"
...
vat_type
...
Value added tax rate.
...
VAT rate that applies to this customer by default.
...
Order price calculation; "business_partner"
...
address
...
Information about the address data of the business partner.
...
Order price calculation; "business_partner"; "address"
...
main
...
Lists information about the address type "main address".
...
Order price calculation; "business_partner"; "address"; "main"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "main"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "main"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Order price calculation; "business_partner"; "address"
...
billing
...
Lists information about the address type "billing address".
...
Order price calculation; "business_partner"; "address"; "billing"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "billing"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "billing"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Order price calculation; "business_partner"; "address"
...
document
...
Lists information about the address type "document address".
...
Order price calculation; "business_partner"; "address"; "document"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "document"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "document"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Order price calculation; "business_partner"; "address"
...
cipher
...
Lists information about the address type "cipher address".
...
Order price calculation; "business_partner"; "address"; "cipher"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "cipher"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "cipher"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "cipher"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "cipher"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "cipher"
...
comment
...
Comment.
...
Order price calculation; "business_partner"; "address"
...
home
...
Lists information about the address type "private address".
...
Order price calculation; "business_partner"; "address"; "home"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "home"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "home"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Order price calculation; "business_partner"; "address"
...
other
...
Lists information about the address type "other address".
...
Order price calculation; "business_partner"; "address"; "other"
...
scope
...
Specifies whether all or only active addresses are listed.
...
Order price calculation; "business_partner"; "address"; "other"
...
addresses
...
The address data of the business partner.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
form_of_address
...
The salutation of the business partner.
...
Controls the set of available name fields.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
title
...
The title of the business partner.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
degree
...
The academic degree of the business partner.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
first_name
...
The first name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
middle_name
...
The middle name (Only if it is a person).
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
name_extension
...
Name affix.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
street_name
...
Specification of the street name.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
house_number
...
Specitifaction of the house number.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
address_line2
...
Specification of the address suffix.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
po_box
...
Post office box number.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
zip
...
Zip code.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
city
...
City.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
country
...
Country,
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
valid_from
...
Address valid from [...].
...
Indicates that this address is used from this date. The respective older address becomes invalid.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
is_default
...
Address is default address.
...
Specifies that this address is automatically used as default (e.g. billing address for new orders in case of multiple billing addresses).
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"
...
contact_options
...
The contact options of the business partner.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
type
...
Type of a contact information.
...
Indicates the contact type (e-mail, business phone, private phone, website URL), controls how the content of the "number" field is interpreted, depending on the specification.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
country_code
...
Country code.
...
Specifies the country code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
area_code
...
Area code.
...
Specifies the area code if the entry is a phone number.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
number
...
Specify the phone number or e-mail or URL.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
extension
...
Extension for phone number.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
purposes
...
List of uses.
...
Lists purposes for the address.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"; "purposes"
...
name
...
The name of a company, or an association.
The last name, in the case of a person.
...
Order price calculation; "business_partner"; "address"; "other"; "addresses"; "contact_options"
...
comment
...
Comment.
...
Order price calculation; "business_partner"
...
business_partner_information
...
Business Partner Information.
...
Order price calculation; "business_partner"; "business_partner_information"
...
billing_client
...
Invoice client (sales organization).
...
Controls validity of this record for a given invoice client.
...
Order price calculation; "business_partner"; "business_partner_information"
...
client_name
...
Client.
...
Assignment to client in case of client separation.
...
Order price calculation; "business_partner"; "business_partner_information"
...
customer_group
...
Customer group.
...
Group can be used for price calculations.
...
Order price calculation; "business_partner"; "business_partner_information"
...
tariff_class
...
Tariff class.
...
Group can be used for price calculations.
...
Order price calculation; "business_partner"; "business_partner_information"
...
credit_limit
...
Credit Limit.
...
Total amount of open items above which a credit check is triggered.
...
Order price calculation; "business_partner"; "business_partner_information"
...
credit_rating_category
...
Credit Rating Class.
...
Informative, can be used for checks during order entry.
...
Order price calculation; "business_partner"; "business_partner_information"
...
credit_rating_index
...
Credit Rating Index.
...
Informative, can be used for checks during order entry.
...
Order price calculation; "business_partner"; "business_partner_information"
...
dunning_block
...
Dunning block.
...
Informative, can be used for checks during order entry.
...
Order price calculation; "business_partner"; "business_partner_information"
...
additional_discount_type
...
Type of additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "business_partner"; "business_partner_information"
...
agency_commission
...
Agency Commission.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "business_partner"; "business_partner_information"
...
discount
...
Amount of discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "business_partner"; "business_partner_information"
...
additional_discount
...
Amount of the additional discount.
...
Is taken over when creating new orders and can be used for price calculation.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoice_type
...
Billing type.
...
Controls whether the order is included in a collective invoice, whether it is invoiced individually, or whether no invoice is created at all.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoicing_period
...
Billing rhythm.
...
Controls whether the order is charged intermediately, or only at the end of the month.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoice_copies
...
Number of invoice copies.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoice_delivery
...
Invoice delivery method.
...
Specifies the way an invoice is to be delivered.
...
Order price calculation; "business_partner"; "business_partner_information"
...
payment_method
...
Payment method.
...
Specifies how the invoice is to be paid.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoice_proof_type
...
Document category for invoicing.
...
Controls what type of receipt is sent when an invoice is created.
...
Order price calculation; "business_partner"; "business_partner_information"
...
invoice_proof_quantity
...
Number of vouchers for invoicing.
...
Controls how many receipts are sent with invoices.
...
Order price calculation; "business_partner"; "business_partner_information"
...
publication_proof_type
...
Document category on appearance.
...
Controls what type of receipt is sent on appearance.
...
Order price calculation; "business_partner"; "business_partner_information"
...
publication_proof_quantity
...
Number of vouchers on appearance.
...
Controls how many vouchers are sent on appearance.
...
Order price calculation; "business_partner"; "business_partner_information"
...
discount_agreement
...
Percentage of the discount.
...
Order price calculation; "business_partner"; "business_partner_information"
...
term_of_payment_discount
...
Payment term discount in days.
...
Order price calculation; "business_partner"; "business_partner_information"
...
term_of_payment_net_amount
...
Payment term Net amount in days.
...
Order price calculation; "business_partner"; "business_partner_information"
...
topics
...
Set of topics assigned to the customer.
...
Order price calculation; "business_partner"; "business_partner_information"; "topics"
...
name
...
Individual topics assigned to the customer.
...
Order price calculation; "business_partner"; "business_partner_information"
...
external_balance
...
External balance.
...
Order price calculation; "business_partner"; "business_partner_information"
...
valexternal_balance_dateid_from
...
Date of the external balance.
...
Order price calculation; "business_partner"; "business_partner_information"
...
economic_sectors
...
Lists information about industries, the customer is assigned to.
...
Order price calculation; "business_partner"; "business_partner_information"; "economic_sectors"
...
name
...
Entries for individual industries.
...
Order price calculation; "business_partner"; "business_partner_information"
...
credit_amount
...
Credit Limit.
...
Order price calculation; "business_partner"; "business_partner_information"
...
text
...
Order price calculation; "business_partner"; "business_partner_information"
...
compendium
...
Order price calculation; "business_partner"; "business_partner_information"
...
proof_type_manually
...
Manual receipt delivery.
...
Order price calculation; "business_partner"; "business_partner_information"
...
block_automatically
...
Automatically set lock indicator.
...
Order price calculation; "business_partner"; "business_partner_information"
...
block_manually
...
Manually set lock indicator.
...
Order price calculation; "business_partner"; "business_partner_information"
...
field1
...
Order price calculation; "business_partner"; "business_partner_information"
...
field2
...
Order price calculation; "business_partner"; "business_partner_information"
...
term_of_payment
...
Term of payment.
...
Order price calculation; "business_partner"; "business_partner_information"
...
agents
...
List of representatives assigned in the invoice client-specific customer data.
...
Order price calculation; "business_partner"; "business_partner_information"; "agents"
...
number
...
Unique business partner number of a representative.
...
Order price calculation; "business_partner"
...
contact_persons
...
Number of contact persons.
...
Order price calculation; "business_partner"; "contact_persons"
...
number
...
Unique business partner number of a contact person.
...
Specifies the unique business partner number of a contact person.
...
Order price calculation
...
ads
...
Lists ads for the order.
...
Amount of ads belonging to the order.
...
Order price calculation; "ads"
...
type
...
Classification of the present advertisement according to type.
Examples:
Is it a text-, word-, or customer supplied advertisement?
...
Controls the functions in the system that depend on the advertisement type.
...
Order price calculation; "ads"
...
status
...
Status of the advertisement.
...
Controls if the ad is still in the planning stage or if it is ready for printing/exposure.
...
Order price calculation; "ads"
...
assignment
...
Assignment.
...
Specifies the amount of issues, or a combo with different issues, in which the ad should appear.
...
Order price calculation; "ads"
...
category
...
Advertisement section.
...
Controls in which section the advertisement appears.
...
Order price calculation; "ads"; "category"
...
id
...
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
...
Order price calculation; "ads"
...
product_type
...
Product type.
...
Controls in which part of a product the ad appears (e.g. ad section, or text section).
...
Order price calculation; "ads"
...
issues
...
Individual bookings of the advertisement.
...
Order price calculation; "ads"; "issues"
...
number
...
Unique number.
...
Unique number of the respective booking.
...
Order price calculation; "ads"; "issues"
...
status
...
Status.
...
Status of the respective booking.
...
Order price calculation; "ads"; "issues"
...
edition
...
Edition.
...
Edition of the respective booking.
...
Order price calculation; "ads"; "issues"
...
date
...
Publication date.
...
Publication date of the respective booking.
...
Order price calculation; "ads"; "issues"
...
category
...
Advertisement section.
...
Controls in which section the advertisement appears.
...
Order price calculation; "ads"; "issues"; "category"
...
id
...
Unique identifier of a record of the addressed endpoint (categories, editions, types, producttypes, billingclients).
...
Order price calculation; "ads"; "issues"
...
combi_number
...
Combi number.
...
Specifies to which combi the respective appearance belongs to.
...
Order price calculation; "ads"; "issues"
...
combi_name
...
Combi name.
...
Name of the combi the appearance belongs to.
...
Order price calculation; "ads"; "issues"
...
combi_label
...
Combi label.
...
Label of the combi the appearance belongs to.
...
Order price calculation; "ads"
...
width_booked_unit
...
Booked width (unit).
...
Specifies the unit of the width specification in the "width_booked_value" field.
...
Order price calculation; "ads"
...
width_booked_value
...
Booked width (value).
...
Specifies the value for the booked width.
...
Order price calculation; "ads"
...
height_booked_unit
...
Booked height (unit).
...
Specifies the unit of the height specification in the "height_booked_value" field.
...
Order price calculation; "ads"
...
height_booked_value
...
Booked height (value).
...
Specifies the value for the booked height.
...
Order price calculation; "ads"
...
word_count
...
Word count.
...
Specifies the number of words that are relevant for the price calculation in the ad text.
...
Order price calculation; "ads"
...
word_count_extra
...
Word count - extra.
...
Specifies the number of words to be calculated with a special price.
...
Order price calculation; "ads"
...
colors_booked
...
Booked colors.
...
Specifies which colors are booked.
...
Order price calculation; "ads"
...
colors_to_charge
...
Number of colors to be calculated.
...
Specifies how many colors should be included in the price calculation.
...
Order price calculation; "ads"
...
url
...
Web address.
...
URL to be opened when the ad is clicked in the e-paper.
...
Order price calculation; "ads"
...
design_notes
...
Set of design characteristics.
...
Relevant for both ad production and price calculations.
...
Order price calculation; "ads"; "design_notes"
...
note
...
Single design characteristic.
...
Specifies information about the layout of the advertisement.
...
Order price calculation; "ads"
...
placement_note
...
Placement Information.
...
Free text for the planner.
...
Order price calculation; "ads"
...
heading
...
Invoice text.
...
Keyword of the advertisement for invoice text, or list view.
...
Order price calculation; "ads"
...
online_start
...
Start date.
...
Specifies when the advertisement will be published online.
...
Order price calculation; "ads"
...
online_end
...
End date.
...
Specifies when the advertisement will go offline.
...
Order price calculation; "ads"
...
cipher
...
Cipher data for the advertisement.
...
Amount of data needed for a cipher.
...
Order price calculation; "ads"; "cipher"
...
number
...
Cipher number.
...
Number to assign cipher responses.
...
Order price calculation; "ads"; "cipher"
...
delivery_type
...
Delivery method.
...
Delivery method for cipher responses.
...
Order price calculation; "ads"
...
publication_type
...
Publication type.
...
Order price calculation; "ads"
...
copy_variant
...
Variant of the ad number.
...
Order price calculation; "ads"
...
copy_original
...
Original ad number.
...
Order price calculation; "ads"
...
copy_original_external
...
External original copy.
...
Order price calculation; "ads"
...
production_date_desired
...
Desired production date.
...
Order price calculation; "ads"
...
production_date
...
Production date.
...
Order price calculation; "ads"
...
production_status
...
Production status.
...
Specifies the current status of the production of the advertisement motif.
...
Order price calculation; "ads"
...
height_booked_mm
...
Booked height in milimeters.
...
Order price calculation; "ads"
...
width_booked_mm
...
Booked width in milimeters.
...
Order price calculation; "ads"
...
height_fix
...
Fixed height.
...
If "false", the height of the advertisement is variable from the ad production point of view.
...
Order price calculation; "ads"
...
production_status_timestamp
...
Timestamp for production status.
...
Order price calculation; "ads"; "proof_emails"
...
proof_emails
...
Amount of e-mail addresses for the galley proof ("copy proof").
...
Order price calculation; "ads"
...
mail_address
...
Single e-mail address for the galley proof ("copy proof").
...
Order price calculation; "ads"
...
proof
...
Galley proof.
...
If "true", a proof is needed.
...
Order price calculation; "ads"
...
bleed
...
Bleed flag.
...
If "true", the ads must be produced with bleed frames.
...
Order price calculation; "ads"
...
placement_rule
...
Placement rule.
...
Placement rule for automatic placement of ads by the planner.
...
Order price calculation; "ads"
...
sort_criterion_1
...
Sort criterion 1.
...
Sort criterion for the ad pagination.
...
Order price calculation; "ads"
...
sort_criterion_2
...
Sort criterion 2.
...
Sort criterion for the ad pagination.
...
Order price calculation; "ads"
...
production_note
...
Production note.
...
Textual note for ad production.
...
Order price calculation; "ads"
...
production_comment
...
Production comment.
...
Order price calculation; "ads"
...
creation_user_contact
...
Contact options such as telephone number or mail address.
...
Order price calculation; "ads"
...
sales_office
...
Sales office.
...
Order price calculation
...
supplements
...
Lists supplements for the order.
...
Amount of supplements belonging to the order.
...
Order price calculation; "supplements"
...
type
...
Type of supplement.
...
Order price calculation; "supplements"
...
status
...
Status level for the supplement.
...
Indicates which status level the supplement is in.
...
Order price calculation; "supplements"
...
product_type
...
Type of product.
...
Indicates what type of product the supplement is.
...
Order price calculation; "supplements"
...
weight
...
Weight of the supplement.
...
Order price calculation; "supplements"
...
width
...
Width of the supplement.
...
Order price calculation; "supplements"
...
height
...
Height of the supplement.
...
Order price calculation; "supplements"
...
heading
...
Invoice text of the supplement.
...
Order price calculation; "supplements"
...
price
...
Manually overwrite the price per thousand.
...
Order price calculation; "supplements"
...
quantity_booked
...
Quantity booked.
...
Order price calculation; "supplements"
...
quantity_delivered
...
Quantity delivered.
...
Order price calculation; "supplements"
...
quantity_inserted
...
Quantity inserted.
...
Order price calculation
...
sales
...
Lists sales for the order.
...
Amount of sales belonging to the order.
...
Order price calculation; "sales"
...
type
...
Type of sale.
...
Order price calculation; "sales"
...
status
...
Sale status.
...
Order price calculation; "sales"
...
heading
...
Invoice text.
...
Order price calculation; "sales"
...
count
...
Number of properties sold.
Number of days online.
...
Order price calculation; "sales"
...
start_date
...
Start date.
...
Order price calculation; "sales"
...
end_date
...
End date.
...
Order price calculation; "sales"
...
manual_price
...
Manually overdriven price.
API-Ebene “Specimen Copies” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/chargedpublications/{id}
...
Get a list of all charged publications for a given invoice
Status | ||||
---|---|---|---|---|
|
...
API-Ebene “Info” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/info
...
Get API and unser info
Status | ||||
---|---|---|---|---|
|
...
API-Ebene “Invoice” (work in progress)
...
Status | ||||
---|---|---|---|---|
|
...
/orders/invoices/events
...
Get ids of created or changed invoices since last retrieval
Status | ||||
---|---|---|---|---|
|
...
Status | ||||
---|---|---|---|---|
|
...
/orders/invoices/{id}
...
API-Endpunkt “Business Partners”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /businesspartners | Create Business Partner | ||||||
| /businesspartners/{number} | Update Business Partner by unique (NGEN) number | ||||||
| /businesspartners/{number} | Get Business Partner Information by unique (NGEN) number | ||||||
| /businesspartners/search | Search for Business Partner | ||||||
| /businesspartners/events | Get changed Business Partner Information since last retrieval | ||||||
API-Endpunkt “Account Details”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /accountdetails/ | Create new SEPA account details | ||||||
| /accountdetails/{number} | Update SEPA account details | ||||||
| /accountdetails/{number} | Get SEPA account details | ||||||
API-Endpunkt “Addresses”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /addresses | Create new address | ||||||
| /addresses/{number} | Update address | ||||||
| /accountdetails/{number} | Get address | ||||||
API-Endpunkt “Advertisements”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /ads | Create new ad | ||||||
| /ads/{number} | Update ad by unique (NGen) number | ||||||
| /ads/{number} | Get ad by unique (NGen) number | ||||||
| /ads/events | Get changed ads since last retrieval | ||||||
| /ads/images/{number} | Update image data for ad | ||||||
| /ads/images/{number}/{resolution} | Get an image of the advertisement by unique NGEN number | ||||||
API-Endpunkt “Ad cipher number”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /abc/cipher_number | Get a unique cipher number | ||||||
API-Endpunkt “Supplements”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /supplements | Create new supplement | ||||||
| /supplements/{number} | Update supplement by unique (NGen) number | ||||||
| /supplements/{number} | Get supplement by unique (NGen) number | ||||||
API-Endpunkt “Sales”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /sales | Create new sale | ||||||
| /sales/{number} | Update sale by unique (NGen) number | ||||||
| /sales/{number} | Get sale by unique (NGen) number | ||||||
API-Endpunkt “Orders”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /orders | Create new order | ||||||
| /orders/{number} | Update order by unique (NGen) number | ||||||
| /orders/{number} | Get order by unique (NGen) number | ||||||
API-Endpunkt “Order price calculation”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /orders/calculate_price | Calculate the price for an order | ||||||
| /orders/calculate_price/{number} | Calculate the price for the given order | ||||||
API-Endpunkt “Info”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /info | Get API an user info | ||||||
API-Endpunkt “Invoices”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /orders/invoices/events | Get changed invoices since last retrieval | ||||||
| /orders/invoices/{number} | Get invoice data | ||||||
API-Endpunkt “Commissions for orders”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /orders/commissionstatements/events | Get changed commission statements since last retrieval | ||||||
| /orders/commissionstatements/{number} | Get data for commission statement | ||||||
API-Endpunkt “Special Publications”
Für diesen Endpunkt stehen die folgenden Anfragemethoden zur Verfügung:
| /specialpublications | Create new special publication | ||||||
| /specialpublications/{number} | Update special publication by unique (NGen) number | ||||||
| /specialpublications/{number} | Get special publication by unique (NGen) number | ||||||
| /specialpublications/search | Search for special publications | ||||||
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|