Epicor
App · 20 actions
Manage customers, parts and sales orders in Epicor Kinetic, run BAQs and Epicor Functions.
Actions
| Action | What it does |
|---|---|
| Add sales order line | Add a part to a sales order. |
| Create customer | Add a customer. |
| Create part | Add a part. |
| Create sales order | Start an open sales order for a customer, billed and shipped to that customer. |
| Delete customer | Delete a customer. |
| Delete part | Delete a part. |
| Delete sales order | Delete a sales order. |
| Delete sales order line | Delete a line from a sales order. |
| Get customer | Get a customer's details. |
| Get part | Get a part's details. |
| Get sales order | Get a sales order, with its lines. |
| List customers | List customers, optionally those whose name contains some text. |
| List parts | List parts, optionally those whose description contains some text. |
| List sales order lines | List the lines of a sales order. |
| List sales orders | List sales orders, newest first, optionally for one customer or only open ones. |
| Run BAQ | Run a business activity query (BAQ) and get its rows. |
| Run Epicor Function | Run a published Epicor Function and get its output parameters. |
| Update customer | Change a customer's details. |
| Update part | Change a part's details. |
| Update sales order line | Change a sales order line. |
Add sales order line
Add a part to a sales order.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
- Part
part_numbertextRequired - The part to order (PartNum).
- Description
line_descriptiontext - Line description.
- Quantity
quantitynumber - Quantity ordered, in the sales unit.At least 0.
- Unit price
unit_pricenumber - Unit price in the order's currency.At least 0.
- Reference
referencetext - Your reference for the line.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
}Create customer
Add a customer. Epicor gives it the next customer number.
Inputs
- Customer ID
customer_idtextRequired - The customer ID people see in Epicor (CustID), such as ACME.
- Name
nametextRequired - The customer's name.
- Address line 1
address_line_1text - First address line.
- Address line 2
address_line_2text - Second address line.
- Address line 3
address_line_3text - Third address line.
- City
citytext - City.
- State
statetext - State or province.
- ZIP code
ziptext - ZIP or postal code.
- Country
countrytext - Country, as Epicor names it.
- Territory
territorytext - Sales territory ID, such as US MID.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Address1": "example",
"City": "example",
"Company": "example",
"Country": "example",
"CustID": "example",
"CustNum": 1,
"Name": "example",
"State": "example",
"Zip": "example"
}
}Create part
Add a part. Units left empty take the company's defaults.
Inputs
- Part
part_numbertextRequired - The new part number (PartNum).
- Description
descriptiontextRequired - The part's description.
- Part type
part_typetext - Whether the part is purchased, manufactured or a sales kit.One of:
purchased,manufactured,sales_kit(Sales kit). Default:purchased. - Inventory unit
inventory_uomtext - Inventory unit of measure (IUM), such as EA.
- Purchasing unit
purchasing_uomtext - Purchasing unit of measure (PUM), such as EA.
- Sales unit
sales_uomtext - Sales unit of measure, such as EA.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"IUM": "example",
"PartDescription": "example",
"PartNum": "example",
"TypeCode": "example"
}
}Create sales order
Start an open sales order for a customer, billed and shipped to that customer. Add lines with Add sales order line.
Inputs
- Customer
customer_numbernumberRequired - The customer. Their number (CustNum) also works.
- Terms
terms_codetext - Payment terms code, such as 1/10. Leave empty for the customer's terms.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"CustNum": 1,
"OpenOrder": true,
"OrderDtls": [
{
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
],
"OrderNum": 1,
"TermsCode": "example"
}
}Delete customer
Delete a customer.
Inputs
- Customer
customer_numbernumberRequired - The customer. Their number (CustNum) also works.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"CustNum": 1,
"deleted": true
}
}Delete part
Delete a part.
Inputs
- Part
part_numbertextRequired - The part number (PartNum).
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"PartNum": "example",
"deleted": true
}
}Delete sales order
Delete a sales order.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"OrderNum": 1,
"deleted": true
}
}Delete sales order line
Delete a line from a sales order.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
- Line number
line_numbernumberRequired - The line's number on the order (OrderLine).
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"OrderLine": 1,
"OrderNum": 1,
"deleted": true
}
}Get customer
Get a customer's details.
Inputs
- Customer
customer_numbernumberRequired - The customer. Their number (CustNum) also works.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Address1": "example",
"City": "example",
"Company": "example",
"Country": "example",
"CustID": "example",
"CustNum": 1,
"Name": "example",
"State": "example",
"Zip": "example"
}
}Get part
Get a part's details.
Inputs
- Part
part_numbertextRequired - The part number (PartNum).
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"IUM": "example",
"PartDescription": "example",
"PartNum": "example",
"TypeCode": "example"
}
}Get sales order
Get a sales order, with its lines.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
- Include lines
include_linestrue/false - Include the order's lines. On by default.Default:
true.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"CustNum": 1,
"OpenOrder": true,
"OrderDtls": [
{
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
],
"OrderNum": 1,
"TermsCode": "example"
}
}List customers
List customers, optionally those whose name contains some text.
Inputs
- Name contains
name_containstext - Only customers whose name contains this text.
- Filter
filtertext - Advanced: an OData filter such as City eq 'Minneapolis'.
- Fields
fieldslist - Epicor field names to return, such as CustID and Name. Leave empty for all of them.
- Sort
order_bytext - Advanced: an OData sort such as Name desc.
- Max records
topnumber - Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - Records to skip, to read the next page. Leave empty for the first page.At least 0.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"count": 1,
"records": [
{
"Address1": "example",
"City": "example",
"Company": "example",
"Country": "example",
"CustID": "example",
"CustNum": 1,
"Name": "example",
"State": "example",
"Zip": "example"
}
]
}
}List parts
List parts, optionally those whose description contains some text.
Inputs
- Description contains
description_containstext - Only parts whose description contains this text.
- Filter
filtertext - Advanced: an OData filter such as City eq 'Minneapolis'.
- Fields
fieldslist - Epicor field names to return, such as CustID and Name. Leave empty for all of them.
- Sort
order_bytext - Advanced: an OData sort such as Name desc.
- Max records
topnumber - Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - Records to skip, to read the next page. Leave empty for the first page.At least 0.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"count": 1,
"records": [
{
"Company": "example",
"IUM": "example",
"PartDescription": "example",
"PartNum": "example",
"TypeCode": "example"
}
]
}
}List sales order lines
List the lines of a sales order.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"count": 1,
"records": [
{
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
]
}
}List sales orders
List sales orders, newest first, optionally for one customer or only open ones.
Inputs
- Customer
customer_numbernumber - Only this customer's orders.
- Open orders only
open_onlytrue/false - Only orders that are still open.
- Filter
filtertext - Advanced: an OData filter such as City eq 'Minneapolis'.
- Fields
fieldslist - Epicor field names to return, such as CustID and Name. Leave empty for all of them.
- Sort
order_bytext - Advanced: an OData sort such as Name desc.
- Max records
topnumber - Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - Records to skip, to read the next page. Leave empty for the first page.At least 0.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"count": 1,
"records": [
{
"Company": "example",
"CustNum": 1,
"OpenOrder": true,
"OrderDtls": [
{
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
],
"OrderNum": 1,
"TermsCode": "example"
}
]
}
}Run BAQ
Run a business activity query (BAQ) and get its rows. The BAQ must be in your API key's access scope.
Inputs
- BAQ ID
baq_idtextRequired - The BAQ's ID, such as zCustomer01.
- Filter
filtertext - Advanced: an OData filter such as City eq 'Minneapolis'.
- Max records
topnumber - Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
- Skip
skipnumber - Records to skip, to read the next page. Leave empty for the first page.At least 0.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"count": 1,
"records": [
{}
]
}
}Run Epicor Function
Run a published Epicor Function and get its output parameters.
Inputs
- Library
librarytextRequired - The function library's ID.
- Function
functiontextRequired - The function's ID.
- Inputs
inputsobject - The function's input parameters and their values.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"outputs": {}
}
}Update customer
Change a customer's details. Fields left empty keep their value.
Inputs
- Customer
customer_numbernumberRequired - The customer. Their number (CustNum) also works.
- Customer ID
customer_idtext - A new customer ID (CustID).
- Name
nametext - The customer's name.
- Address line 1
address_line_1text - First address line.
- Address line 2
address_line_2text - Second address line.
- Address line 3
address_line_3text - Third address line.
- City
citytext - City.
- State
statetext - State or province.
- ZIP code
ziptext - ZIP or postal code.
- Country
countrytext - Country, as Epicor names it.
- Territory
territorytext - Sales territory ID, such as US MID.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Address1": "example",
"City": "example",
"Company": "example",
"Country": "example",
"CustID": "example",
"CustNum": 1,
"Name": "example",
"State": "example",
"Zip": "example"
}
}Update part
Change a part's details. Fields left empty keep their value.
Inputs
- Part
part_numbertextRequired - The part number (PartNum).
- Description
descriptiontext - A new description.
- Part type
part_typetext - Whether the part is purchased, manufactured or a sales kit.One of:
purchased,manufactured,sales_kit(Sales kit). - Inventory unit
inventory_uomtext - Inventory unit of measure (IUM), such as EA.
- Purchasing unit
purchasing_uomtext - Purchasing unit of measure (PUM), such as EA.
- Sales unit
sales_uomtext - Sales unit of measure, such as EA.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"IUM": "example",
"PartDescription": "example",
"PartNum": "example",
"TypeCode": "example"
}
}Update sales order line
Change a sales order line. Fields left empty keep their value.
Inputs
- Order number
order_numbernumberRequired - The sales order number (OrderNum).
- Line number
line_numbernumberRequired - The line's number on the order (OrderLine).
- Description
line_descriptiontext - Line description.
- Quantity
quantitynumber - Quantity ordered, in the sales unit.At least 0.
- Unit price
unit_pricenumber - Unit price in the order's currency.At least 0.
- Reference
referencetext - Your reference for the line.
Outputs
dataobject- The response from Epicor.
Example output
{
"data": {
"Company": "example",
"DocUnitPrice": 1,
"LineDesc": "example",
"OrderLine": 1,
"OrderNum": 1,
"PartNum": "example"
}
}