• CreateShipment → Creates a DHL Shipping Label.

• GetLabel → Shows the shipment Label again.

As we have already discussed in documentation of SetToolbarButtonMode. These are several buttons that are provided by Brixxbox for each app like adding new record, saving new record etc. These buttons provides general functionality needed by most of the apps but in case your app needs extra functionality, Brixxbox also allows this. It is provided by brixxApi function addToolbarButton. It takes a JSON object as a parameter. This JSON contains all the properties that defines this custom button as well as the functionality provided by it. The properties include name, id, and function to execute on clicking this button etc. Adds a custom button to the app toolbar.

Example

Parameters

1. toolbarButtonOptions - It is a JSON Object. In JSON object we passes parameters in the form of key value arguments.It include properties like name, id, function, etc.

Example Usages

As we have already seen a minimal custom print button in above example. Lets now add extra properties like group, css class, and shortcut for our print button. Now we also want this button to be added in our app toolbar on initialization. For this purpose goto current app properties and add onAppInitialized event. Now we need to add following code as a custom code to this event.

Now when our app is initialized, we can see our custom button on the app toolbar and it should look like this.

We can also add different custom buttons to our app depending upon our own requirements.

OpenAI API Key must

Parameter

gptOptions - Json object with parameters.

• system - to set the stage. A promt to tell the model, how to behave

• user - User input, examples and a query. This is the user promt

Example Usages

If shipService is omitted the default value ""V01PAK" will be set.

Example Usages

Parameters

1. eventParameter - this is the special parameter you get in OnRowCreated

2. columnId - the name (id) of the column

3. className - the classnaem to set

Example Usages

Example inside OnRowCreated

Parameters

1. controlId - The id of the calendar control

2. eventSource - the Event source object

Example Usages

Parameters

1. Events

2. Control Id (optional)

   • If the event is control specific (e.g. click on a buttton), this has to be the control id of that button

3. Function

   • The code that should be executed in case of this event

   • The first parameter is the brixxApi

Example Usages

Contents

• 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

Business Brixx UPS Shipping

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.

Business Brixx UPS Shipping -> CreateShipment

Creates a UPS shipping label

Incomming Information

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

  • EMail

  • FaxNumber

  • TaxIdentificationNumber

• 3. ShipAddress:

  • Name

  • Street

  • HouseNo

  • ZipCode

  • City

  • CountryCode

  • StateProvinceCode

  • AttentionName

  • Phone

  • EMail

  • 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

Returning Information

• 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);”

Example Usages

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "CreateShipment",
			Settings : {
				Language: 'deu',
				MetricMeasurements: 1,
				ServiceCode: "11"
			  },
			Shipper : {
				Name: 'Brixxbox GmbH',
				Street: 'Husarenstraße',
				HouseNo: '34a',
				ZipCode: '41836',
				City: 'Hückelhoven',
				CountryCode: 'DE'
			  },
			ShipAddress : {
				Name: 'Brixxbox GmbH',
				Street: 'Husarenstraße',
				HouseNo: '34b',
				ZipCode: '41836',
				City: 'Hückelhoven',
				CountryCode: 'DE',
				Phone: '+49 1234 5678-9',
				Mail: 'm.mustermann@mustermann.com'			  
			  },
			ParcelData : {
				Description: 'Product name',
				Height : 10,
				Length : 20,
				Width  : 15,
				Weight: '4.5',
				ServiceCode: '9'			  
			  }
      });
	  
console.log("Tracking Number: " + result.TrackingNumber);
brixxApi.printBlob(result.LabelData);

CancelShipment

To cancel an existing shipment only the TrackingNumber is needed.

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "CancelShipment",
	 TrackingNumber: app.getFieldValue("ExistingTrackingNumber")
      });

GetLabel

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)

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "GetLabel",
	 TrackingNumber: app.getFieldValue("ExistingTrackingNumber")
      });

Mandatory fields: fromCurrencySymbol, toCurrencySymbol

Example Usages

 let rate = await brixxApi.businessBrixx({
     functionName:"CurrencyConverter",
     methodName: "Convert",
     fromCurrencySymbol: "EUR",
     toCurrencySymbol: "USD",
     date: moment().subtract(7, 'days') // optional, else current date
 });
 console.log(rate)

