Embed Size (px)
Citation preview
1
Revel API Updates
Release 2.34
Revel Systems
Abstract
A help guide for developers to integrate with Revel System API updates.
2
Table of Contents
Added Resources .............................................................................................................. 6 PurchaseOrderSearch ...............................................................................................................6
/specialresources/PurchaseOrderSearch/ ................................................................................ 6 Fields ................................................................................................................................................... 6
Resource Changes .......................................................................................................... 12 AppliedTaxOrder ...................................................................................................................... 12
/resources/AppliedTaxOrder/ ...................................................................................................... 12 Added Fields.................................................................................................................................... 12
AppliedTaxOrderItem .............................................................................................................. 12 /resources/AppliedTaxOrderItem/.............................................................................................. 12 Added Fields.................................................................................................................................... 12
Attribute .................................................................................................................................... 13 /resources/Attribute/...................................................................................................................... 13 Removed Fields .............................................................................................................................. 13 Removed Filtering Methods ........................................................................................................ 13
Brand ......................................................................................................................................... 13 /enterprise/Brand/ .......................................................................................................................... 13 Removed Fields .............................................................................................................................. 13 Removed Filtering Methods ........................................................................................................ 14 Removed Ordering Methods ....................................................................................................... 14
Cardswipe ................................................................................................................................. 14 /resources/Cardswipe/ .................................................................................................................. 14 Added Fields.................................................................................................................................... 14
ComboProductSet ................................................................................................................... 14 /resources/ComboProductSet/ ................................................................................................... 14 Added Fields.................................................................................................................................... 14
Company ................................................................................................................................... 15 /enterprise/Company/ .................................................................................................................... 15 Added Fields.................................................................................................................................... 15
CustomMenu ............................................................................................................................ 15 /resources/CustomMenu/ ............................................................................................................. 15 Added Fields.................................................................................................................................... 15
CustomerGroup ....................................................................................................................... 15 /resources/CustomerGroup/........................................................................................................ 15 Removed Fields .............................................................................................................................. 15
Device ........................................................................................................................................ 15 /resources/Device/ ......................................................................................................................... 15 Added Fields.................................................................................................................................... 15
DeviceView ............................................................................................................................... 16 /resources/DeviceView/ ................................................................................................................ 16 Added Fields.................................................................................................................................... 16
Discount .................................................................................................................................... 16 /resources/Discount/ ..................................................................................................................... 16 Added Fields.................................................................................................................................... 16 Field Changes ................................................................................................................................. 16
3
DiscountLevel .......................................................................................................................... 17 /resources/DiscountLevel/ ........................................................................................................... 17 Removed Fields .............................................................................................................................. 17 Removed Filtering Methods ........................................................................................................ 17
DocumentStorage .................................................................................................................... 17 /resources/DocumentStorage/ .................................................................................................... 17 Field Changes ................................................................................................................................. 17
Employee .................................................................................................................................. 17 /resources/Employee/ ................................................................................................................... 17 Removed Fields .............................................................................................................................. 18
Establishment .......................................................................................................................... 18 /enterprise/Establishment/ ........................................................................................................... 18 Removed Fields .............................................................................................................................. 18 Field Changes ................................................................................................................................. 18 Removed Filtering Methods ........................................................................................................ 18
EstablishmentTag .................................................................................................................... 19 /resources/EstablishmentTag/ .................................................................................................... 19 Added Fields.................................................................................................................................... 19
FuelPriceAcknowledgement ................................................................................................... 19 /resources/FuelPriceAcknowledgement/ ................................................................................. 19 Added Fields.................................................................................................................................... 19
HelpArticle ................................................................................................................................ 20 /resources/HelpArticle/ ................................................................................................................. 20 Added Filtering Methods .............................................................................................................. 20
Modifier ..................................................................................................................................... 20 /resources/Modifier/ ....................................................................................................................... 20 Removed Fields .............................................................................................................................. 20
ModifierClass ........................................................................................................................... 20 /resources/ModifierClass/ ............................................................................................................ 20 Removed Fields .............................................................................................................................. 20
OrderTaxBreakDown ............................................................................................................... 20 /resources/OrderTaxBreakDown/ .............................................................................................. 20 Added Fields.................................................................................................................................... 20
PosStation ................................................................................................................................ 21 /resources/PosStation/ ................................................................................................................. 21 Added Fields.................................................................................................................................... 21
PriceTier .................................................................................................................................... 21 /resources/PriceTier/ ..................................................................................................................... 21 Field Changes ................................................................................................................................. 21
Product ...................................................................................................................................... 21 /resources/Product/ ....................................................................................................................... 21 Removed Fields .............................................................................................................................. 21 Added Fields.................................................................................................................................... 21
ProductCategory ...................................................................................................................... 22 /products/ProductCategory/ ........................................................................................................ 22 Removed Fields .............................................................................................................................. 22
ProductClass ............................................................................................................................ 22 /products/ProductClass/ .............................................................................................................. 22
4
Removed Fields .............................................................................................................................. 22 Removed Filtering Methods ........................................................................................................ 22
ProductPriceLifeCycleAction ................................................................................................. 22 /resources/ProductPriceLifeCycleAction/ ............................................................................... 22 Added Fields.................................................................................................................................... 22
ProductPurchase ..................................................................................................................... 23 /resources/ProductPurchase/ ..................................................................................................... 23 Added Fields.................................................................................................................................... 23
ProductPurchaseOrderItem .................................................................................................... 23 /resources/ProductPurchaseOrderItem/ .................................................................................. 23 Field Changes ................................................................................................................................. 23
PurchaseLedger ....................................................................................................................... 23 /resources/PurchaseLedger/ ....................................................................................................... 23 Added Fields.................................................................................................................................... 23 Field Changes ................................................................................................................................. 24
PurchaseOrder ......................................................................................................................... 24 /resources/PurchaseOrder/ ......................................................................................................... 24 Added Fields.................................................................................................................................... 24 Field Changes ................................................................................................................................. 24
PurchaseOrderInvoice ............................................................................................................ 25 /resources/PurchaseOrderInvoice/ ........................................................................................... 25 Removed Fields .............................................................................................................................. 25
PurchaseOrderItem.................................................................................................................. 25 /resources/PurchaseOrderItem/ ................................................................................................. 25 Field Changes ................................................................................................................................. 25
Return ........................................................................................................................................ 25 /resources/Return/ ......................................................................................................................... 25 Added Filtering Methods .............................................................................................................. 25
SMSMessageOutcoming ......................................................................................................... 25 /resources/SMSMessageOutcoming/........................................................................................ 25 Removed Fields .............................................................................................................................. 25
Table .......................................................................................................................................... 26 /resources/Table/ ............................................................................................................................ 26 Added Fields.................................................................................................................................... 26
TableReservation ..................................................................................................................... 27 /resources/TableReservation/ ..................................................................................................... 27 Field Changes ................................................................................................................................. 27
Tax ............................................................................................................................................. 27 /resources/Tax/ ............................................................................................................................... 27 Added Fields.................................................................................................................................... 27 Field Changes ................................................................................................................................. 27
Till .............................................................................................................................................. 27 /resources/Till/ ................................................................................................................................ 27 Added Fields.................................................................................................................................... 27
User ........................................................................................................................................... 28 /enterprise/User/ ............................................................................................................................. 28 Field Changes ................................................................................................................................. 28
Vendor ....................................................................................................................................... 28
5
/resources/Vendor/ ........................................................................................................................ 28 Removed Fields .............................................................................................................................. 28 Added Fields.................................................................................................................................... 28 Removed Filtering Methods ........................................................................................................ 28
VendorOrderableItem .............................................................................................................. 29 /resources/VendorOrderableItem/ ............................................................................................. 29 Added Fields.................................................................................................................................... 29
ViewPurchaseOrder ................................................................................................................. 29 /resources/ViewPurchaseOrder/ ................................................................................................ 29 Added Fields.................................................................................................................................... 29 Field Changes ................................................................................................................................. 29
ViewPurchaseOrderProduct ................................................................................................... 30 /resources/ViewPurchaseOrderProduct/ ................................................................................. 30 Added Fields.................................................................................................................................... 30
ViewTax ..................................................................................................................................... 30 /resources/ViewTax/ ...................................................................................................................... 30 Added Fields.................................................................................................................................... 30
6
Added Resources
PurchaseOrderSearch
/specialresources/PurchaseOrderSearch/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
updated_date
datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
shipping_state
string
False False False True Unicode string data. Ex: "Hello World"
finalized boolean False False False False True Boolean data. Ex: True
tax decimal 0.00 False False False False Fixed precision numeric data. Ex: 26.73
invoiced_status
string No default provided.
False True False False One of [partially_invoiced, uninvoiced, fully_invoiced]
vendor_zip string
False False False True Unicode string data. Ex: "Hello World"
7
shipping_contact_name
string
False False False True Unicode string data. Ex: "Hello World"
receive_status
string No default provided.
False True False False One of [new, partially_received, fully_received, sent, finalized]
shipping_email
string
False False False True Unicode string data. Ex: "Hello World"
contact_name
string
False False False True Unicode string data. Ex: "Hello World"
total decimal 0.0000 False False False False Fixed precision numeric data. Ex: 26.73
vendor_address2
string
False False False True Unicode string data. Ex: "Hello World"
id integer
False False True True Integer data. Ex: 2673
contant_name_for_authorization
string
False False False True Unicode string data. Ex: "Hello World"
vendor_contact_name
string
False False False True Unicode string data. Ex: "Hello World"
8
vendor_state
string
False False False True Unicode string data. Ex: "Hello World"
comments string
False False False True Unicode string data. Ex: "Hello World"
vendor_fax string
False False False True Unicode string data. Ex: "Hello World"
is_sent boolean False False False False True Boolean data. Ex: True
vendor_vat_id
string
False False False True Unicode string data. Ex: "Hello World"
fob integer No default provided.
True False False False Integer data. Ex: 2673
vendor_email
string
False False False True Unicode string data. Ex: "Hello World"
establishment
Establishment (FK)
No default provided.
False False False False A single related resource. Can be either a URI or set of nested resource data.
shipping_terms
string
False False False True Unicode string data. Ex: "Hello World"
9
shipping_name
string No default provided.
False False False False Unicode string data. Ex: "Hello World"
finalized_by
User (FK) No default provided.
True False False False A single related resource. Can be either a URI or set of nested resource data.
vendor_id string No default provided.
True False False False Unicode string data. Ex: "Hello World"
sent_date datetime None True False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
shipping_city
string
False False False True Unicode string data. Ex: "Hello World"
vendor_phone_number
string
False False False True Unicode string data. Ex: "Hello World"
contact_fax
string
False False False True Unicode string data. Ex: "Hello World"
establishment_id
integer No default provided.
False True False False Integer data. Ex: 2673
10
contact_email
string
False False False True Unicode string data. Ex: "Hello World"
shipping_address1
string
False False False True Unicode string data. Ex: "Hello World"
shipping_address2
string
False False False True Unicode string data. Ex: "Hello World"
vendor_address1
string
False False False True Unicode string data. Ex: "Hello World"
overriden_created_date
datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
shipping_and_handling
decimal 0.00 False False False False Fixed precision numeric data. Ex: 26.73
vendor_name
string No default provided.
False False False False Unicode string data. Ex: "Hello World"
is_deleted boolean False False False False True Boolean data. Ex: True
shipping_zip
string
False False False True Unicode string data. Ex: "Hello World"
11
finalized_date
datetime None True False False False A date & time as a string. Ex: "2010-11-10T03:07:43"
contact_phone
string
False False False True Unicode string data. Ex: "Hello World"
vendor_city
string
False False False True Unicode string data. Ex: "Hello World"
created_date
datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
misc_amount
decimal 0.00 False False False False Fixed precision numeric data. Ex: 26.73
vendor_account_no
string
False False False True Unicode string data. Ex: "Hello World"
vendor_country
string USA False False False True Unicode string data. Ex: "Hello World"
shipping_phone_number
string
False False False True Unicode string data. Ex: "Hello World"
shipping_country
string USA False False False True Unicode string data. Ex: "Hello World"
12
orderitems PurchaseOrderItem (FK)
No default provided.
True False False False Many related resources. Can be either a list of URIs or list of individually nested resource data.
resource_uri
string No default provided.
False True False False Unicode string data. Ex: "Hello World"
Resource Changes
AppliedTaxOrder
/resources/AppliedTaxOrder/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
tax_type integer 0 False False False False Integer data. Ex: 2673
AppliedTaxOrderItem
/resources/AppliedTaxOrderItem/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
flat_tax_units
integer 1 False False False False Integer data. Ex: 2673
13
tax_type integer 0 False False False False Integer data. Ex: 2673
Attribute
/resources/Attribute/
Removed Fields
brand
Removed Filtering Methods
brand
Brand
/enterprise/Brand/
Removed Fields
updated_date
name
call_names
client_type
created_date
active
id
14
Removed Filtering Methods
id
Removed Ordering Methods
id
Cardswipe
/resources/Cardswipe/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
moneris_api_version_11xx
boolean No default provided.
True False False False Boolean data. Ex: True
ComboProductSet
/resources/ComboProductSet/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
barcode string No default provided.
True False False False Unicode string data. Ex: "Hello World"
15
Company
/enterprise/Company/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
call_names string ['TICKET 1', 'TICKET 2', 'TICKET 3', 'TICKET 4', 'TICKET 5', ……. 'Jacob', 'Ethan', 'Michael', 'Alexander', 'William', 'Joshua', 'Daniel', 'Jayden', 'Noah', ……... ]
False False False False Unicode string data. Ex: "Hello World"
CustomMenu
/resources/CustomMenu/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
price_tier PriceTier (FK)
No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
CustomerGroup
/resources/CustomerGroup/
Removed Fields
brand
Device
/resources/Device/
Added Fields
16
Name Type Default Null Read Only Unique Blank Help Text
os_version string No default provided.
True False False False Unicode string data. Ex: "Hello World"
DeviceView
/resources/DeviceView/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
os_version string No default provided.
True False False False Unicode string data. Ex: "Hello World"
Discount
/resources/Discount/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
receipt_text
string No default provided.
True False False False Unicode string data. Ex: "Hello World"
discount_tier
integer None True False False False Integer data. Ex: 2673
Field Changes
17
Name Attribute Old Value New Value
stackable_discount_type
default No default provided.
0
stackable_discount_type
nullable True False
DiscountLevel
/resources/DiscountLevel/
Removed Fields
brand
Removed Filtering Methods
brand
DocumentStorage
/resources/DocumentStorage/
Field Changes
Name Attribute Old Value New Value
data nullable False True
Employee
/resources/Employee/
18
Removed Fields
brand
password_history
Establishment
/enterprise/Establishment/
Removed Fields
on_boarding_required
brand
Field Changes
Name Attribute Old Value New Value
time_zone default UTC No default provided.
time_zone readonly False True
name unique False True
Removed Filtering Methods
brand
19
EstablishmentTag
/resources/EstablishmentTag/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
created_by User (FK) No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
FuelPriceAcknowledgement
/resources/FuelPriceAcknowledgement/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
price_tier PriceTier (FK)
No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
20
HelpArticle
/resources/HelpArticle/
Added Filtering Methods
title
Modifier
/resources/Modifier/
Removed Fields
brand
ModifierClass
/resources/ModifierClass/
Removed Fields
brand
OrderTaxBreakDown
/resources/OrderTaxBreakDown/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
tax_base_type integer 0 False False False False Integer data. Ex: 2673
flat_tax_units integer 1 False False False False Integer data. Ex: 2673
21
PosStation
/resources/PosStation/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
os_version string No default provided.
True False False False Unicode string data. Ex: "Hello World"
PriceTier
/resources/PriceTier/
Field Changes
Name Attribute Old Value New Value
sorting default No default provided. 0
Product
/resources/Product/
Removed Fields
brand
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
flat_tax_units integer 1 False False False False Integer data. Ex: 2673
22
show_on_pos boolean True False False False True Boolean data. Ex: True
negative_sales_restricted boolean False False False False True Boolean data. Ex: True
ProductCategory
/products/ProductCategory/
Removed Fields
brand
ProductClass
/products/ProductClass/
Removed Fields
brand
Removed Filtering Methods
brand
ProductPriceLifeCycleAction
/resources/ProductPriceLifeCycleAction/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
price_tier PriceTier (FK)
No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
23
ProductPurchase
/resources/ProductPurchase/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
flat_tax_units integer 1 False False False False Integer data. Ex: 2673
show_on_pos boolean True False False False True Boolean data. Ex: True
negative_sales_restricted boolean False False False False True Boolean data. Ex: True
ProductPurchaseOrderItem
/resources/ProductPurchaseOrderItem/
Field Changes
Name Attribute Old Value New Value
reorder_unit default
Unit
PurchaseLedger
/resources/PurchaseLedger/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
vendor_vat_id string
False False False True Unicode string data. Ex: "Hello World"
24
Field Changes
Name Attribute Old Value New Value
overriden_created_date default 2017-12-04 22:31:08.153758+00:00 True
overriden_created_date blank False True
PurchaseOrder
/resources/PurchaseOrder/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
vendor_vat_id string
False False False True Unicode string data. Ex: "Hello World"
finalized_by User (FK)
No default provided.
True False False False A single related resource. Can be either a URI or set of nested resource data.
Field Changes
Name Attribute Old Value New Value
overriden_created_date default 2017-12-04 22:31:08.154320+00:00 True
overriden_created_date blank False True
25
PurchaseOrderInvoice
/resources/PurchaseOrderInvoice/
Removed Fields
shipping_terms
PurchaseOrderItem
/resources/PurchaseOrderItem/
Field Changes
Name Attribute Old Value New Value
reorder_unit default
Unit
Return
/resources/Return/
Added Filtering Methods
establishment
return_date
SMSMessageOutcoming
/resources/SMSMessageOutcoming/
Removed Fields
object_id
26
Table
/resources/Table/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
updated_date
datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
created_by User (FK) No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
updated_by
User (FK) No default provided.
True False False True A single related resource. Can be either a URI or set of nested resource data.
created_date
datetime True False False False True A date & time as a string. Ex: "2010-11-10T03:07:43"
27
TableReservation
/resources/TableReservation/
Field Changes
Name Attribute Old Value New Value
order_uuid unique True False
Tax
/resources/Tax/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
tax_type integer 0 False False False False Integer data. Ex: 2673
Field Changes
Name Attribute Old Value New Value
active blank True False
Till
/resources/Till/
Added Fields
Name Type Default Null Read Only
Unique Blank Help Text
cash_refunds decimal No default provided.
True False False False Fixed precision numeric data. Ex: 26.73
28
User
/enterprise/User/
Field Changes
Name Attribute Old Value New Value
last_login default 2017-12-04 22:31:08.168934+00:00
No default provided.
last_login nullable False True
date_joined default 2017-12-04 22:31:08.168970+00:00
2017-12-04 22:17:50.143415+00:00
Vendor
/resources/Vendor/
Removed Fields
brand
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
vat_id string
False False False True Unicode string data. Ex: "Hello World"
Removed Filtering Methods
brand
29
VendorOrderableItem
/resources/VendorOrderableItem/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
gst_id string No default provided.
True False False False Unicode string data. Ex: "Hello World"
ViewPurchaseOrder
/resources/ViewPurchaseOrder/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
vendor_vat_id
string
False False False True Unicode string data. Ex: "Hello World"
Field Changes
Name Attribute Old Value New Value
overriden_created_date
default 2017-12-04 22:31:08.171717+00:00
True
overriden_created_date
blank False True
30
ViewPurchaseOrderProduct
/resources/ViewPurchaseOrderProduct/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
flat_tax_units
integer 1 False False False False Integer data. Ex: 2673
show_on_pos
boolean True False False False True Boolean data. Ex: True
negative_sales_restricted
boolean False False False False True Boolean data. Ex: True
ViewTax
/resources/ViewTax/
Added Fields
Name Type Default Null Read Only Unique Blank Help Text
tax_type integer 0 False False False False Integer data. Ex: 2673
