| **1** | Customer Code |
| **2** | Customer name |
| **3** | Customer Address |
| **4** | Customer default contact person |
| **5** | Customer contact email address |
| **6** | Customer contact mobile number |
| **1** | Inventory Code |
| **2** | Description |
| **3** | Long Description |
| **4** | Group Code |
| **5** | Default price structure |
| **6** | Default cost price |
| **7** | Default sell price |
| **8** | Upload the primary image |
| **1** | Weather type - Rain, sunny |
| **2** | Weather description |
| **3** | Minimum and Maximum temperature for the day |
| ;collection |
| key = ........(paste key here from website signup) |
| **Field** | **Description** | **Example** |
|---|---|---|
| Address Line 1 | The street address | 1188 Lois Avenue |
| Address Line 2 | The suburb, or local area | Menlyn |
| Address Line 3 | The city | Pretoria |
| Address Line 4 | The region or province | Gauteng |
| Country | The selected country, defaults to South Africa | South Africa |
| GPS Coords | Optional GPS coordinates, comma separated latitude then longitude | -25.7863272, 28.334732 |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Customer | Yes | Yes | Used for Delivery Address and Delivery Contact. Required to save a new Invoice. The delivery address used is the Customer address for the Address Type selected in the Shipping tab. The numbered address fields are required to be for the same address components as the Branch Address, e.g. Address Line 1 is for the Street Address. If a Contact Person is not selected from the Address tab then the Delivery Contact is obtained from the selected customer instead. The first name, last name, email and mobile number of is used, with the name and either the email or mobile number being required. |
| Sales Rep | No | ||
| Reference | Yes | No | Becomes the customer reference for the delivery if set |
| Internal Contact | Yes | Yes | Used for the Collection Address and Collection Contact. The collection address becomes the Physical Address of the Branch the user belongs to. The first and last name, and email and mobile number are used, with the email or mobile number being required as with the Delivery Contact. |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Address Type | No | Address that when selected will populate the address fields in this tab. | |
| Address Fields | No | Currently is not used. Instead the unedited customer address for the selected customer in the Detail Tab and address type in the Shipping Tab is used for the delivery address. | |
| Contact Person | Yes | No | Overrides the default contact person for the Customer if selected. The name and email or mobile number of the Contact Person is required. |
| View Button | N/A | No | Can be used to edit the details for the selected Contact Person. |
| Contact No | Yes | No | If set then this Contact Number is used instead of the Mobile Number for the selected Contact Person or default Debtor Contact Person. |
| Region | No | Is unrelated to the Region given in the addresses. | |
| Branch | No | The branch address is from the branch the Internal Contact belongs to. |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Shipping Terms | Yes | Yes | Required to populate the Delivery Company combo box and then select the Courier Company for Ship Logic. For more information view the . |
| Collect / Ship Date | No | Currently not used for Ship Logic, but could be used to schedule the collection date and time. | |
| Shipping Options - email | Yes | No | If checked then delivery updates are sent to the Collection contact by email or SMS. |
| Shipping Options - other | No | These shipping options do not apply to Ship Logic. \[NEW\] | |
| Pickup Instructions | Yes | No | Special instructions for the delivery driver when collecting the shipment. \[NEW\] |
| Delivery Instructions | Yes | No | Special instructions for the delivery driver when delivering the shipment. \[NEW\] |
| Delivery Company | Yes | Yes | Required to select the Courier Company that has for its Courier API field Ship Logic set. For more information view the . |
| Address Type | Yes | No | The type of customer address such as Physical, Delivery or Postal. If unselected then the Delivery address is used. |
| Validate Button | No | No | Validating address is unsupported by Ship Logic. Click this button will show an error indicating this. \[NEW\] |
| Update Customer Address | No | No | Requires address validation to be supported. \[NEW\] |
| Parcel Dimensions display field | No | No | Displays the information about the current parcel selection for the shipment to be created. If blank then there is no parcel selection. If faded then the shipment was created for the parcel selection. |
| Custom Parcel Dimensions button | N/A | Yes | Clicking on this opens the Parcel Selection window, which is required for specifying information about the parcels for the shipment. This is explained in the next section. |
| Service Type | Yes | No | Is now used to pre-select a rate from the list of available rates retrieved from ShipLogic that are presented when the Courier API button is clicked. |
| Tracking No | No | Displays the last Tracking Number that is assigned to the Invoice. This can be edited and be related to shipping functions outside of ShipLogic. | |
| Tracking No buttons | No | These buttons can be used to add a new Tracking Number to the Invoice or view the list of existing Tracking Numbers for the Invoice. The tracking numbers do not need to have been created with Ship Logic. | |
| Delivery Status display field. | Yes | No | Displays the current shipping status for the last shipment created with Ship Logic. |
| Update Delivery Status | Yes | No | Clicking this button will perform an API request with Ship Logic to update the Delivery Status display field. |
| Auto checkbox | Yes | No | Having this checked will cause the Delivery Status display field to be updated when the Invoice is opened and there is a shipment created with Ship Logic for it. |
| Courier API button | Yes | Yes | This button is required to be clicked on before a shipment for the Invoice can be created with Ship Logic. If there is a selection of parcels created, and the other requirements are met, a window with a list of available shipping rates, or services types, will be presented, of which one can be selected and a shipment created. \[NEW\] |
| Details | No | For unrelated shipping functions. The Pickup and Delivery instructions may also be set in the form that opens after clicking the button, but it is unnecessary when these fields already exist in the current form. | |
| Save Shipping | Yes | Yes | Is required to save the Shipping Tab fields if the Invoice Save button is disabled as it is when the Invoice status is Posted. The Customer, Internal Contact and Reference fields are not saved. The Shipping Tab fields are also saved automatically when the Courier API button is clicked. |
| **Component** | **Description** |
|---|---|
| Search button | Clicking this will reload the grid from the server |
| Add | Clicking this opens a dialog to add a new parcel |
| Edit | When one row is selected and is for a parcel without a shipment, the same dialog that is opened with the Add button is opened to edit information for the selected row. |
| Delete | When at least one row is selected and the rows do not include rows for created shipments, the rows will be deleted without confirmation. Multiple rows are selected by holding down the control key and clicking on the rows to add to the selection. |
| Include Tracked \[NEW\] | To include parcels with a shipment in the grid this checkbox is checked. To only show the parcels for the next shipment, it is unchecked. |
| Name column | The name given to the parcel. This is not required by Ship Logic but is necessary if created from a parcel template. |
| Shipment column \[NEW\] | This column is hidden by default. To unhide it, open the menu for the column and check the box for it in the "Columns" submenu. If there is a shipment number associated with the parcel then it is shown in the row. If there is not shipment number but there is tracking number then "Unavailable" is shown To group the rows by this column, open the menu for the column and click "Group by this field". |
| Shipment Created \[NEW\] | This column is hidden by default and needs to be enabled in the Columns submenu. If a shipment was created that includes the parcel this column will show the date and time it was created if this information is available. |
| Dimensions (L x W x H) | Show the length, width and height of the parcel in centimeters |
| Wgt | The weight in kilograms |
| Qty | The number of parcels with the same dimensions and weight in the shipment |
| Close button | Closes the window. When the window is closed the Parcel Dimensions field in the Shipping tab of the Invoice form will be refreshed from the server. |
| **Field** | **Description** | **Example** |
|---|---|---|
| Address Line 1 | The street address | 1188 Lois Avenue |
| Address Line 2 | The suburb, or local area | Menlyn |
| Address Line 3 | The city | Pretoria |
| Address Line 4 | The region or province | Gauteng |
| Country | The selected country, defaults to South Africa | South Africa |
| GPS Coords | Optional GPS coordinates, comma separated latitude then longitude | -25.7863272, 28.334732 |
| Xero Sales Acc | Here you can specify which sales Xero items must go to |
| Xero COS Acc | Here you can specify which Cost of Sales Xero items must go to |
| Xero Division | Here you can set up your Xero Division as default |
| Xero Sales Rep | Here you can select a Sales Rep as a default |
| Set Xero Tenant | Once you have Authenticated your Debtors, Creditors and Inventory, you will need to set the Xero Tenant which is a once off setup. |
Make sure that the Debtors and Creditors codes are not duplicated in Huge ERP as Xero does not have separated databases for customers and suppliers. They are the contact list but marked as a customer and supplier. Having the the same code in debtors and creditors will cause problems in the sync.
#### Procedure 1. Export customer, supplier and inventory lists from Xero 2. Fix data files for Huge ERP import 3. Import the data into Huge ERP 4. Link API to Xero 5. Verify codes for Customers 6. Verify codes for Suppliers 7. Verify codes for Inventory --- #### Verify ##### Customers verify ** Debtors Module> Configuration> Debtors Setup** Click Search all Debtors Run this utility to check customers in Xero and Huge ERP. When the utility finds the same customer, it will write an internal code from Xero into the tables of Huge ERP. Whether the customer is updated, Huge ERP knows which customer to update in Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/fzRimage.png) This is a once off setting that needs to be done, once this has been done and you Add a new debtor, it will automatically sync to Xero --- ##### Verify Creditors ** Creditors Module> Configuration> Creditors Setup** Clock search all Creditors Run this utility to check suppliers in Xero and Huge ERP. When the utility finds the same supplier, it will write an internal code from Xero into the tables of Huge ERP. Whether the supplier is updated, Huge ERP knows which Supplier to update in Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/PA1image.png) This is a once off setting that needs to be done, once this has been done and you Add a new Creditor, it will automatically sync to Xero --- ##### Inventory verify ** Inventory Module> Configuration> Inventory Setup** Click Search all Items Run this utility to check customers in Xero and Huge ERP. When the utility finds the same inventory, it will write an internal code from Xero into the tables of Huge ERP. Whether the inventory is updated, Huge ERP knows which item to update in Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/lEWimage.png) This is a once off setting that needs to be done, once this has been done and you Add a new Inventory item, it will automatically sync to Xero --- #### Xero Sales and Cost of Sales for an Inventory Item To set up a specific Sales and COS account for an inventory item, double click on the inventory item Go the Comment/Replace Tab, here you can stipulate a specific account that this item must go to when adding this item to an invoice. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/571image.png) # Troubleshooting #### Trouble Processing a Transaction If you are trying to process an invoice, Credit Note, GRV or a Stock Return and you get an error, you can disconnect Huge ERP from Xero. **System Configuration > Security >API Setup** Click Search Double click on Xero to open [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/On7image.png) Untick the Active Box and click save and close [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/PPpimage.png) --- #### Failed to post to Xero ##### Invoice **Debtors Module > Activity > Invoice** When you have an invoice that Fails to push through to Xero, you can process this manually. Open your invoice Click the "Action" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/kT0image.png) ##### Credit Note **Debtors Module > Activity > Credit Note** When you have a Credit Note that Fails to push through to Xero, you can process this manually. Open your Credit Note Click the "Action" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/9ptimage.png) ##### ##### GRV **Creditors Module > Activity > Goods Received Note (GRV)** When you have a GRV that Fails to push through to Xero, you can process this manually. Open your GRV Click the "Extras" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/JQyimage.png) ##### ##### Stock Return **Creditors Module > Activity > Return to Supplier (RTS)** When you have a Stock Return that Fails to push through to Xero, you can process this manually. Open your Stock Return Click the "Action" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. --- #### View Posted and Non posted Transactions ##### Debtors **Debtors Module > Analysis >Debtors Document History** In the column "Posted to Xero" you will see either Yes which means it was posted to Xero or blank which means it has not been posted to Xero [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/38Cimage.png) To post to Xero double click to open the transaction Click the "Action" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/lDZimage.png)Double check your transaction is not already in Xero as clicking this will duplicate the transaction if it was already posted
##### Creditors **Creditors Module > Analysis >Creditors Document History** In the column "Posted to Xero" you will see either Yes which means it was posted to Xero or blank which means it has not been posted to Xero [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/Yneimage.png) To post to Xero double click to open the transaction Click the "Extras" Tab, you will see the button "Push to Xero" by clicking this button the transaction will be pushed to Xero. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2025-01/JLdimage.png)Double check your transaction is not already in Xero as clicking this will duplicate the transaction if it was already posted
# Shopify API # Shopify Creating the Shopify link with Huge ERP Look into the setup of Shopify on the following internal link: [Shopify setup](https://hugeerp10.co.za/hsofmanual/books/shopify "Shopify") # Shopify Link #### Shopify setup Select the "Apps and sales channels" menu in settings [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/qkximage.png) Click on the "Develop apps" button. Click on the "Create an app" button. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/91qimage.png) Click on the "Configure Admin API scopes" [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/WZNimage.png) **Select the following options:** write\_assigned\_fulfillment\_orders, read\_assigned\_fulfillment\_orders, read\_customer\_events, write\_customers, read\_customers, write\_draft\_orders, read\_draft\_orders, write\_inventory, read\_inventory, write\_orders, read\_orders, write\_products, read\_products Click the "Install app" button at the top. --- #### Huge ERP setup Add the following in the API setup [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/r8Timage.png) The keys are in the "API credentials" tab on the Shopify app. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/A50image.png) Enter the "API key" as the user name and the "API secret key" into the API Key field Select the required functions [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-01/y2Ximage.png) # GoSweetSpot # GoSweetSpot API Setup ##### Basic Instructions Get API Key from GoSweetSpot account [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-06/rN2image.png)Notes
\## Fields ## Only the API Key is required; the optional config settings are entered in the config field (TBD) \## Config items ## \*\*ini formatted text\*\* \- supportemail - optional, may be used by GoSweetSpot to email developer \- side\_id - optional, used if the GoSweetSpot Site field in the branch company setup in SCM is not set \- excludeContactInfo - optional, if set to 1 or "yes" then contact information is not included when creating a shipment # Setup of GoSweetSpot Register your company with GoSweetSpot and login. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/v7rimage.png) 1. Get the API Key from the GoSweetSpot account page in Administraton; Preferences & Settings; Advanced Settings; API Key \[TODO screenshot\] 2. Copy it into the **API Key** field [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/eOWimage.png) [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/Yauimage.png) ## **API Setup** 1. Log into the Huge ERP System 2. Go to the **API Setup** search grid in SCM User actions: SCM; Security; API Setup; 3. Click **Add** 4. In the **API** combo box select "GoSweetSpot" (Remove all other user name and passwords that may be populated ) 5. Paste API Key in API Key field. 6. Tick **Activate** 7. Click **Save and close** [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/DxYimage.png) 1. Create a Creditor for GoSweetSpot 1. User actions: Creditors; Configuration; Creditors Setup; Creditors Setup: Add; 2. Fill out fields in **Details Tab:** 1. **Creditors Code** – e.g. "GOSWEET" 2. **Name** – e.g. "GoSweetSpot" 3. **Short Name** – e.g. "GOSWEET" 3. Uncheck in **Details Tab:** (optional) - **Print Statement** - **Email Statement** - **Sync to Mobile** 4. In the **Info Tab** select "GoSweetSpot" in the **Use Courier API** combo box field. 5. Click **Save & Close** [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/t3Rimage.png) On GoSweetSpot get your site No. which you will find under **Support** [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/xQoimage.png) Add your Site No. to your company profile 1\. Company Profile: Search in SCM; Administration; Company Profile; double click to edit Company Profile; Address; Add Site No. to GoSweetSpot field; **Save** [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/vAiimage.png) ## **Courier Setup** 1\. Search in SCM; Administration; Courier Setup; Click Add; Add Code, Courier API, Select GoSweetSpot; Add description, Click Default, Save [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/Vbdimage.png) ## **Parcel Setup** GoSweetSpot allows pre-defined parcel sizes to be referenced in new shipments. you can find your standard parcel sizes in Go SweetSpot. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/wfBimage.png) To setup parcel sizes go to 1. Go to the **Courier**** Setup** search grid in SCM User actions: SCM; Administration; Courier Setup; Parcel Sizes 2. These can be added to reflect your personal box or satchel sizes. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/Ncoimage.png) This is what it should look like once added in. [](https://hugeerp10.co.za/hsofmanual/uploads/images/gallery/2024-04/sHQimage.png) # GoSweetSpot Courier Delivery Setup and Usage ## ### #### From the GoSweetSpot account navigate to the Preference & Settings page by selecting from the Administration menu. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/eytimage.png) Scroll down and click Advanced Settings to expand this section. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/P5timage.png) Scroll to the bottom of this section and copy the API Access Token to the clipboard. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/UpGimage.png) #### Get the Site ID The Site ID is linked to the collection address that is used when creating an account with GoSweetSpot. From the GoSweetAccount navigate to the Users & Permissions page by selecting Manage Users from the Administration menu. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/FJMimage.png) Copy the Site ID from the Site column that is linked to the collection address for courier shipments created from HugeERP. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/AKTimage.png) ### API Setup Return to Huge ERP and navigate to API Setup in the SCM module under Security. Click the Add button in the top toolbar. Select GoSweetSpot from the API combo box in the Add form. [](https://hugeerp0.co.za/hsofdocs/uploads/images/gallery/2024-07/l4oimage.png) Copy the API Key from GoSweetSpot to the API Key field. Make sure the Active checkbox is checked. The User Name and Password fields are not required and can be left blank. The config field can specify optional settings. Each setting is required to be on a separated line and begins with the name of the setting followed by an equals sign and then the value for the setting. So far the available settings are as follows:| **Name** | **Description** |
| side\_id | The Site ID to use if it is missing from the Company Branch setup |
| excludeContactInfo | If the value is "yes" without the quotes, then contact info for the delivery recepient, such as the name and phone number, is to be excluded when creating a shipment. |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Customer | Yes | Yes | Required to save the Invoice. The address fields in the Address tab is populated with the address of the selected Customer. \[TODO\] The default contact is used as the delivery contact if the contact person is not set in the Address tab. \[TBC - check if the contact information from the Debtor Details form is still in use\] |
| Reference | No | ||
| Order Number | Yes | No | Used as the reference for the shipment. |
| Internal Contact | Yes | Yes | Used to get the Site ID from the Company Branch that the selected user belongs to. |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Address Type | Yes | Address that when selected will populate the address fields in this tab for editing. | |
| Address Lines 1-4 | Yes | Line 1 is either a street address or building number. If it begins with a number then it is assumed to be a street address, otherwise the street address in contained in Line 2. The lines following the street address line are for the suburb and city that order. The address can be validated and corrected from the Shipping tab by clicking the Validate Address button. | |
| Address Code | Yes | The post code for the address. | |
| Contact Person | Yes | Yes | References the contact person for the delivery. The name, email and mobile or phone number of the contact person is included when the shipment is created, unless disabled in the API setup in the config field with the excludeContactInfo setting. \[TODO\] Overrides the default contact person for the Customer if selected. The name and email or mobile number of the Contact Person is required. |
| View Button | Yes | No | Can be used to edit the details for the selected Contact Person. |
| Contact No | Yes | No | \[TODO\] If set then this Contact Number is used instead of the Mobile Number for the selected Contact Person or default Debtor Contact Person. |
| Branch | No | The branch address is from the branch the selected Internal Contact belongs to. |
| **Component** | **Used** | **Required** | **Description** |
|---|---|---|---|
| Shipping Terms | Yes | Yes | Required to populate the Delivery Company combo box and then select the Courier Company for GoSweetSpot. For more information view the . |
| Collect / Ship Date | No | Currently not used by GoSweetSpot | |
| Shipping Options - Email | Yes | No | If checked then delivery updates are emailed to the delivery contact. |
| Shipping Options - Signature | Yes | No | If checked then a signature is required on delivery. |
| Shipping Options - Saturday | If checked then delivery will be on a Saturday, increasing the rates. | ||
| Pickup Instructions | No | No | Not used with GoSweetSpot when using the Site ID. |
| Delivery Instructions | Yes | No | Special instructions for the delivery driver when delivering the shipment. |
| Delivery Company | Yes | Yes | Required to select the Courier Company that has GoSweetSpot set as its Courier API. For more information view the . |
| Validate Button | No | No | Clicking this button will validate the address set in the Address tab and open a window with the result and options to update the address. For more information view the [Validating the Delivery Address section](https://hugeerp0.co.za/hsofdocs/link/131#bkmrk-validating-the-deliv). |
| Update Customer Address | Yes | No | Opens a window to edit the Customer address selected in the Address tab. When saved the address will be saved to the customer. \[TBC - save to the document too\] |
| Parcel Dimensions display field | No | No | Displays the information about the current parcel selection for the shipment to be created. If blank then there is no parcel selection. If faded then the shipment was created for the parcel selection. |
| Custom Parcel Dimensions button | N/A | Yes | Clicking on this opens the Parcel Selection window, which is required for specifying information about the parcels for the shipment. This is explained in the next section. |
| Service Type | No | No | Is no longer necessary for creating shipments. |
| Tracking No | No | Displays the last Tracking Number that is assigned to the Invoice. This can be edited and be related to shipping functions outside of the Courier API. | |
| Tracking No buttons | No | These buttons can be used to add a new Tracking Number to the Invoice or view the list of existing Tracking Numbers for the Invoice. The tracking numbers do not need to have been created with GoSweetSpot. | |
| Delivery Status display field. | Yes | No | Displays the current shipping status for the last shipment created. |
| Update Delivery Status | Yes | No | Clicking this button will perform an API request to update the Delivery Status display field. |
| Auto checkbox | Yes | No | Having this checked will cause the Delivery Status display field to be updated when the Invoice is opened and there is a shipment created. |
| Courier API button | Yes | Yes | This button is required to be clicked on before a shipment for the Invoice can be created with GoSweetSpot. If there is a selection of parcels created, and the other requirements are met, a window with a list of available shipping rates, or services types, will be presented, of which one can be selected to create a shipment. |
| Details | No | For unrelated shipping functions. The Pickup and Delivery instructions may also be set in the form that opens after clicking the button, but it is unnecessary when these fields already exist in the current form. | |
| Save Shipping | Yes | Yes | Is required to save the Shipping Tab fields if the Invoice Save button is disabled as it is when the Invoice status is Posted. The Customer, Internal Contact and Reference fields are not saved. The Shipping Tab fields are also saved automatically when the Courier API button is clicked. |
| **Component** | **Description** |
|---|---|
| Search button | Clicking this will reload the grid from the server with the search results. |
| Add | Clicking this opens a dialog to add a new parcel |
| Edit | When one row is selected and is for a parcel without a shipment, the same dialog that is opened with the Add button is opened to edit information for the selected row. |
| Delete | When at least one row is selected and the rows do not include rows for created shipments, the rows will be deleted without confirmation. Multiple rows are selected by holding down the control key and clicking on the rows to add to the selection. |
| Include Tracked | To include parcels with a shipment in the grid this checkbox is checked. To only show the parcels for the next shipment, it is unchecked. |
| Name column | The name given to the parcel. If the name matches a pre-loaded stock size from GoSweetSpot, then this stock size is used by GoSweetSpot when creating a shipment. |
| Shipment column | This column is hidden by default. To unhide it, open the menu for the column and check the box for it in the "Columns" submenu. For a parcels that are new it will show "Not Created". If there is a shipment number for the parcel then it is shown. If there is not shipment number but there is tracking number then "Unavailable" is shown. To group the rows by this column, open the menu for the column and click "Group by this field". |
| Shipment Created | This column is hidden by default and needs to be enabled in the Columns submenu. If a shipment was created that includes the parcel this column shows the date and time it was created. |
| Dimensions (L x W x H) | Show the length, width and height of the parcel in centimeters |
| Wgt | The weight in kilograms |
| Qty | The number of identical parcels in the shipment |
| Close button | Closes the window. When the window is closed the Parcel Dimensions field in the Shipping tab of the Invoice form will be refreshed from the server. |
| **Field** | **Description** | **Example** |
|---|---|---|
| Address Line 1 | The building name (Optional) | Unit 2 |
| Address Line 2 | The street address | 46 Bracken Place |
| Address Line 3 | The suburb | Avonhead |
| Address Line 4 | The city | Christchurch |