Parameters

 functionName - the name of the businessBrixx module
 methodName - some businessBrixx functions provide several operations
 silentMode - if you set this to true, the brixxbox will not show a message if something goes wrong. You will still get the errorMessage, to handle the error case in your event code.

Example Usages

   let result = await brixxApi.businessBrixx({
      //Common Parameters for all functions
      functionName:"DhlShiping",
      methodName: "GetLabel",
      silentMode: true,  //false is default. If set to true, the brixxbox will not show an error message box. it is up to you to inform the user.
  
      //Individual paremeters for each business case. DHL Label as an example here.
      shipmentNumber: app.getFieldValue("cordShipmentNumber") //We saved this number before and stored it to our Order
   });
   window.open(result.labelUrl, "_blank");

Business Brixx

• 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

Mandatory fields: imItemId, imQuantity

Example Usages

   await brixxApi.businessBrixx({
        functionName:"InventoryMovement",
        movementTable:"inventoryMovement",
        movements:[
    {
                imQuantity: app.getFieldValue("quantityToShip") * -1,
                imAddressId: app.getFieldValue("companyId"),
                imItemId: app.getFieldValue("itemId"),
        imImei: app.getFieldValue("imei"),
        },
        {
                imQuantity: app.getFieldValue("quantityToShip"),
                imAddressId: app.getFieldValue("customerId"),
                imCustomerUserId: app.getFieldValue("customerUserId"),
                imItemId: app.getFieldValue("itemId"),
        imCustomerOrderLineId: app.getFieldValue("orderLineId"),
        imImei: app.getFieldValue("imei"),
        },
        ]
    });

DPDCreateShipment -> 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.

Incomming Information

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

  • Mail

• 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

Returning Information

• 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

Example Usages

/*----------------------------------------------------------------------------------------------
/This example is minimalistic and will create a sample label. 
/You need to check which fields are relevant for your process and assign the values accordingly.
/----------------------------------------------------------------------------------------------*/

var result = await brixxApi.businessBrixx({
      functionName:"DPDShipping",
      methodName: "CreateShipment",
	  ShipAddress : {
		Company: 'Mustermann AG',
		Name: 'Max Mustermann',
		Street: 'Wailandtstr.',
		HouseNo: '1',
		ZipCode: '63741',
		City: 'Aschaffenburg',
		Country: 'DEU'
	  },
	  ParcelData : {
		Reference1: 'Customer email',
		Content: 'Order number',
		Weight: '13.5'
      }
      });
console.log("Parcel Number: " + result.ParcelNo)
brixxApi.printBlob(result.LabelData);


/*----------------------------------------------------------------------------------------------
/This example uses all fields
/You need to check which fields are relevant for your process and assign the values accordingly.
/----------------------------------------------------------------------------------------------*/
var result = await brixxApi.businessBrixx({
      functionName:"DPDShipping",
      methodName: "CreateShipment",
			OrderSettings : {
				language: 'de_DE',
				LabelSize : 'PDF_A4',
				LabelStartPosition : 'UpperLeft',
				ShipDate : app.getFieldValue("SomeFieldValue")
			  },
			ShipAddress : {
				Company: app.getFieldValue("SomeFieldValue"),
				Gender: app.getFieldValue("SomeFieldValue"),
				Salutation: app.getFieldValue("SomeFieldValue"),
				FirstName: app.getFieldValue("SomeFieldValue"),
				LastName: app.getFieldValue("SomeFieldValue"),
				Name: app.getFieldValue("SomeFieldValue"),
				Street: app.getFieldValue("SomeFieldValue"),
				HouseNo: app.getFieldValue("SomeFieldValue"),
				ZipCode: app.getFieldValue("SomeFieldValue"),
				City: app.getFieldValue("SomeFieldValue"),
				Country: app.getFieldValue("SomeFieldValue"),
				State: '',
				Phone: app.getFieldValue("SomeFieldValue"),
				Mail: app.getFieldValue("SomeFieldValue")			  
			  },
			ParcelData : {
				Reference1: app.getFieldValue("SomeFieldValue"),
				Reference2: app.getFieldValue("SomeFieldValue"),
				Content: app.getFieldValue("SomeFieldValue"),
				Weight: app.getFieldValue("SomeFieldValue"),
				YourInternalID: app.getFieldValue("SomeFieldValue"),
				ShipService: app.getFieldValue("SomeFieldValue")			  
			  }
      });
