Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
CreateShipment → Creates a DHL Shipping Label.
GetLabel → Shows the shipment Label again.
1 Business Brixx UPS Shipping
2 Business Brixx UPS Shipping -> CreateShipment
2.1 Incomming Information
2.2 Returning Information
2.3 Example Usages
3 CancelShipment
4 GetLabel
For accessing the UPS-Shipping brixxbox interface the UPS services need the following setup values (configuration -> settings).
UPSCustomerID Your customer number with UPS
UPSUsername A valid User for accessing the services
UPSPassword The corresponding password
UPSAccessLicenseNumber A license/access key provided by UPS on this page https://www.ups.com/upsdeveloperkit
If no settings are available, a sample label will be generated.
Creates a UPS shipping label
To create labels four groups of information are available:
1. Settings with the following fields (If the group/field is not present default values will be assumed)
ServiceCode: default value "11" UPS Standard. Valid values according to UPS service codes.
MetricMeasurements: "1" sets to true. This is the default. Measurements will be metric e.g. kg, cm or nonmetric for lbs, inch
Language: Language code according to UPS. e.g. deu, eng, spa. this field will be set to user language by default. If the user language is not available for UPS, "eng" will be used.
2. Shipper:
Name
Street
HouseNo
ZipCode
City
CountryCode
StateProvinceCode
AttentionName
Phone
FaxNumber
TaxIdentificationNumber
3. ShipAddress:
Name
Street
HouseNo
ZipCode
City
CountryCode
StateProvinceCode
AttentionName
Phone
FaxNumber
TaxIdentificationNumber
4. ParcelData:
Description
PackageType: Package type according to UPS. If no value is given, the default will be set to: "02" Customer Supplied Package
Weight
Height
Length
Width
In case of success (status 200) the following fields are returned
TrackingNumber: The UPS generated ID. This will be used for further references to this shipment.
LabelData: this is a blob response. It contains the actual label in GIF format and can directly be used for further processing. E.g. “brixxApi.printBlob(LabelData);”
In case of error (status 400) the following fields are returned:
error: a text showing the first error. E.g. “console.log(result.error);”
To cancel an existing shipment only the TrackingNumber is needed.
In case the label is needed again it can be retrieved with an existing TrackingNumber. The result will show LabelData (see CreateShipment results #Returning_Information for details)
Creates a DPD Shipping Label
For accessing the DPD-Shipping brixxbox interface the DPD services need the following setup values (configuration -> settings).
DPDUserCredentialsCloudUserID
DPDUserCredentialsToken
DPDPartnerCredentialsName
DPDPartnerCredentialsToken
If no settings are available, a sample label will be generated.
To create labels three groups of information are available:
1. OrderSettings with the following fields (If the group is not present default values will be assumed)
language: Values „de_DE“ or „en_EN“ are allowed. If nothing is set „de_DE“ will be assumed.
ShipDate: if not available will be set to „today“
LabelSize: „PDF_A4“ or „PDF_A6“. If nothing is set „PDF_A4“ will be assumed.
LabelStartPosition: “UpperLeft“, „UpperRight“, „LowerLeft“, „LowerRigh“
2. ShipAddress:
Company
Gender
Salutation
FirstName
LastName
Name
Street
HouseNo
ZipCode
City
Country
State
Phone
3. ParcelData:
YourInternalID: should be set to your own reference (e.g. order no). if no value is provided a timestamp will be set.
Content
Weight: in kg
Reference1
Reference2
ShipService: set to a valid DPD-Service. If nothing is set “Classic” will be assumed.
Detailed informationen for field usage can be found at https://esolutions.dpd.com/dokumente/DPD_Cloud_Service_Webservice_Dokumentation_DE.pdf
In case of success (status 200) the following fields are returned
ParcelNo: The DPD generated ID. This will be used for further references to this shipment.
YourInternalID: The same ID that was provided for the request
TimeStamp: an informational time stamp when the request was processed
LabelData: this is a blob response. It contains the actual label in PDF format and can directly be used for further processing. E.g. “brixxApi.printBlob(LabelPDF);”
In case of error (status 400) the following fields are returned:
TimeStamp: an informational time stamp when the request was processed
ErrorDataList: an array with detailed information what went wrong. Every error will show the following fields
ErrorID: an internal error no
ErrorCode: an internal error code
ErrorMsgShort: Error information short version
ErrorMsgLong: Error information long version
DPDCreateShipment -> Creates a DPD Shipping Label
This function exports a Datev CSV file for a given timeframe. The fuction needs 3 customized SQL scripts to process the data.
As this function calls customized SQL scripts, it will add SQL parameters from the function call to the SQL calls.
@company
@dateFrom
@dateUntil
Those parameters can be used within the SQL statements.
sqlDataRead script
Auftragsnummer
Artikelnummer
ArtikelRecordId
Paragraph13b
NettoWert
BruttoWert
Debitorenkonto
Kreditorenkonto
Sachkonto
SteuerID
Buchungsschluessel
Buchungstext
Rechnungsdatum
Rechnungsnummer
Leistungsdatum
AttachementId
BuchungszaehlerTabelle (nvarchar that defines the tabel, where the booking counter is stored)
BuchungszaehlerSpalte (nvarchar that devines the column for the booking counter)
IstAutomatikKonto
IstInnerbetrieblich
sqlMainData script
Kundennummer
Konto
Firmenname
Nachname
Vorname
Anrede
Adresstyp
Strasse
Hausnummer
PLZ
Stadt
Zusatzinformation
sqlGetCounter script
This script needs to return the actual booking counter as number.
sqlDataRead Example
sqlMainData Example
sqlGetCounter Example
This is the main script, which is responsible for collection all the data, which needs to be exported.
Splits a GS1 code into its AIs and values
This is usually used in the event where you use the plain scan result as the input. The fnc1Char parameter is optional and only used, if the scanner sends an different (visible) character instead of the default fnc1 (CHAR29).
Mandatory fields: gs1Code
Especially with keyboard wedge scanners, it is often usefull to use a visible character as the FNC1 char.
The result variable in this case:
This is the script, which is responsible for collection all the address data, which needs to be exported.
Example for a getDatevData script
This is the main script, which is responible for collection all the data, which needs to be exported.
@company - If you work with multiple companies, you have to export each company by it's own.
@dateFrom - Start date for the export
@dateUntil - End date for the export
This module creates a SEPA file in XML format.
This brixxbox module allows to retrieve data from the Diamant Accounting Software and post data to it
The Method Retrieves the data specified with dataType (like Address, CostCenter and so on). The searchParams and fieldMatch JSON properties are valid for all methods, but the fields mentioned in it are depending on the datatype used. For example: postcode is a valid searchParam for addresses, but not for cost centers.
The Get method will return the data it fetched from Diamant, so you get an array of JSON objects. The fieldMatch prameter will tell the brixxbox to change field names, so that it is more useful in an brixxbox environment.
This will retrieve all addresses from diamant. Field names are the original diamand field names
This will retrieve all addresses with Postcode 61118 from diamant and return the result. Only the fields "key" and "Name1" will be returned.
This code will write an address to Diamant
This method allows you to retrieve the data and insert it into the database. Query parameters work the same and are optional but you must user fieldMatch to assign diamant names to brixxbox field names
This will retrieve all addresses from diamant and insert it into the table address the table will be wiped right before the import.
This will retrieve all addresses from diamant and update the records with the same id as in fieldMatch.
More types can be added at request.
Request Data
Address (Adressen)
CostCenter (Kostenstellen)
GenLedgAccount (Sachkonten)
CostObject (Kostenträger)
PrimCostElement (Primärkostenarten)
Project (Projekte)
Company (Mandanten)
Customer(Konten)
Vendor (Vendor)
Posting (Buchungen)
Transctions
Business Brixxes provides special features for business usecases. Each Brixx has an individual set of parameters plus some parameters that are valid for all businessfunctions.
DhlShiping
CreateShipment → Creates a DHL Shipping Label.
GetLabel → Shows the shipment Label again.
DPD Shipping
CreateShipment → Create a DPD Shipping Label.
UPS Shipping
CreateShipment → Create a UPS Shipping Label.
CancelShipment → Removes existing Shipment
GetLabel → Shows the shipment Label again.
InventoryManagement → Does Inventory Movements within an ERP Setup
Move
CurrencyConverter
Convert → Converts a currency to annother currency.
Datev Export
DatevExport → This function exports a Datev CSV file for a given timeframe.
sqlDataRead Example
sqlMainData Example
sqlGetCounter Example
GS1 Code Splitter
Split → Splits a barcode (or 2d code) into its GS1 AIs an Values.
Diamant
DiamantBusinessBrixx
SEPA Export