Epicor

App · 20 actions

Manage customers, parts and sales orders in Epicor Kinetic, run BAQs and Epicor Functions.

Actions

ActionWhat it does
Add sales order lineAdd a part to a sales order.
Create customerAdd a customer.
Create partAdd a part.
Create sales orderStart an open sales order for a customer, billed and shipped to that customer.
Delete customerDelete a customer.
Delete partDelete a part.
Delete sales orderDelete a sales order.
Delete sales order lineDelete a line from a sales order.
Get customerGet a customer's details.
Get partGet a part's details.
Get sales orderGet a sales order, with its lines.
List customersList customers, optionally those whose name contains some text.
List partsList parts, optionally those whose description contains some text.
List sales order linesList the lines of a sales order.
List sales ordersList sales orders, newest first, optionally for one customer or only open ones.
Run BAQRun a business activity query (BAQ) and get its rows.
Run Epicor FunctionRun a published Epicor Function and get its output parameters.
Update customerChange a customer's details.
Update partChange a part's details.
Update sales order lineChange a sales order line.

Add sales order line

Add a part to a sales order.

Inputs

Order numberorder_numbernumberRequired
The sales order number (OrderNum).
Partpart_numbertextRequired
The part to order (PartNum).
Descriptionline_descriptiontext
Line description.
Quantityquantitynumber
Quantity ordered, in the sales unit.At least 0.
Unit priceunit_pricenumber
Unit price in the order's currency.At least 0.
Referencereferencetext
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 IDcustomer_idtextRequired
The customer ID people see in Epicor (CustID), such as ACME.
NamenametextRequired
The customer's name.
Address line 1address_line_1text
First address line.
Address line 2address_line_2text
Second address line.
Address line 3address_line_3text
Third address line.
Citycitytext
City.
Statestatetext
State or province.
ZIP codeziptext
ZIP or postal code.
Countrycountrytext
Country, as Epicor names it.
Territoryterritorytext
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

Partpart_numbertextRequired
The new part number (PartNum).
DescriptiondescriptiontextRequired
The part's description.
Part typepart_typetext
Whether the part is purchased, manufactured or a sales kit.One of: purchased, manufactured, sales_kit (Sales kit). Default: purchased.
Inventory unitinventory_uomtext
Inventory unit of measure (IUM), such as EA.
Purchasing unitpurchasing_uomtext
Purchasing unit of measure (PUM), such as EA.
Sales unitsales_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

Customercustomer_numbernumberRequired
The customer. Their number (CustNum) also works.
Termsterms_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

Customercustomer_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

Partpart_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 numberorder_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 numberorder_numbernumberRequired
The sales order number (OrderNum).
Line numberline_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

Customercustomer_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

Partpart_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 numberorder_numbernumberRequired
The sales order number (OrderNum).
Include linesinclude_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 containsname_containstext
Only customers whose name contains this text.
Filterfiltertext
Advanced: an OData filter such as City eq 'Minneapolis'.
Fieldsfieldslist
Epicor field names to return, such as CustID and Name. Leave empty for all of them.
Sortorder_bytext
Advanced: an OData sort such as Name desc.
Max recordstopnumber
Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
Skipskipnumber
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 containsdescription_containstext
Only parts whose description contains this text.
Filterfiltertext
Advanced: an OData filter such as City eq 'Minneapolis'.
Fieldsfieldslist
Epicor field names to return, such as CustID and Name. Leave empty for all of them.
Sortorder_bytext
Advanced: an OData sort such as Name desc.
Max recordstopnumber
Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
Skipskipnumber
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 numberorder_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

Customercustomer_numbernumber
Only this customer's orders.
Open orders onlyopen_onlytrue/false
Only orders that are still open.
Filterfiltertext
Advanced: an OData filter such as City eq 'Minneapolis'.
Fieldsfieldslist
Epicor field names to return, such as CustID and Name. Leave empty for all of them.
Sortorder_bytext
Advanced: an OData sort such as Name desc.
Max recordstopnumber
Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
Skipskipnumber
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 IDbaq_idtextRequired
The BAQ's ID, such as zCustomer01.
Filterfiltertext
Advanced: an OData filter such as City eq 'Minneapolis'.
Max recordstopnumber
Most records to return, up to 1,000. Defaults to 100.From 1 to 1000.
Skipskipnumber
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

LibrarylibrarytextRequired
The function library's ID.
FunctionfunctiontextRequired
The function's ID.
Inputsinputsobject
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

Customercustomer_numbernumberRequired
The customer. Their number (CustNum) also works.
Customer IDcustomer_idtext
A new customer ID (CustID).
Namenametext
The customer's name.
Address line 1address_line_1text
First address line.
Address line 2address_line_2text
Second address line.
Address line 3address_line_3text
Third address line.
Citycitytext
City.
Statestatetext
State or province.
ZIP codeziptext
ZIP or postal code.
Countrycountrytext
Country, as Epicor names it.
Territoryterritorytext
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

Partpart_numbertextRequired
The part number (PartNum).
Descriptiondescriptiontext
A new description.
Part typepart_typetext
Whether the part is purchased, manufactured or a sales kit.One of: purchased, manufactured, sales_kit (Sales kit).
Inventory unitinventory_uomtext
Inventory unit of measure (IUM), such as EA.
Purchasing unitpurchasing_uomtext
Purchasing unit of measure (PUM), such as EA.
Sales unitsales_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 numberorder_numbernumberRequired
The sales order number (OrderNum).
Line numberline_numbernumberRequired
The line's number on the order (OrderLine).
Descriptionline_descriptiontext
Line description.
Quantityquantitynumber
Quantity ordered, in the sales unit.At least 0.
Unit priceunit_pricenumber
Unit price in the order's currency.At least 0.
Referencereferencetext
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"
  }
}

On this page