console.log("Parcel Number: " + result.ParcelNo)
brixxApi.printBlob(result.LabelData);

Example Usages

   let result = await brixxApi.businessBrixx({
      functionName:"DhlShiping",
      methodName: "GetLabel",
      shipmentNumber: app.getFieldValue("cordShipmentNumber")
   });
   window.open(result.labelUrl, "_blank");

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.

Needed output columns from SQL scripts

• 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.

SQL script examples

• sqlDataRead Example

• sqlMainData Example

• sqlGetCounter Example

Example Usages

 brixxApi.businessBrixx({
    functionName:"DatevExport",
    sqlDataRead:"getDatevData",
    sqlMainData:"getDatevMainData",
    sqlGetCounter:"getDatevBookingCounter",
    exportFromDate: moment().subtract(2,'months').startOf('month').format('YYYY-MM-DD'),
    exportUntilDate: moment().subtract(2,'months').endOf('month').format('YYYY-MM-DD'),
    consultantNumber: 1234567,
    clientNumber: 12345,
    company: 1,
    isDownload: true
 });

Example Usages Get

 let result = await app.businessBrixx({
    functionName:"Diamant",
    methodName: "OpenStack",
});
app.setFieldValue("myBookungStackNumber", result.data); //result.data is the stackNumber

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

 SELECT MAX(DatevExportId) FROM
 (
    SELECT ISNULL(MAX(cordDatevExportId), 0) AS DatevExportId FROM customerOrder WHERE cordCompanyId = @company
    UNION ALL
    SELECT ISNULL(MAX(sordDatevExportId), 0) AS DatevExportId FROM supplierOrder  WHERE sordCompanyId = @company
 ) AS sub

This is usually used in the onScan 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

Example Usages

 let result = await brixxApi.businessBrixx({
     functionName:"Gs1Splitter",
     methodName: "Split",
     gs1Code: "011234567890123417210521109988"
 });
 console.log(result)

Example Usages with Split Char (FNC1)

Especially with keyboard wedge scanners, it is often usefull to use a visible character as the FNC1 char.

 let result = await brixxApi.businessBrixx({
     functionName:"Gs1Splitter",
     methodName: "Split",
     gs1Code: "011234567890123417210521109988X211234",
     fnc1Char: 'X'
 });
 console.log(result.applicationIdentifiers['10'])

The result variable in this case:

{
   "applicationIdentifiers":{
      "10":"9988",
      "17":"210521",
      "21":"1234",
      "01":"12345678901234",
      "01.packind":"1",
      "01.iln":"2345678",
      "17.date":"20210521"
   }
}

