Rackbeat - SendOrderToBackoffice
This document describes the process of sending an order from App4Sales to the Rackbeat ERP system. The process involves converting the App4Sales order object into the Rackbeat format and sending it to the Rackbeat API.
Data Source Configuration
The connector sends a POST request to the /orders endpoint of the Rackbeat API. The base URL for the API is configured in the administration settings. The request is authenticated using a bearer token, which is also configured in the connector settings.
Data Mapping Table
App4Sales Field | Source Field (API/Excel/DB) | Logic/Notes |
Order Header | Order Header | Order Header |
CustomerId | order.Customer.CustomerCode | The customer's code in App4Sales is used as the customer ID in Rackbeat. |
LayoutId | order.Customer.DynamicFreeFields (Layout) | The layout ID is extracted from the customer's dynamic free fields, where the field name is 'Layout'. |
PaymentTermsId | order.Customer.DynamicFreeFields (PaymentTerms) | The payment terms ID is extracted from the customer's dynamic free fields, where the field name is 'PaymentTerms'. |
VatZone | order.Customer.DynamicFreeFields (VatZone) | The VAT zone is extracted from the customer's dynamic free fields, where the field name is 'VatZone'. |
Currency | order.Customer.Currency | The currency from the customer's record in App4Sales is used. |
OrderDate | order.OrderDate | The order date from App4Sales is used. It is formatted as "yyyy-MM-dd". |
Note | order.Notes | The notes from the order in App4Sales are mapped to the note field in Rackbeat. |
DeliveryAddress | order.AlternateAddress, order.Customer.Addresses | The delivery address is determined by the following fallback logic:
|
BillingAddress | order.Customer.Addresses | The billing address is determined by the following fallback logic:
|
YourReference | order.YourReference | The 'Your Reference' field from the order in App4Sales is used. |
Order Lines | Order Lines | Order Lines |
ItemId | orderLine.ItemCode | The item code from the order line in App4Sales is used. |
Name | orderLine.Item.Description | The item's description is used as the name on the order line. |
Quantity | orderLine.Quantity | The quantity from the order line is used. |
LinePrice | orderLine.Price | The price from the order line is used. |
VatPercentage | orderLine.VatPercentage | The VAT percentage from the order line is used if the customer is VAT liable. Otherwise, it is set to 0. |
Address | Address | Address |
Street | address.AddressLine1 | The first address line is used for the street. |
Street2 | address.AddressLine2 | The second address line is used for the second street line. |
City | address.City | The city from the address is used. |
Zipcode | address.PostCode | The postal code from the address is used. |
Country | address.Country | The country from the address is used. |
State | address.State | The state from the address is used. |
Responses & Error Handling
The Rackbeat API returns a response containing the order number upon successful creation of the order. This order number is then returned by the connector. If the API call fails, the connector will throw an exception, and the error will be logged.