Cin7 Core
App · 24 actions
Manage products, stock, customers, suppliers, sales and purchases in Cin7 Core (formerly DEAR Inventory).
Actions
| Action | What it does |
|---|---|
| Add a line to a purchase order | Add a product to a purchase's draft order, keeping the lines it already has. |
| Add a line to a sale order | Add a product to a sale's draft order, keeping the lines it already has. |
| Create a customer | Add a customer to Cin7 Core. |
| Create a product | Add a product or service to Cin7 Core. |
| Create a purchase | Start a purchase from a supplier. |
| Create a sale | Start a sale for a customer. |
| Create a supplier | Add a supplier to Cin7 Core. |
| Get a customer | Get one customer, with their addresses and contacts. |
| Get a product | Get one product, with its suppliers and reorder levels. |
| Get a purchase | Get one purchase with its order, receipts and invoices. |
| Get a sale | Get one sale with its order, invoices and fulfilments. |
| Get account | Get the Cin7 Core company this connection reaches: its name, base currency and time zone. |
| Get stock levels | Get how many of each product are on hand, allocated, available and on order, by location. |
| List customers | List customers, optionally by name, contact or when they last changed. |
| List locations | List the locations (warehouses) stock is kept in. |
| List products | List products, optionally by name, SKU or when they last changed. |
| List purchases | List purchases, optionally by search words, status or when they last changed. |
| List sales | List sales, optionally by search words, status or when they were created or changed. |
| List suppliers | List suppliers, optionally by name or when they last changed. |
| Update a customer | Change a customer's details. |
| Update a product | Change a product's details. |
| Update a supplier | Change a supplier's details. |
| Void or undo a purchase | Void a purchase for good, or undo it back to a draft. |
| Void or undo a sale | Void a sale for good, or undo it back to a draft. |
Add a line to a purchase order
Add a product to a purchase's draft order, keeping the lines it already has.
Inputs
- Purchase ID
purchase_idtextRequired - The purchase's ID. Create a purchase returns it as ID.
- Product
product_idtextRequired - The product to add.
- Quantity
quantitynumberRequired - How many.At least 1.
- Price
pricenumberRequired - Price for one, in the supplier's currency.At least 0.
- Tax rule
tax_ruletextRequired - The tax rule for this line.
- Tax
taxnumberRequired - The line's tax amount, in the order's currency. Enter 0 if the line has no tax.At least 0.
- Discount
discountnumber - Discount in percent, from 0 to 100.From 0 to 100.
- Supplier SKU
supplier_skutext - The supplier's own code for the product.
- Comment
commenttext - A comment on the line.
- Authorise
authorisetrue/false - On to authorise the order once the line is added. Off keeps it a draft you can add more lines to.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
}
}Add a line to a sale order
Add a product to a sale's draft order, keeping the lines it already has.
Inputs
- Sale ID
sale_idtextRequired - The sale's ID. Create a sale returns it as ID.
- Product
product_idtextRequired - The product to add.
- Quantity
quantitynumberRequired - How many.At least 1.
- Price
pricenumberRequired - Price for one, in the customer's currency.At least 0.
- Tax rule
tax_ruletextRequired - The tax rule for this line.
- Tax
taxnumberRequired - The line's tax amount, in the order's currency. Enter 0 if the line has no tax.At least 0.
- Discount
discountnumber - Discount in percent, from 0 to 100.From 0 to 100.
- Comment
commenttext - A comment on the line.
- Authorise
authorisetrue/false - On to authorise the order once the line is added. Off keeps it a draft you can add more lines to.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
}
}Create a customer
Add a customer to Cin7 Core.
Inputs
- Name
nametextRequired - The customer's name. It must be unique.
- Currency
currencytextRequired - The customer's currency code, such as USD.
- Payment term
payment_termtextRequired - The payment term.
- Tax rule
tax_ruletextRequired - The tax rule for sales to them.
- Accounts receivable account
receivable_accounttextRequired - The accounts receivable account.
- Revenue account
revenue_accounttextRequired - The sales revenue account.
- Location
locationtext - The location their orders ship from.
- Price tier
price_tiertext - The price tier name, such as Tier 1.
- Contact name
contact_nametext - Name of the main contact.
- Contact email
contact_emailtext - Email of the main contact.
- Contact phone
contact_phonetext - Phone of the main contact.
- Comments
commentstext - Notes about the customer.
- Tags
tagstext - Tags, separated by commas.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"CustomerList": [
{
"AccountReceivable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Name": "example",
"PaymentTerm": "example",
"PriceTier": "example",
"RevenueAccount": "example",
"Status": "example",
"Tags": "example",
"TaxRule": "example"
}
],
"Page": 1,
"Total": 1
}
}Create a product
Add a product or service to Cin7 Core.
Inputs
- SKU
skutextRequired - The product's SKU. It must be unique.
- Name
nametextRequired - The product's name.
- Category
categorytextRequired - The product's category.
- Unit of measure
unittextRequired - The unit it is sold in, such as Item.
- Type
typetext - Stock for physical goods Cin7 Core counts, Service for anything else.One of:
Stock,Service. Default:Stock. - Costing method
costing_methodtext - How Cin7 Core values the stock.One of:
FIFO,Special - Batch,Special - Serial Number,FIFO - Serial Number,FIFO - Batch,FEFO - Batch,FEFO - Serial Number. Default:FIFO. - Price
pricenumber - Sale price for price tier 1.At least 0.
- Barcode
barcodetext - The product's barcode.
- Brand
brandtext - The brand name.
- Short description
short_descriptiontext - A short description.
- Description
descriptiontext - The full description.
- Default location
default_locationtext - The location it is usually kept in.
- Reorder point
reorder_pointnumber - Reorder once fewer than this many are available.At least 0.
- Reorder quantity
reorder_quantitynumber - How many to order when reordering.At least 0.
- Weight
weightnumber - Weight in kilograms.At least 0.
- Tags
tagstext - Tags, separated by commas.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"Products": [
{
"AverageCost": 1,
"Barcode": "example",
"Brand": "example",
"Category": "example",
"CostingMethod": "example",
"DefaultLocation": "example",
"Description": "example",
"ID": "example",
"LastModifiedOn": "example",
"MinimumBeforeReorder": 1,
"Name": "example",
"PriceTier1": 1,
"ReorderQuantity": 1,
"SKU": "example",
"ShortDescription": "example",
"Status": "example",
"Tags": "example",
"Type": "example",
"UOM": "example"
}
],
"Total": 1
}
}Create a purchase
Start a purchase from a supplier. Add products to it with Add a line to a purchase order.
Inputs
- Supplier
supplier_idtextRequired - The supplier.
- Location
locationtextRequired - The location the stock goes to.
- Approach
approachtext - Receive the stock first, or the invoice first.One of:
STOCK,INVOICE. Default:STOCK. - Tax rule
tax_ruletext - The purchase's tax rule. Leave empty for the supplier's.
- Required by
required_bydate - When the stock is needed.
- Note
notetext - A note on the purchase.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Approach": "example",
"ID": "example",
"LastUpdatedDate": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"OrderDate": "example",
"OrderNumber": "example",
"RequiredBy": "example",
"Status": "example",
"Supplier": "example",
"SupplierID": "example",
"TaxRule": "example",
"Type": "example"
}
}Create a sale
Start a sale for a customer. Add products to it with Add a line to a sale order.
Inputs
- Customer
customer_idtextRequired - The customer.
- Location
locationtextRequired - The location to ship stock from.
- Customer reference
customer_referencetext - The customer's own reference, such as their purchase order number.
- Tax rule
tax_ruletext - The sale's tax rule. Leave empty for the customer's.
- Ship by
ship_bydate - When it has to ship.
- Note
notetext - A note on the sale.
- External ID
external_idtext - Your own ID for the sale, to find it again with List sales.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Customer": "example",
"CustomerID": "example",
"CustomerReference": "example",
"ExternalID": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"SaleOrderDate": "example",
"ShipBy": "example",
"Status": "example",
"TaxRule": "example",
"Terms": "example",
"Type": "example"
}
}Create a supplier
Add a supplier to Cin7 Core.
Inputs
- Name
nametextRequired - The supplier's name.
- Currency
currencytextRequired - The supplier's currency code, such as USD.
- Payment term
payment_termtextRequired - The payment term.
- Tax rule
tax_ruletextRequired - The tax rule for purchases from them.
- Accounts payable account
payable_accounttextRequired - The accounts payable account.
- Contact name
contact_nametext - Name of the main contact.
- Contact email
contact_emailtext - Email of the main contact.
- Contact phone
contact_phonetext - Phone of the main contact.
- Comments
commentstext - Notes about the supplier.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"SupplierList": [
{
"AccountPayable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Name": "example",
"PaymentTerm": "example",
"Status": "example",
"TaxRule": "example"
}
],
"Total": 1
}
}Get a customer
Get one customer, with their addresses and contacts.
Inputs
- Customer
customer_idtextRequired - The customer.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"CustomerList": [
{
"AccountReceivable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Name": "example",
"PaymentTerm": "example",
"PriceTier": "example",
"RevenueAccount": "example",
"Status": "example",
"Tags": "example",
"TaxRule": "example"
}
],
"Page": 1,
"Total": 1
}
}Get a product
Get one product, with its suppliers and reorder levels.
Inputs
- Product
product_idtextRequired - The product.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"Products": [
{
"AverageCost": 1,
"Barcode": "example",
"Brand": "example",
"Category": "example",
"CostingMethod": "example",
"DefaultLocation": "example",
"Description": "example",
"ID": "example",
"LastModifiedOn": "example",
"MinimumBeforeReorder": 1,
"Name": "example",
"PriceTier1": 1,
"ReorderQuantity": 1,
"SKU": "example",
"ShortDescription": "example",
"Status": "example",
"Tags": "example",
"Type": "example",
"UOM": "example"
}
],
"Total": 1
}
}Get a purchase
Get one purchase with its order, receipts and invoices.
Inputs
- Purchase ID
purchase_idtextRequired - The purchase's ID. List purchases returns it as ID.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Approach": "example",
"ID": "example",
"LastUpdatedDate": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"OrderDate": "example",
"OrderNumber": "example",
"RequiredBy": "example",
"Status": "example",
"Supplier": "example",
"SupplierID": "example",
"TaxRule": "example",
"Type": "example"
}
}Get a sale
Get one sale with its order, invoices and fulfilments.
Inputs
- Sale ID
sale_idtextRequired - The sale's ID. List sales returns it as SaleID.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Customer": "example",
"CustomerID": "example",
"CustomerReference": "example",
"ExternalID": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"SaleOrderDate": "example",
"ShipBy": "example",
"Status": "example",
"TaxRule": "example",
"Terms": "example",
"Type": "example"
}
}Get account
Get the Cin7 Core company this connection reaches: its name, base currency and time zone.
Inputs
None.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Company": "example",
"Currency": "example",
"DefaultSaleTaxRuleName": "example",
"TimeZone": "example"
}
}Get stock levels
Get how many of each product are on hand, allocated, available and on order, by location.
Inputs
- Product
product_idtext - Only this product.
- SKU
skutext - Only the product with this SKU.
- Name
nametext - Only products whose name starts with this.
- Location
locationtext - Only stock at this location.
- Category
categorytext - Only products in this category.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"ProductAvailabilityList": [
{
"Allocated": 1,
"Available": 1,
"Batch": "example",
"Bin": "example",
"ID": "example",
"InTransit": 1,
"Location": "example",
"Name": "example",
"OnHand": 1,
"OnOrder": 1,
"SKU": "example"
}
],
"Total": 1
}
}List customers
List customers, optionally by name, contact or when they last changed.
Inputs
- Name
nametext - Only customers whose name starts with this.
- Contact
contacttext - Only customers with a contact whose name starts with this, or whose email is this.
- Modified since
modified_sincedate and time - Only customers changed at or after this time.
- Include deprecated
include_deprecatedtrue/false - Include deprecated customers too.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"CustomerList": [
{
"AccountReceivable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Name": "example",
"PaymentTerm": "example",
"PriceTier": "example",
"RevenueAccount": "example",
"Status": "example",
"Tags": "example",
"TaxRule": "example"
}
],
"Page": 1,
"Total": 1
}
}List locations
List the locations (warehouses) stock is kept in.
Inputs
- Name
nametext - Only locations whose name starts with this.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"LocationList": [
{
"Deprecated": true,
"ID": "example",
"IsDefault": true,
"Name": "example"
}
],
"Page": 1,
"Total": 1
}
}List products
List products, optionally by name, SKU or when they last changed.
Inputs
- Name
nametext - Only products whose name contains this.
- SKU
skutext - Only products whose SKU contains this.
- Modified since
modified_sincedate and time - Only products changed at or after this time.
- Include deprecated
include_deprecatedtrue/false - Include deprecated products too.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"Products": [
{
"AverageCost": 1,
"Barcode": "example",
"Brand": "example",
"Category": "example",
"CostingMethod": "example",
"DefaultLocation": "example",
"Description": "example",
"ID": "example",
"LastModifiedOn": "example",
"MinimumBeforeReorder": 1,
"Name": "example",
"PriceTier1": 1,
"ReorderQuantity": 1,
"SKU": "example",
"ShortDescription": "example",
"Status": "example",
"Tags": "example",
"Type": "example",
"UOM": "example"
}
],
"Total": 1
}
}List purchases
List purchases, optionally by search words, status or when they last changed.
Inputs
- Search
searchtext - Words to find in the order number, supplier or invoice number.
- Updated since
updated_sincedate and time - Only purchases changed after this time.
- Status
statustext - Only purchases in this state.One of:
DRAFT,ORDERING,ORDERED,RECEIVING,RECEIVED,INVOICED,CREDITED,COMPLETED,VOIDED. - Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"PurchaseList": [
{
"ID": "example",
"InvoiceAmount": 1,
"InvoiceNumber": "example",
"LastUpdatedDate": "example",
"OrderDate": "example",
"OrderNumber": "example",
"OrderStatus": "example",
"PaidAmount": 1,
"RequiredBy": "example",
"Status": "example",
"Supplier": "example",
"SupplierID": "example"
}
],
"Total": 1
}
}List sales
List sales, optionally by search words, status or when they were created or changed.
Inputs
- Search
searchtext - Words to find in the order number, customer, invoice number or customer reference.
- Created since
created_sincedate and time - Only sales created after this time.
- Updated since
updated_sincedate and time - Only sales changed after this time.
- Status
statustext - Only sales in this state.One of:
ESTIMATING,ESTIMATED,ORDERING,ORDERED,BACKORDERED,PICKING,PICKED,PACKING,PACKED,SHIPPING, and 5 more. - External ID
external_idtext - Only the sale with this external ID.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"SaleList": [
{
"CombinedInvoiceStatus": "example",
"CombinedPaymentStatus": "example",
"CombinedShippingStatus": "example",
"Customer": "example",
"CustomerID": "example",
"CustomerReference": "example",
"ExternalID": "example",
"InvoiceAmount": 1,
"InvoiceNumber": "example",
"OrderDate": "example",
"OrderNumber": "example",
"OrderStatus": "example",
"PaidAmount": 1,
"SaleID": "example",
"Status": "example",
"Updated": "example"
}
],
"Total": 1
}
}List suppliers
List suppliers, optionally by name or when they last changed.
Inputs
- Name
nametext - Only suppliers whose name starts with this.
- Modified since
modified_sincedate and time - Only suppliers changed at or after this time.
- Include deprecated
include_deprecatedtrue/false - Include deprecated suppliers too.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Limit
limitnumber - How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"SupplierList": [
{
"AccountPayable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Name": "example",
"PaymentTerm": "example",
"Status": "example",
"TaxRule": "example"
}
],
"Total": 1
}
}Update a customer
Change a customer's details. Only the fields you fill in change.
Inputs
- Customer
customer_idtextRequired - The customer.
- Name
nametext - The new name.
- Payment term
payment_termtext - The new payment term.
- Tax rule
tax_ruletext - The new tax rule.
- Location
locationtext - The new location their orders ship from.
- Price tier
price_tiertext - The new price tier name.
- Comments
commentstext - The new notes.
- Tags
tagstext - The new tags, separated by commas.
- Status
statustext - Active, or Deprecated to retire it. Cin7 Core can't delete it.One of:
Active,Deprecated.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"CustomerList": [
{
"AccountReceivable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Name": "example",
"PaymentTerm": "example",
"PriceTier": "example",
"RevenueAccount": "example",
"Status": "example",
"Tags": "example",
"TaxRule": "example"
}
],
"Page": 1,
"Total": 1
}
}Update a product
Change a product's details. Only the fields you fill in change.
Inputs
- Product
product_idtextRequired - The product.
- Name
nametext - The new name.
- SKU
skutext - The new SKU.
- Category
categorytext - The new category.
- Price
pricenumber - The new sale price for price tier 1.At least 0.
- Barcode
barcodetext - The new barcode.
- Short description
short_descriptiontext - The new short description.
- Description
descriptiontext - The new full description.
- Reorder point
reorder_pointnumber - Reorder once fewer than this many are available.At least 0.
- Reorder quantity
reorder_quantitynumber - How many to order when reordering.At least 0.
- Tags
tagstext - The new tags, separated by commas.
- Status
statustext - Active, or Deprecated to retire it. Cin7 Core can't delete it.One of:
Active,Deprecated.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"Products": [
{
"AverageCost": 1,
"Barcode": "example",
"Brand": "example",
"Category": "example",
"CostingMethod": "example",
"DefaultLocation": "example",
"Description": "example",
"ID": "example",
"LastModifiedOn": "example",
"MinimumBeforeReorder": 1,
"Name": "example",
"PriceTier1": 1,
"ReorderQuantity": 1,
"SKU": "example",
"ShortDescription": "example",
"Status": "example",
"Tags": "example",
"Type": "example",
"UOM": "example"
}
],
"Total": 1
}
}Update a supplier
Change a supplier's details. Only the fields you fill in change.
Inputs
- Supplier
supplier_idtextRequired - The supplier.
- Name
nametext - The new name.
- Payment term
payment_termtext - The new payment term.
- Tax rule
tax_ruletext - The new tax rule.
- Comments
commentstext - The new notes.
- Status
statustext - Active, or Deprecated to retire it. Cin7 Core can't delete it.One of:
Active,Deprecated.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Page": 1,
"SupplierList": [
{
"AccountPayable": "example",
"Comments": "example",
"Contacts": [
{
"Default": true,
"Email": "example",
"ID": "example",
"Name": "example",
"Phone": "example"
}
],
"Currency": "example",
"ID": "example",
"LastModifiedOn": "example",
"Name": "example",
"PaymentTerm": "example",
"Status": "example",
"TaxRule": "example"
}
],
"Total": 1
}
}Void or undo a purchase
Void a purchase for good, or undo it back to a draft.
Inputs
- Purchase ID
purchase_idtextRequired - The purchase's ID. List purchases returns it as ID.
- Void
voidtrue/falseRequired - On to void the purchase for good. Off to undo its authorisations back to a draft.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Approach": "example",
"ID": "example",
"LastUpdatedDate": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"OrderDate": "example",
"OrderNumber": "example",
"RequiredBy": "example",
"Status": "example",
"Supplier": "example",
"SupplierID": "example",
"TaxRule": "example",
"Type": "example"
}
}Void or undo a sale
Void a sale for good, or undo it back to a draft.
Inputs
- Sale ID
sale_idtextRequired - The sale's ID. List sales returns it as SaleID.
- Void
voidtrue/falseRequired - On to void the sale for good. Off to undo its authorisations back to a draft.
Outputs
dataobject- The response from Cin7 Core.
Example output
{
"data": {
"Customer": "example",
"CustomerID": "example",
"CustomerReference": "example",
"ExternalID": "example",
"ID": "example",
"LastModifiedOn": "example",
"Location": "example",
"Note": "example",
"Order": {
"Lines": [
{
"Comment": "example",
"Discount": 1,
"Name": "example",
"Price": 1,
"ProductID": "example",
"Quantity": 1,
"SKU": "example",
"Tax": 1,
"TaxRule": "example",
"Total": 1
}
],
"Memo": "example",
"Status": "example",
"Tax": 1,
"Total": 1,
"TotalBeforeTax": 1
},
"SaleOrderDate": "example",
"ShipBy": "example",
"Status": "example",
"TaxRule": "example",
"Terms": "example",
"Type": "example"
}
}