This is the main script, which is responible for collection all the data, which needs to be exported.

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

 SELECT 
    head.id AS Auftragsnummer,
    ol.cordlnItemId AS Artikelnummer,
    ol.id AS ArtikelRecordId,
    ol.cordlnParagraph13b AS Paragraph13b,
    ol.cordlnNetOrderValue AS NettoWert,
    ol.cordlnGrossOrderValue AS BruttoWert,
    adr.adrDebitor AS Debitorenkonto,
    0 AS Kreditorenkonto,
    cordlnSalesAccount AS Sachkonto,
    adr.adrTaxId AS SteuerID,
    cordlnTaxKey as Buchungsschluessel,
    '' AS Buchungstext,
    head.cordInvoiceDate AS Rechnungsdatum,
    head.cordInvoiceNumber AS Rechnungsnummer,
    head.cordShippingDate AS Leistungsdatum,
    atta.id AS AttachementId,
    'customerOrder' AS BuchungszaehlerTabelle,
    'cordDatevExportId' AS BuchungszaehlerSpalte,
    CASE WHEN fiac.finaccIsAccountSplitting = 1 THEN fiacsplit.facsIsAutomaticAccount ELSE fiac.finaccIsAutomaticAccount END AS IstAutomatikKonto,
    head.cordInterCompanyOrder as IstInnerbetrieblich
 
 FROM dbo.bbv_customerOrderLine AS ol
 LEFT JOIN [dbo].[customerOrder] AS head ON head.id = ol.cordlnOrderId
 LEFT JOIN address AS adr ON adr.id = head.cordAddressId
 LEFT JOIN brixx_Attachments AS atta ON atta.id in (select AttachmentId from brixx_AttachmentLinks where RecordId = head.id AND TableName = 'customerOrder' ) AND atta.DocumentTypeId = 2
 LEFT JOIN financialAccount AS fiac ON fiac.finaccAccountNumber = cordlnSalesAccount
 LEFT JOIN financialAccountSplitting AS fiacsplit ON fiacsplit.facsAccountId = fiac.id AND fiacsplit.facsSplitAccount = fiac.finaccAccountNumber
 WHERE ol.cordlnOrderId IN 
 (
    SELECT id FROM [dbo].[customerOrder] 
    WHERE cordShippingDate >= @dateFrom AND cordShippingDate <= @dateUntil
    AND cordCompanyId = @company
 )
 AND ol.cordlnNetOrderValue > 0
 AND head.cordStatusId >= 4
 
 UNION
 
 SELECT 
    head.id AS Auftragsnummer,
    ol.sordlnItemId AS Artikelnummer,
    ol.id AS ArtikelRecordId,
    ol.sordlnParagraph13b AS Paragraph13b,
    ol.sordlnNetOrderValue AS NettoWert,
    ol.sordlnGrossOrderValue AS BruttoWert,
    0 AS Debitorenkonto,
    adr.adrKreditor AS Kreditorenkonto,
    sordlnitmProcurementAccount AS Sachkonto,
    adr.adrTaxId AS SteuerID,
    sordlnTaxKey AS Buchungsschluessel,
    '' AS Buchungstext,
    head.sordGoodsReceiptDate AS Rechnungsdatum,
    head.sordInvoiceNumber AS Rechnungsnummer,
    head.sordGoodsReceiptDate AS Leistungsdatum,
    atta.id AS AttachementId,
    'supplierOrder' AS BuchungszaehlerTabelle,
    'sordDatevExportId' AS BuchungszaehlerSpalte,
    CASE WHEN fiac.finaccIsAccountSplitting = 1 THEN fiacsplit.facsIsAutomaticAccount ELSE fiac.finaccIsAutomaticAccount END AS IstAutomatikKonto,
    head.sordInterCompanyOrder as IstInnerbetrieblich
 
 FROM dbo.bbv_supplierOrderLine AS ol
 LEFT JOIN [dbo].[supplierOrder] AS head ON head.id = ol.sordlnOrderId
 LEFT JOIN address AS adr ON adr.id = head.sordAddressId
 LEFT JOIN item AS itm on itm.id = ol.sordlnItemId 
 LEFT JOIN brixx_Attachments AS atta ON atta.id in (select AttachmentId from brixx_AttachmentLinks where RecordId = head.id AND TableName = 'supplierOrder' )
 LEFT JOIN financialAccount AS fiac ON fiac.finaccAccountNumber = ol.sordlnitmProcurementAccount
 LEFT JOIN financialAccountSplitting AS fiacsplit ON fiacsplit.facsAccountId = fiac.id AND fiacsplit.facsSplitAccount = fiac.finaccAccountNumber
 WHERE ol.sordlnOrderId IN 
 (
    SELECT id FROM [dbo].[supplierOrder] 
    WHERE head.sordGoodsReceiptDate >= @dateFrom AND head.sordGoodsReceiptDate <= @dateUntil
    AND sordCompanyId = @company
 )
 AND ol.sordlnNetOrderValue > 0
 AND head.sordStatusId = 5

Example Usage

The data is passed to the interface as a JSON array. All fields available in the documentation can be inserted here! Please not that several data sety can be transferred at the same time.

