SOS Inventory (Independent Publisher) (Preview)
Retrieves and updates information in SOS Inventory
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Harold Anderson |
| URL | https://github.com/Harold-Anderson |
| harold@fastmail.com |
| Connector Metadata | |
|---|---|
| Publisher | Harold Anderson |
| Website | https://thaiwala.com |
| Privacy policy | https://thaiwala.com |
| Categories | Business Management |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get a Customer |
Gets a Customer by ID |
| Get a Sales Order |
Gets a Sales Order by ID |
| List Items |
List Items |
| List Pick tickets |
List Pick Tickets |
| List Sales Orders |
List Sales Orders |
| Locations |
List Locations |
| Lots |
List Lots |
| Update Pick ticket |
Updates a specific pick ticket by setting the values of the parameters passed. |
Get a Customer
Gets a Customer by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | number |
Customer ID in SOS Inventory. |
Returns
- Body
- customer
Get a Sales Order
Gets a Sales Order by ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | number |
Order ID in SOS Inventory. |
Returns
- Body
- salesorder
List Items
List Items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | string |
Inventory at given location |
|
|
Tags
|
tags | string |
Returns records that match the provided comma separated list of tags. |
|
|
Type
|
type | string |
Returns records that match the provided item type. |
|
|
Limit
|
limit | integer |
Limit number of items returned. Default 10 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer |
The number of results returned in this query. |
|
totalCount
|
totalCount | integer |
Total number of objects |
|
data
|
data | array of object |
Array of items |
|
id
|
data.id | integer |
Item ID |
|
starred
|
data.starred | integer | |
|
syncToken
|
data.syncToken | integer | |
|
name
|
data.name | string | |
|
fullname
|
data.fullname | string | |
|
description
|
data.description | string | |
|
sku
|
data.sku | string | |
|
barcode
|
data.barcode | string | |
|
type
|
data.type | string | |
|
url
|
data.url | string | |
|
tags
|
data.tags | string | |
|
notes
|
data.notes | string | |
|
purchaseDescription
|
data.purchaseDescription | string | |
|
vendorPartNumber
|
data.vendorPartNumber | string | |
|
customerPartNumber
|
data.customerPartNumber | string | |
|
id
|
data.vendor.id | integer |
Vendor ID |
|
name
|
data.vendor.name | string |
Vendor Name |
|
bin
|
data.bin | string | |
|
warranty
|
data.warranty | string | |
|
category
|
data.category | string | |
|
class
|
data.class | string | |
|
id
|
data.incomeAccount.id | integer | |
|
name
|
data.incomeAccount.name | string | |
|
id
|
data.cogsAccount.id | integer | |
|
name
|
data.cogsAccount.name | string | |
|
id
|
data.assetAccount.id | integer | |
|
name
|
data.assetAccount.name | string | |
|
id
|
data.expenseAccount.id | integer | |
|
name
|
data.expenseAccount.name | string | |
|
onhand
|
data.onhand | number | |
|
available
|
data.available | number | |
|
onSO
|
data.onSO | number | |
|
onSR
|
data.onSR | number | |
|
rented
|
data.rented | number | |
|
onWO
|
data.onWO | number | |
|
onPO
|
data.onPO | number | |
|
onRMA
|
data.onRMA | number | |
|
reorderPoint
|
data.reorderPoint | number | |
|
maxStock
|
data.maxStock | number | |
|
leadTime
|
data.leadTime | number | |
|
salesPrice
|
data.salesPrice | number | |
|
baseSalesPrice
|
data.baseSalesPrice | number | |
|
markupPercent
|
data.markupPercent | number | |
|
useMarkup
|
data.useMarkup | boolean | |
|
minimumPrice
|
data.minimumPrice | number | |
|
basePurchaseCost
|
data.basePurchaseCost | number | |
|
purchaseCost
|
data.purchaseCost | number | |
|
costBasis
|
data.costBasis | number | |
|
weight
|
data.weight | number | |
|
volume
|
data.volume | number | |
|
weightUnit
|
data.weightUnit | string | |
|
volumeUnit
|
data.volumeUnit | string | |
|
sublevel
|
data.sublevel | integer | |
|
taxable
|
data.taxable | boolean | |
|
salesTaxCode
|
data.salesTaxCode | string | |
|
purchaseTaxCode
|
data.purchaseTaxCode | string | |
|
willSync
|
data.willSync | boolean | |
|
updateShopify
|
data.updateShopify | boolean | |
|
updateBigCommerce
|
data.updateBigCommerce | boolean | |
|
alwaysShippable
|
data.alwaysShippable | boolean | |
|
hasImage
|
data.hasImage | boolean | |
|
serialTracking
|
data.serialTracking | boolean | |
|
lotTracking
|
data.lotTracking | boolean | |
|
archived
|
data.archived | boolean | |
|
showOnSalesForms
|
data.showOnSalesForms | boolean | |
|
showOnPurchasingForms
|
data.showOnPurchasingForms | boolean | |
|
showOnManufacturingForms
|
data.showOnManufacturingForms | boolean | |
|
customFields
|
data.customFields | string | |
|
uoms
|
data.uoms | array of | |
|
priceTiers
|
data.priceTiers | array of | |
|
summaryOnly
|
data.summaryOnly | boolean | |
|
imageAsBase64String
|
data.imageAsBase64String | string | |
|
imageChanged
|
data.imageChanged | boolean | |
|
commissionRate
|
data.commissionRate | number | |
|
commissionAmount
|
data.commissionAmount | number | |
|
commissionExempt
|
data.commissionExempt | boolean | |
|
syncMessage
|
data.syncMessage | string | |
|
lastSync
|
data.lastSync | string | |
|
keys
|
data.keys | string | |
|
values
|
data.values | string | |
|
__IMTLENGTH__
|
data.__IMTLENGTH__ | integer | |
|
__IMTINDEX__
|
data.__IMTINDEX__ | integer |
List Pick tickets
List Pick Tickets
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
start
|
start | number |
A cursor used in pagination |
|
|
Limit
|
maxresults | number |
Maximum number of results to return |
|
|
Summary
|
summary | string |
If present, returns only summary values. |
|
|
query
|
query | string |
Filter results by matching query. |
|
|
archived
|
archived | boolean |
Filters by archived or not. |
|
|
From Date
|
from | date |
Starting transaction date. |
|
|
To Date
|
to | date |
Ending transaction date. |
|
|
Location
|
location | string |
Filters according to location. |
|
|
Location
|
status | string |
Filters according to open/closed. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer |
The number of Pick Tickets Returned |
|
totalCount
|
totalCount | integer |
The number of Matching Pick Tickets |
|
data
|
data | array of pickticket |
List Sales Orders
List Sales Orders
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
start
|
start | number |
A cursor used in pagination |
|
|
Max Results
|
maxresults | number |
Max Results to return. Default 200. |
|
|
Type
|
status | string |
Filters by whether transaction is open or closed. |
|
|
query
|
query | string |
Filter results by matching query. |
|
|
archived
|
archived | boolean |
Filters by archived or not. |
|
|
From Date
|
from | date |
Starting transaction date. |
|
|
To Date
|
to | date |
Ending transaction date. |
|
|
Location
|
location | string |
Filters according to location. |
|
|
id
|
id | number |
Returns specific order given id. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer |
The number of Sales Orders Returned |
|
totalCount
|
totalCount | integer |
The number of Matching Sales Orders |
|
data
|
data | array of salesorder |
Locations
List Locations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Limit number of locations returned. Default 10 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer |
The number of Locations Returned |
|
totalCount
|
totalCount | integer |
The number of Matching Locations |
|
data
|
data | array of object | |
|
id
|
data.id | integer |
Location ID |
|
syncToken
|
data.syncToken | integer |
sync token |
|
name
|
data.name | string |
Location Name |
|
binTracking
|
data.binTracking | boolean |
Bin Tracking |
|
bins
|
data.bins | array of object | |
|
id
|
data.bins.id | integer |
ID |
|
syncToken
|
data.bins.syncToken | integer |
sync token |
|
number
|
data.bins.number | string |
Bin Number |
|
location
|
data.bins.location | string |
Location |
|
sortOrder
|
data.bins.sortOrder | integer |
Sort order |
|
line1
|
data.address.line1 | string |
First Line of Address |
|
line2
|
data.address.line2 | string |
Second Line of Address |
|
line3
|
data.address.line3 | string |
Third Line of Address |
|
line4
|
data.address.line4 | string |
Fourth Line of Address |
|
line5
|
data.address.line5 | string |
Fifth Line of Address |
|
city
|
data.address.city | string |
City |
|
stateProvince
|
data.address.stateProvince | string | |
|
postalCode
|
data.address.postalCode | string |
Postal Code |
|
country
|
data.address.country | string |
Country |
|
phone
|
data.address.phone | string |
Phone |
|
email
|
data.address.email | string |
|
|
company
|
data.address.company | string |
Company |
|
contact
|
data.address.contact | string |
Contact |
Lots
List Lots
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | string |
Inventory at given location |
|
|
Archived
|
archived | string |
Archived |
|
|
Status
|
status | string |
Expired, Recalled, Neither |
|
|
Limit
|
limit | integer |
Max records to return, default 10 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer |
The number of Lots Returned |
|
totalCount
|
totalCount | integer |
The number of Matching Lots |
|
data
|
data | array of object | |
|
id
|
data.id | integer |
Lot ID |
|
starred
|
data.starred | integer |
Starred |
|
syncToken
|
data.syncToken | integer |
sync token |
|
number
|
data.number | string |
Lot Number |
|
id
|
data.item.id | integer |
Associated Item ID |
|
name
|
data.item.name | string |
Associated Item Name |
|
description
|
data.description | string |
Lot Description |
|
expiration
|
data.expiration | date |
Expiration Date |
|
recalled
|
data.recalled | boolean |
recalled |
|
expired
|
data.expired | boolean |
expired |
|
customFields
|
data.customFields | array of object |
Custom Fields |
|
id
|
data.customFields.id | integer |
ID |
|
name
|
data.customFields.name | string |
Name |
|
value
|
data.customFields.value | string |
Value |
|
dataType
|
data.customFields.dataType | string |
Data Type |
|
onhand
|
data.onhand | number |
On Hand |
|
available
|
data.available | number |
Available |
|
summaryOnly
|
data.summaryOnly | boolean |
Summary Only |
Update Pick ticket
Updates a specific pick ticket by setting the values of the parameters passed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | integer |
Pick Ticket ID to update |
|
id
|
id | integer |
Pick Ticket ID |
|
|
starred
|
starred | integer | ||
|
closed
|
closed | boolean | ||
|
syncToken
|
syncToken | integer | ||
|
number
|
number | string |
Pick Ticket Number |
|
|
date
|
date | string |
Date Pick Ticket Created/Edited |
|
|
id
|
id | integer |
Customer ID |
|
|
name
|
name | string |
Customer Name |
|
|
id
|
id | integer |
Location ID |
|
|
name
|
name | string |
Location Name |
|
|
id
|
id | integer |
Channel ID |
|
|
name
|
name | string |
Channel Name |
|
|
id
|
id | integer |
Priority ID |
|
|
name
|
name | string |
Priority Name |
|
|
id
|
id | integer |
Assigned to User ID |
|
|
name
|
name | string |
Assigned to User Name |
|
|
id
|
id | integer |
Shipping Method ID |
|
|
name
|
name | string |
Shipping Method Name |
|
|
trackingNumber
|
trackingNumber | string | ||
|
id
|
id | integer |
Linked Transaction id |
|
|
transactionType
|
transactionType | string |
Linked Transaction type |
|
|
refNumber
|
refNumber | string |
Linked Transaction Ref Number |
|
|
linenumber
|
linenumber | integer |
Linked Transaction Line Number |
|
|
comment
|
comment | string |
Pick Ticket Comment |
|
|
customerNotes
|
customerNotes | string | ||
|
id
|
id | integer |
Custom Field ID |
|
|
name
|
name | string |
Custom Field Name |
|
|
value
|
value | string |
Custom Field Value |
|
|
dataType
|
dataType | string |
Custom Field Data Type |
|
|
pickBy
|
pickBy | date |
Pick-by Date |
|
|
total
|
total | integer | ||
|
archived
|
archived | boolean | ||
|
summaryOnly
|
summaryOnly | boolean | ||
|
hasSignature
|
hasSignature | boolean | ||
|
id
|
id | integer |
Pick Ticket Line ID |
|
|
lineNumber
|
lineNumber | integer |
Pick Ticket Line Number |
|
|
id
|
id | number |
Line Item ID |
|
|
name
|
name | string |
Pick Ticket Line Item Name |
|
|
class
|
class | string | ||
|
id
|
id | number |
Pick Ticket Job ID |
|
|
name
|
name | string |
Pick ticket Job Name |
|
|
id
|
id | integer |
Pick Ticket workcenter ID |
|
|
name
|
name | string |
Pick ticket Workcenter Name |
|
|
taxable
|
taxable | boolean | ||
|
id
|
id | integer |
Pick Ticket TaxCode ID |
|
|
name
|
name | string |
Pick ticket Taxcode Name |
|
|
description
|
description | string |
Line Item Description |
|
|
quantity
|
quantity | number |
Line Item Quantity |
|
|
weight
|
weight | number |
Line Item weight |
|
|
volume
|
volume | number |
Line Item Volume |
|
|
weightunit
|
weightunit | string | ||
|
volumeunit
|
volumeunit | string | ||
|
id
|
id | integer |
UOM ID |
|
|
name
|
name | string |
UOM Name |
|
|
id
|
id | integer |
Lot ID |
|
|
name
|
name | string |
Lot Name |
Returns
- Body
- pickticket
Definitions
salesorder
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | number |
Sales Order ID |
|
starred
|
starred | number | |
|
syncToken
|
syncToken | number |
Sales Order sync token |
|
number
|
number | string |
Sales Order Number |
|
date
|
date | date-time |
Sales Order Date |
|
id
|
customer.id | number |
Sales Order Customer ID |
|
name
|
customer.name | string |
Sales Order Customer Name |
|
id
|
location.id | number |
Sales Order Location ID |
|
name
|
location.name | string |
Sales Order Location Name |
|
billing
|
billing | address | |
|
shipping
|
shipping | address | |
|
id
|
terms.id | number |
Sales Order Terms ID |
|
name
|
terms.name | string |
Sales Order Terms Name |
|
id
|
salesRep.id | number |
Sales Order Sales Rep ID |
|
name
|
salesRep.name | string |
Sales Order Sales Rep Name |
|
channel
|
channel | string |
Sales Order Channel |
|
id
|
department.id | number |
Sales Order Department ID |
|
name
|
department.name | string |
Sales Order Department Name |
|
priority
|
priority | string | |
|
assignedToUser
|
assignedToUser | string | |
|
orderStage
|
orderStage | string | |
|
taxCode
|
taxCode | string | |
|
currency
|
currency | string | |
|
serial
|
serial | string | |
|
linkedTransaction
|
linkedTransaction | string | |
|
linkedInvoices
|
linkedInvoices | array of | |
|
linkedShipments
|
linkedShipments | array of | |
|
transactionLocationQuickBooks
|
transactionLocationQuickBooks | string | |
|
exchangeRate
|
exchangeRate | number | |
|
customerMessage
|
customerMessage | string | |
|
statusMessage
|
statusMessage | string | |
|
comment
|
comment | string | |
|
customerNotes
|
customerNotes | string | |
|
customFields
|
customFields | string | |
|
customerPO
|
customerPO | string | |
|
depositPercent
|
depositPercent | number | |
|
depositAmount
|
depositAmount | number | |
|
subTotal
|
subTotal | number | |
|
discountPercent
|
discountPercent | number | |
|
discountAmount
|
discountAmount | number | |
|
taxPercent
|
taxPercent | number | |
|
taxAmount
|
taxAmount | number | |
|
shippingAmount
|
shippingAmount | number | |
|
total
|
total | number | |
|
discountTaxable
|
discountTaxable | boolean | |
|
shippingTaxable
|
shippingTaxable | boolean | |
|
dropShip
|
dropShip | boolean | |
|
closed
|
closed | boolean | |
|
archived
|
archived | boolean | |
|
summaryOnly
|
summaryOnly | boolean | |
|
hasSignature
|
hasSignature | boolean | |
|
earliestDueDate
|
earliestDueDate | date-time | |
|
statusLink
|
statusLink | string | |
|
keys
|
keys | string | |
|
values
|
values | string | |
|
lines
|
lines | array of object |
Sales Order Lines |
|
id
|
lines.id | number |
Sales Order Line ID |
|
lineNumber
|
lines.lineNumber | number |
Sales Order Line Number |
|
id
|
lines.item.id | number |
Sales Order Line Item ID |
|
name
|
lines.item.name | string |
Sales Order Line Item Name |
|
class
|
lines.class | string | |
|
job
|
lines.job | string | |
|
workcenter
|
lines.workcenter | string | |
|
taxable
|
lines.tax.taxable | boolean | |
|
taxCode
|
lines.tax.taxCode | string | |
|
linkedTransaction
|
lines.linkedTransaction | string | |
|
description
|
lines.description | string |
Sales Order Line Item Description |
|
quantity
|
lines.quantity | number |
Sales Order Line Item Quantity |
|
weight
|
lines.weight | number |
Sales Order Line Item Weight |
|
volume
|
lines.volume | number |
Sales Order Line Item Volume |
|
weightunit
|
lines.weightunit | string |
Sales Order Line Item Weight Unit |
|
volumeunit
|
lines.volumeunit | string |
Sales Order Line Item Volume Unit |
|
unitprice
|
lines.unitprice | number |
Sales Order Line Item Unit Price |
|
amount
|
lines.amount | number |
Sales Order Line Item Amount |
|
altAmount
|
lines.altAmount | number | |
|
picked
|
lines.picked | number |
Sales Order Line Item Quantity Picked |
|
shipped
|
lines.shipped | number |
Sales Order Line Item Quantity Shipped |
|
invoiced
|
lines.invoiced | number |
Sales Order Line Item Quantity Invoiced |
|
produced
|
lines.produced | number |
Sales Order Line Item Quantity Produced |
|
returned
|
lines.returned | number |
Sales Order Line Item Quantity Returned |
|
cost
|
lines.cost | number |
Sales Order Line Item Cost |
|
margin
|
lines.margin | number |
Sales Order Line Item Margin |
|
listPrice
|
lines.listPrice | number |
Sales Order Line Item List Price |
|
percentdiscount
|
lines.percentdiscount | number |
Sales Order Line Item Percent Discount |
|
duedate
|
lines.duedate | date-time |
Sales Order Line Item Due Date |
|
uom
|
lines.uom | number | |
|
bin
|
lines.bin | string | |
|
lot
|
lines.lot | string |
Sales Order Line Item Lot |
|
serials
|
lines.serials | string |
pickticket
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Pick Ticket ID |
|
starred
|
starred | integer | |
|
closed
|
closed | boolean | |
|
syncToken
|
syncToken | integer | |
|
number
|
number | string |
Pick Ticket Number |
|
date
|
date | string |
Date Pick Ticket Created/Edited |
|
id
|
customer.id | integer |
Customer ID |
|
name
|
customer.name | string |
Customer Name |
|
id
|
location.id | integer |
Location ID |
|
name
|
location.name | string |
Location Name |
|
id
|
channel.id | integer |
Channel ID |
|
name
|
channel.name | string |
Channel Name |
|
id
|
priority.id | integer |
Priority ID |
|
name
|
priority.name | string |
Priority Name |
|
id
|
assignedToUser.id | integer |
Assigned to User ID |
|
name
|
assignedToUser.name | string |
Assigned to User Name |
|
id
|
shippingMethod.id | integer |
Shipping Method ID |
|
name
|
shippingMethod.name | string |
Shipping Method Name |
|
trackingNumber
|
trackingNumber | string | |
|
linkedTransaction
|
linkedTransaction | linkedtransaction | |
|
comment
|
comment | string |
Pick Ticket Comment |
|
customerNotes
|
customerNotes | string | |
|
customFields
|
customFields | array of object | |
|
id
|
customFields.id | integer |
Custom Field ID |
|
name
|
customFields.name | string |
Custom Field Name |
|
value
|
customFields.value | string |
Custom Field Value |
|
dataType
|
customFields.dataType | string |
Custom Field Data Type |
|
pickBy
|
pickBy | date |
Pick-by Date |
|
total
|
total | integer | |
|
archived
|
archived | boolean | |
|
summaryOnly
|
summaryOnly | boolean | |
|
hasSignature
|
hasSignature | boolean | |
|
lines
|
lines | array of object | |
|
id
|
lines.id | integer |
Pick Ticket Line ID |
|
lineNumber
|
lines.lineNumber | integer |
Pick Ticket Line Number |
|
id
|
lines.item.id | number |
Line Item ID |
|
name
|
lines.item.name | string |
Pick Ticket Line Item Name |
|
class
|
lines.class | string | |
|
id
|
lines.job.id | number |
Pick Ticket Job ID |
|
name
|
lines.job.name | string |
Pick ticket Job Name |
|
id
|
lines.workcenter.id | integer |
Pick Ticket workcenter ID |
|
name
|
lines.workcenter.name | string |
Pick ticket Workcenter Name |
|
taxable
|
lines.tax.taxable | boolean | |
|
id
|
lines.tax.taxCode.id | integer |
Pick Ticket TaxCode ID |
|
name
|
lines.tax.taxCode.name | string |
Pick ticket Taxcode Name |
|
description
|
lines.description | string |
Line Item Description |
|
quantity
|
lines.quantity | number |
Line Item Quantity |
|
weight
|
lines.weight | number |
Line Item weight |
|
volume
|
lines.volume | number |
Line Item Volume |
|
weightunit
|
lines.weightunit | string | |
|
volumeunit
|
lines.volumeunit | string | |
|
id
|
lines.uom.id | integer |
UOM ID |
|
name
|
lines.uom.name | string |
UOM Name |
|
id
|
lines.lot.id | integer |
Lot ID |
|
name
|
lines.lot.name | string |
Lot Name |
customer
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | number |
customer ID |
|
starred
|
starred | integer | |
|
syncToken
|
syncToken | integer |
Customer sync token |
|
name
|
name | string |
Customer Name |
|
fullname
|
fullname | string |
Customer's full name |
|
id
|
parent.id | integer |
Customer Parent ID |
|
name
|
parent.name | string |
Customer Parent Name |
|
sublevel
|
sublevel | integer | |
|
email
|
string |
Customer email |
|
|
website
|
website | string |
Customer website |
|
phone
|
phone | string |
Customer Company Phone |
|
mobile
|
mobile | string |
Customer Mobile Phone |
|
altPhone
|
altPhone | string | |
|
fax
|
fax | string | |
|
companyName
|
companyName | string |
Customer Company Name |
|
title
|
contact.title | string |
Customer Contact title |
|
firstName
|
contact.firstName | string |
Customer Contact First Name |
|
lastName
|
contact.lastName | string |
Customer Contact First Name |
|
suffix
|
contact.suffix | string |
Customer Contact Suffix |
|
billing
|
billing | address | |
|
shipping
|
shipping | address | |
|
id
|
terms.id | integer |
Customer terms id |
|
name
|
terms.name | string |
Customer terms name |
|
id
|
priceTier.id | integer | |
|
name
|
priceTier.name | string | |
|
id
|
paymentMethod.id | integer |
Payment Method ID |
|
name
|
paymentMethod.name | string |
Payment Method Name |
|
id
|
salesRep.id | integer |
Sales Rep ID |
|
name
|
salesRep.name | string |
Sales Rep Name |
|
id
|
customerType.id | integer |
Customer Type ID |
|
name
|
customerType.name | string |
Customer type name |
|
resaleNumber
|
resaleNumber | string |
Resale Number |
|
contractorNumber
|
contractorNumber | string |
Contractor Number |
|
businessLicense
|
businessLicense | string |
Business License |
|
foundUsVia
|
foundUsVia | string | |
|
id
|
currency.id | integer |
Currency ID |
|
name
|
currency.name | string |
Currency Name |
|
taxable
|
tax.taxable | boolean | |
|
id
|
tax.taxCode.id | integer |
Tax Code ID |
|
name
|
tax.taxCode.name | string |
Tax Code Name |
|
creditHold
|
creditHold | boolean | |
|
billWithParent
|
billWithParent | boolean | |
|
lastSync
|
lastSync | string | |
|
syncMessage
|
syncMessage | string | |
|
notes
|
notes | string |
Customer notes |
|
customFields
|
customFields | array of object | |
|
id
|
customFields.id | integer |
Customer Custom Field ID |
|
name
|
customFields.name | string |
Customer Custom Field Name |
|
value
|
customFields.value | string |
Customer Custom Field Value |
|
dataType
|
customFields.dataType | string |
Customer Custom Field Data Type |
|
altAddresses
|
altAddresses | array of | |
|
archived
|
archived | boolean |
Customer Archived |
|
hasChildren
|
hasChildren | boolean |
Customer Has Children |
|
summaryOnly
|
summaryOnly | boolean |
Customer summary only |
linkedtransaction
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Linked Transaction id |
|
transactionType
|
transactionType | string |
Linked Transaction type |
|
refNumber
|
refNumber | string |
Linked Transaction Ref Number |
|
linenumber
|
linenumber | integer |
Linked Transaction Line Number |
address
| Name | Path | Type | Description |
|---|---|---|---|
|
company
|
company | string | |
|
contact
|
contact | string | |
|
phone
|
phone | string | |
|
email
|
string | ||
|
addressName
|
addressName | string | |
|
addressType
|
addressType | string | |
|
line1
|
address.line1 | string | |
|
line2
|
address.line2 | string | |
|
line3
|
address.line3 | string | |
|
line4
|
address.line4 | string | |
|
line5
|
address.line5 | string | |
|
city
|
address.city | string | |
|
stateProvince
|
address.stateProvince | string | |
|
postalCode
|
address.postalCode | string | |
|
country
|
address.country | string |