Custom Guided Wizard
Button URL Structure

Transaction

8min

Basic URL Structure

Button URL


Please note that the only field that should contain a Salesforce ID is the originating record field. Additionally, this is the only field containing brackets, {}. All other fields will contain the API name of the field without brackets. The API name is easiest copied from the Salesforce Setup page, which shows all the fields on the originating object.

Testing

We recommend using &testing=true to access our testing page when building the URL. You can temporarily build this into the URL formula or append it to the URL after clicking the New Transaction button. This testing page will display the API names you have been passed and the corresponding values Breadwinner retrieved based on the API names. It acts as a confirmation page and is visible only when testing is set to true.

Button URL


Once you review and feel confident, you may remove the &testing=true from the Button URL.

Transaction Level Fields

Payment Amount

You can optionally populate the Payment Amount using the Originating object field. A Formula field with a number data type will also work. If you assign the field API name to the payment_amount param, Breadwinner will show this field value on the Payment Amount.

Button URL


Payment Currency

You can optionally populate the Payment Currency using the Originating object field. A Formula field with a text data type will also work. If you assign the field API name to the payment_currency parameter, Breadwinner will show this field value in the Payment Currency.

Button URL


Payment Description

You can optionally populate the Payment Description using the Originating object field. A Formula field with a text data type will also work. If you assign the field API name to the payment_description parameter, Breadwinner will show this field value in the Payment Description.

Button URL


Summary of all fields available for a New Transaction

The structure of a Button URL to create a new Transaction with all possible fields is shown below.

Button URL




Updated 17 Jun 2024
Doc contributor
Did this page help you?