let result = await app.businessBrixx({
    functionName: "Diamant",
    methodName: "Transaction",
    company: 1,
    transactions: [{
        transactionType: 'AR',
        stacknumberSpecified: false,
        ///...,

        accountAssignmentTab: [{
            accountNo: '12345',
            taxCode: 19,

            //...,

            cAccDataTab: [{
                costCenter: '123a',
                //...
            },
            {
                costCenter: '123b',
                //...
            }],

            oIDataTab: [{
                accountNo: '123456',
                amount: 100.00,
                amountFieldSpecified: true,
                //...
            },
            {
                accountNo: '333456',
                amount: 150.00,
                amountFieldSpecified: true,
                //...
            }]
        },
        {
            transactionType: 'AR',
            stacknumberSpecified: false,
            ///...,

            accountAssignmentTab: [{
                accountNo: '44345',
                taxCode: 19,

                //...,

                cAccDataTab: [{
                    costCenter: '123a',
                    //...
                },
                {
                    costCenter: '123b',
                    //...
                }],

                oIDataTab: [{
                    accountNo: '123456',
                    amount: 100.00,
                    amountFieldSpecified: true,
                    //...
                },
                {
                    accountNo: '333456',
                    amount: 150.00,
                    amountFieldSpecified: true,
                    //...
                }]
            }]
        }]
    }]
});
console.log(result);

Parameters

1. controlId => Id of the control

2. helpText => the new text, you want to set or empty to remove an existing text

Example Usages

   brixxApi.changeHelpText("myControl", "Hello World");

Get Method

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.

Example Usages Get

This will retrieve all addresses from diamant. Field names are the original diamand field names

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "Get",
     company: "9018",
     dataType: "Address",
 });
 console.log(result)

This will retrieve all addresses with Postcode 61118 from diamant and return the result. Only the fields "key" and "Name1" will be returned.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "Get",
     dataType: "Address",
     searchParams:{
         postcode: "61118"
     },  
     usedFields:["key", "Name1"]

 });
 console.log(result)

Write to Diamant

This code will write an address to Diamant

let result = brixxApi.businessBrixx({
   functionName: "Diamant",
   methodName: "Save",
   dataType: "Address",
   fields: {
      key: "12345",
      addresstype: "F",
      name1: "John Doe",
      street: "Elmstreet 123",
      postcode: "12345",
      town: "Berlin",
   },
});

ImportTable Method

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

Example Usages Import Insert

This will retrieve all addresses from diamant and insert it into the table address the table will be wiped right before the import.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "ImportTable",
     dataType: "Address",
     tableName: "address",
     wipeTable: true,
     fieldMatch:{
         postcode: "adrZip",
         name1: "adrName"
     }, 
 });
 console.log(result)

Example Usages Import Upsert

This will retrieve all addresses from diamant and update the records with the same id as in fieldMatch.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "ImportTable",
     dataType: "Address",
     tableName: "address",
     upsert: true,
     wipeTable: true,
     fieldMatch:{
         key: "adrKey,id",
         postcode: "adrZip",
         name1: "adrName"
     }, 
 });
 console.log(result)

Supported dataTypes

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

• OpenStack

• Transaction

• CloseStack

Parameters

1. controlId - id of the grid control

Example Usages

   brixxApi.clearGridSelection(myGrid);

Sends a PDF to a printer, that is connected by the BrixxboxCloudGateway. You can sent a document to a cloudprinter by using createReport as well

Parameters

A json object

Example Usages

Print an existing attachment

   brixxApi.cloudPrint({
      printerName: "HP LaserJet", //Printer NAme
      attachmentId: "1", //Attachment id
   });

Print an existing attachment with multiple copies

   brixxApi.cloudPrint({
      printerName: "HP LaserJet", 
      attachmentId: "1", 
      copies: 5 // 1 copy is the default. Needs "cloudPrint Gateway" installer Version 1.0.1 or newer
   });

Print a new created report without archiving

   let myReport = await brixxApi.createReport("myReport");
   brixxApi.cloudPrint({
      printerName: "HP LaserJet", //Printer NAme
      blob: myReport, //The report blob object
   });

Parameters

1. emailOptions - (optional) Json object with email parameters.

   • to - array of email addresses

   • cc - array of email addresses

   • bcc - array of email addresses

   • text - message text

   • subject - subject

   • from - single string with an email address

   • replyTo - single email, that will be used as to reply to

   • autoSend - if set to true, the mail will be send automatically. You will not see a dialog at all. (Default is false)

   • hideToEmail - if set to true. The recipients email address is hidden in the email dialog

   • attachmentIds - an array of attachment ids that will be sent as an attachment,

   • attachmentBlobs - an array of blobs objects that will be sent as an attachment, {name: myFileName, blob: myBlob}

   • recordId - RecordId if you would like to attach the email to an record. If empty, this is the current record Id (available from 18.11.2021)

   • appName - AppName if you would like to attach the email to an record. If empty, this is the current App Name (available from 18.11.2021)

Example Usages

Example 1

Shows the dialog without any predefined values

Shows the dialog text and to addresses

Example 2

Sends the email without a dialog

Example 3 - attachment blobs

Example 4 - attachment ids

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

Example Usages Get

Requests Data from a CloudGateway Enpoint

Parameters

Example Usages

Query an address from a firebird database

Parameters

1. url - The url of the teams or slack channel, see the video to learn how to get a WebHook url.

Example Usages

Plain text message

full styled message with actions

Creates a deep copy from a config record. Typical example is to create a copy of an "order" record, with a copy of all the "orderLines" from that source "order". brixxbox will use the "Cascade Copy" flag of a grid control, to decide if which referenced records will be copied.

Parameters

1. configName

2. recordId - the id of the source record

3. additionalValues - json object of values in the target record that should be modified. e.g. an "orderDate" field. Can be null, in this case you get a 1:1 copy except the record id.

Example Usages

Exact copy:

Copy with new date for header data and manipulating two columns of line item data:

Example Usages

Parameters

1. options - Json object with the same properties as [createPublicAppUrl](/globalDoc/function_createPublicAppUrl) options, plus:

   • publicUser - the user email address of the brixxbox user, that will be used for the public app .

Example Usages

Parameters

1. reportControlId - the id of the reportControl in your app. This can be invisible, if you don't need a preview.

2. createOptions - JSON Object with options

   • print - (bool, default = false) if set to true, this will trigger the print dialog after the report is create.

   • archive - (bool, default = false) if set to true, the report is saved as an attachment to the current record,

   • saveFile - if set. the report will be downloaded with a generic file name (brixxbox-print.pdf), except, if saveFileName is set.#

   • saveFileName - if set. the report will be downloaded with that file name.

   • reportId - (optional) if defined, this will overruled the reportId given for the control in the config editor. This is not the controlId, but the id (name) of the report definition

   • cloudPrinter - (optional) the created report will be send to the cloud printer right after creation.

Like a on a dataRequest, all controls of the current app will bo automatically send as report parameters, plus the recordId of the current record as "id", even if you dont have a control "id" in your app.

Example Usages

Create a report and send it to a cloud printer

Parameters

1. controlId - The id of the calendar control

Example Usages

Introduction

This documentation provides a complete overview of the xRechnung object used in the createPdf endpoint for generating ZUGFeRD-compliant invoices. The xRechnung object contains key information required to create a legally compliant electronic invoice, following the specifications of the XRechnung format.

Payload Structure

The xRechnung object is part of the main payload sent to the createPdf endpoint. Below is the structure and detailed explanation of all properties within the xRechnung object.

Main Payload Structure

xRechnung Object Details

1. invoiceMain

This object contains the main details of the invoice, including invoice number, dates, buyer, seller, and payment terms.

• Type: object

• Properties:

  • invoiceNo (string): The unique identifier of the invoice.

  • invoiceDate (DateTime): The date the invoice was issued.

  • paymentReference (string): Reference used for payments.

  • orderNo (string): The related order number.

  • orderDate (DateTime): The date of the related order.

  • currency (enum): The currency of the invoice. See currency enum.

  • buyer (object): Information about the buyer.

  • seller (object): Information about the seller.

  • notes (array): Notes related to the invoice.

  • paymentTerms (object): The terms of payment.

  • grandTotalAmount (decimal): The total amount of the invoice.

  • duePayableAmount (decimal): The amount due for payment.

  • Other related invoice properties.

2. additionalReferencedDocuments

This array contains documents that reference the invoice, such as orders or contracts.

• Type: array

• Properties:

  • id (string): Identifier of the referenced document.

  • issueDateTime (DateTime): Date and time the document was issued.

  • referenceTypeCode (enum): Reference type code. See referenceTypeCode enum.

  • attachmentBinaryObject (string): Base64 encoded binary object of the attachment.

  • filename (string): Filename of the attachment.

  • typeCode (enum): Type code for the document. See typeCode enum.

3. tradeLineItems

This array contains items or services billed in the invoice.

• Type: array

• Properties:

  • globalID (object): Global ID of the item or service.

  • sellerAssignedID (string): ID assigned by the seller.

  • name (string): Name of the item or service.

  • billedQuantity (decimal): Quantity billed.

  • lineTotalAmount (decimal): Total amount for the line item.

  • taxCategoryCode (enum): Tax category code. See taxCategoryCode enum.

  • netUnitPrice (decimal): Net unit price of the item.

  • unitCode (enum): Unit code for the item. See unitCode enum.

  • Other related line item properties.

4. taxes

This array contains detailed tax information applied to the invoice.

• Type: array

• Properties:

  • basisAmount (decimal): Amount on which the tax is calculated.

  • percent (decimal): Tax percentage.

  • typeCode (enum): Type of tax. See taxType enum.

  • categoryCode (enum): Tax category code. See taxCategoryCode enum.

  • exemptionReasonCode (enum): Reason for tax exemption. See exemptionReasonCode enum.

5. serviceCharges

This array contains additional charges applied to the invoice.

• Type: array

• Properties:

  • tax (object): Tax information related to the service charge (similar to taxes object).

  • amount (decimal): Amount of the service charge.

  • description (string): Description of the service charge.

6. receivableSpecifiedTradeAccountingAccounts

This array contains accounting accounts related to the trade, either receivable or payable.

• Type: array

• Properties:

  • tradeAccountID (string): ID of the trade account.

  • tradeAccountTypeCode (enum): Type of trade account. See tradeAccountTypeCode enum.

Enumerations

1. currency

Represents currency codes.

2. schemeID

Identification schemes for IDs.

3. country

Country codes.

4. subjectCode

Subject codes for notes.

5. contentCode

Content codes for notes.

6. profile

Invoice profiles.

7. type

Invoice types.

8. referenceTypeCode

Reference type codes for documents.

9. taxCategoryCode

Tax category codes.

10. taxType

Tax types.

11. electronicAddressSchemeID

Electronic address schemes.

12. typeCode

Document type codes.

13. unitCode

Unit codes for line items.

14. paymentMeansTypeCode

Payment means type codes.

15. tradeAccountTypeCode

Trade account type codes.

This documentation provides a complete and structured overview of the xRechnung object, including all properties and enumerations used in the payload.

Parameters

1. configName - the name of the config

2. id - the record id you want to delete

Example Usages

Parameters

1. downloadOptions - JSON object

   • requestedIds - list of ids to download

   • fileName - (optional) name of the downloaded file

Example Usages

Parameters

1. param - The type of message. The following messages types are supported

   • "save" - The save Message

Example Usages

Parameters

• attachmentId - the id of the attachment you want to delete

Example Usages

Parameters

1. procedureName - The name of the stored procedure

2. procedure parameters - If you need to add parameters, you can use this json object to set them

3. queryOptions - (optional) a json object with options for the request

   • timeout - (optional) timeout for the SQL Request. Default is 30 seconds

   • connectionKey - (optional) a key to a custom settings entry with the connection string to an external MSSQL database

Example Usages

1. Simple (pay attention to the await keyword)

2. With parameters (pay attention to the await keyword)

3. Short version (pay attention to the await keyword)

4. With Timeout