Articles in this section

Available Acumatica APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt Acumatica connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Acumatica API documentation. You can also create a composite endpoint for this application in HTTP mode.

Manufacturing endpoint

The following APIs are supported when you provide the Endpoint name as Manufacturing while configuring the connection.

Resource API endpoint Export Import
Cost roll Retrieves the schema of custom fields of the entity from the system X
Cost roll history Retrieves records that satisfy the specified conditions from the system X
Labor codes Retrieves the schema of custom fields of the entity from the system X
Retrieves a record by the values of its key fields from the system X
Retrieves a record by the value of the session entity ID from the system X
Retrieves records that satisfy the specified conditions from the system X
Delete a record by the values of its key fields X
Delete a record by its session identifier X
Labor entry Retrieves the schema of custom fields of the entity from the system X
Retrieves a record by the values of its key fields from the system X
Retrieves a record by the value of the session entity ID from the system X
Retrieves records that satisfy the specified conditions from the system X
Delete a record by the values of its key fields X
Delete a record by its session identifier X
Production order Retrieves the schema of custom fields of the entity from the system X
Retrieves a record by the values of its key fields from the system X
Retrieves a record by the value of the session entity ID from the system X
Retrieves records that satisfy the specified conditions from the system X
Delete a record by its session identifier X
Production order detail Retrieves the schema of custom fields of the entity from the system X
Retrieves a record by the values of its key fields from the system X
Retrieves a record by the value of the session entity ID from the system X
Retrieves records that satisfy the specified conditions from the system X
Delete a record by the values of its key fields X
Delete a record by its session identifier X
Production preferences Retrieves the schema of custom fields of the entity from the system X
Retrieves records that satisfy the specified conditions from the system X

eCommerce endpoint

The following APIs are supported when you provide the Endpoint name as eCommerce while configuring the connection.

The following APIs are supported when you provide the Endpoint version as v22.200.001 while configuring the connection.

Resource API endpoint Export
InventoryIssue List all InventoryIssues X
Get an InventoryIssue by ID X
Deduction benefit code Get all deduction benefit code X
Get a deduction benefit code X
Inventory quantity available Get all inventory quantity available X
Earning type code Get all earning type code X
Get an earning type code X

The following APIs are supported when you provide the Endpoint version as v20.200.001 while configuring the connection.

Resource API endpoint Export
Template items Get all Template items X
Get a Template item X

Default endpoint

The following API versions are supported when you provide the Endpoint name as Default while configuring the connection.

The following APIs are supported when you provide the Endpoint version as v25.200.001 while configuring the connection.

Resource API endpoint Export Import
Account List all accounts X
Retrieve an account X
Create or update an account X
Delete an account X
Bill List all bills X
Create or update a bill X
Delete a bill X
Contact List all contacts X
Retrieve a contact X
Create or update a contact X
Delete a contact X
Customer List all customers X
Retrieve a customer X
Create or update a customer X
Delete a customer X
Employee List all employees X
Retrieve an employee X
Create or update an employee X
Delete an employee X
Sales order List all sales orders X
Retrieve a sales order X
Create a sales order X
Create or update a sales order X
Cancel sales order X
Delete a sales order X
Shipment List all shipments X
Retrieve a shipment X
Create or update a shipment X
Delete a shipment X
Stock item List all stock items X
Retrieve a stock item X
Create or update a stock item X
Delete a stock item

The following APIs are supported when you provide the Endpoint version as v24.200.001 while configuring the connection.

Resource API endpoint Export Import
Account List all accounts X
Retrieve an account X
Create or update an account X
Delete an account X
Bill List all bills X
Create or update a bill X
Delete a bill X
Contact List all contacts X
Retrieve a contact X
Create or update a contact X
Delete a contact X
Customer List all customers X
Retrieve a customer X
Create or update a customer X
Delete a customer X
Employee List all employees X
Retrieve an employee X
Create or update an employee X
Delete an employee X
Salesorder List all salesorders X
Retrieve a salesorder X
Create a salesorder X
Create or update a salesorder X
Cancel salesorder X
Delete a salesorder X
Shipment List all shipments X
Retrieve a shipment X
Create or update a shipment X
Delete a shipment X

The following APIs are supported when you provide the Endpoint version as v23.200.001 while configuring the connection.

Resource API endpoint Export Import
Account Create or update an account X
Delete an account X
List all accounts X
Retrieve an account X
Bill Create or update a bill X
Delete a bill X
List all bills X
Contact Create or update a contact X
Delete a contact X
List all contacts X
Retrieve a contact X
Customer Create or update a customer X
Delete a customer X
List all customers X
Retrieve a customer X
Employee Create or update an employee X
Delete an employee X
List all employees X
Retrieve an employee X
Salesorder Create a salesorder X
Create or update a salesorder X
Cancel salesorder X
Delete a salesorder X
List all salesorders X
Retrieve a salesorder X
Shipment Create or update a shipment X
Delete a shipment X
List all shipments X
Retrieve a shipment X

The following APIs are supported when you provide the Endpoint version as v22.200.001 while configuring the connection.

Resource API endpoint Export Import
Customer List all Customers X
Retrieve a Customer X
Create or Update a Customer X
Delete a Customer X
SalesOrder List all SalesOrders X
Retrieve a SalesOrder X
Create or Update a SalesOrder X
Cancel SalesOrder X
Delete a SalesOrder X
Create a SalesOrder X
Shipment List all Shipments X
Retrieve a Shipment X
Create or Update a Shipment X
Delete a Shipment X
CostCode List all CostCodes X
Change CostCode ID X
Create or Update a CostCode X
Delete a CostCode X
Currency List all Currencies X
Retrieve a Currency X
Create or Update a Currency X
Delete a Currency X
CustomerClass List all CustomerClasses X
Retrieve a CustomerClass X
Create or Update a CustomerClass X
Delete a CustomerClass X
CustomerLocation List all CustomerLocations X
Retrieve a CustomerLocation X
Create or Update a CustomerLocation X
Delete a CustomerLocation X
CustomerPaymentMethod List all CustomerPaymentMethods X
Retrieve a CustomerPaymentMethod X
Create or Update a CustomerPaymentMethod X
Delete a CustomerPaymentMethod X
CustomerPriceClass List all CustomerPriceClasses X
Retrieve a CustomerPriceClass X
Create or Update a CustomerPriceClass X
Delete a CustomerPriceClass X
Discount List all Discounts X
Retrieve a Discount X
Create or Update a Discount X
Delete a Discount X
DiscountCode List all DiscountCodes X
Retrieve a DiscountCode X
Create or Update a DiscountCode X
Delete a DiscountCode X
Email List all Emails X
Create or Update an Email X
Delete an Email X
EmailProcessing List all EmailProcessings X
Retrieve an EmailProcessing X
Create or Update an EmailProcessing X
Delete an EmailProcessing X
Employee List all Employees X
Retrieve an Employee X
Create or Update an Employee X
Delete an Employee X
Event List all Events X
Retrieve an Event X
Create or Update an Event X
Delete an Event X
ExpenseClaim List all ExpenseClaims X
Retrieve an ExpenseClaim X
Create or Update an ExpenseClaim X
ApproveExpenseClaim X
Delete an ExpenseClaim X
ExpenseReceipt List all ExpenseReceipts X
Create or Update an ExpenseReceipt X
Delete an ExpenseReceipt X
ExternalCommitment List all ExternalCommitments X
Create or Update an ExternalCommitment X
Delete an ExternalCommitment X
FinancialPeriod List all FinancialPeriods X
Retrieve a FinancialPeriod X
Create or Update a FinancialPeriod X
Delete a FinancialPeriod X
FinancialYear List all Financialyears X
Retrieve a FinancialYear X
Create or Update a FinancialYear X
Delete a FinancialYear X
FOBPoint List all FOBPoints X
Retrieve a FOBPoint X
Create or Update a FOBPoint X
Delete a FOBPoint X
Inventory Adjustment List all Inventory Adjustment X
Get an Inventory Adjustment by ID X
Create or Update an Inventory Adjustment X
Delete an Inventory Adjustment X
InventoryIssue List all InventoryIssue X
Get an InventoryIssue by ID X
Create or Update an InventoryIssue X

The following APIs are supported when you provide the Endpoint version as v20.200.001 while configuring the connection.

Resource API endpoint Export Import
Account List all Accounts X
Retrieve an Account X
Create or Update an Account X
Delete an Account X
AccountGroup List all Account Groups X
Retrieve an Account Group X
Create or Update an AccountGroup X
Delete an AccountGroup X
AccountSummaryInquiry List all AccountSummaryInquiries X
Activity List all Activities X
Retrieve an Activity X
Create or Update an Activity X
Delete an Activity X
AllocationRule List all Allocation Rules X
Retrieve an Allocation Rule X
Create or Update an AllocationRule X
Delete an AllocationRule X
Appointment List all Appointments X
Get an Appointment by ID X
Create or Update an Appointment X
AttributeDefinition Create or Update an AttributeDefinition X
AttributeDefinitions List all AttributeDefinitions X
Retrieve an Attributedefinition X
Bill List all Bills X
Create or Update a Bill X
Delete a Bill X
Budget List all Budgets X
Get a Budget by ID X
BusinessAccount List all BusinessAccounts X
Retrieve a Businessaccount X
Create or Update a BusinessAccount X
Delete a BusinessAccount X
Carrier List all Carriers X
Retrieve a Carrier X
Create or Update a Carrier X
Delete a Carrier X
Case List all Cases X
Retrieve a Case X
Create or Update a Case X
Delete a Case X
CashSale List all CashSales X
Retrieve a CashSale X
Create or Update a CashSale X
Delete a CashSale X
ChangeOrder List all ChangeOrders X
Retrieve a ChangeOrder X
Create or Update a ChangeOrder X
Delete a ChangeOrder X
ChangeOrderClass List all ChangeOrderClasses X
Retrieve a ChangeOrderClass X
Create or Update a ChangeOrderClass X
Delete a ChangeOrderClass X
Check List all Checks X
Retrieve a Check X
Create or Update a Check X
Delete a Check X
CommonTask List all CommonTasks X
Retrieve a CommonTask X
Create or Update a CommonTask X
Delete a CommonTask X
Company Branch List all Company Branches X
CompanyFinancialPeriod List all CompanyFinancialPeriods X
Create or Update a CompanyFinancialPeriod X
Delete a CompanyFinancialPeriod X
Contact List all Contacts X
Retrieve a Contact X
Create or Update a Contact X
Delete a Contact X
ContractUsage List all ContractUsages X
Retrieve a ContractUsage X
Create or Update a ContractUsage X
Delete a ContractUsage X
CostCode List all CostCodes X
Change CostCode ID X
Create or Update a CostCode X
Delete a CostCode X
Currency List all Currencies X
Retrieve a Currency X
Create or Update a Currency X
Delete a Currency X
Customer List all Customers X
Retrieve a Customer X
Create or Update a Customer X
Delete a Customer X
CustomerClass List all CustomerClasses X
Retrieve a CustomerClass X
Create or Update a CustomerClass X
Delete a CustomerClass X
CustomerLocation List all CustomerLocations X
Retrieve a CustomerLocation X
Create or Update a CustomerLocation X
Delete a CustomerLocation X
CustomerPaymentMethod List all CustomerPaymentMethods X
Retrieve a CustomerPaymentMethod X
Create or Update a CustomerPaymentMethod X
Delete a CustomerPaymentMethod X
CustomerPriceClass List all CustomerPriceClasses X
Retrieve a CustomerPriceClass X
Create or Update a CustomerPriceClass X
Delete a CustomerPriceClass X
Discount List all Discounts X
Retrieve a Discount X
Create or Update a Discount X
Delete a Discount X
DiscountCode List all DiscountCodes X
Retrieve a DiscountCode X
Create or Update a DiscountCode X
Delete a DiscountCode X
Email List all Emails X
Create or Update an Email X
Delete an Email X
EmailProcessing List all EmailProcessings X
Retrieve an EmailProcessing X
Create or Update an EmailProcessing X
Delete an EmailProcessing X
Employee List all Employees X
Retrieve an Employee X
Create or Update an Employee X
Delete an Employee X
Event List all Events X
Retrieve an Event X
Create or Update an Event X
Delete an Event X
ExpenseClaim List all ExpenseClaims X
Retrieve an ExpenseClaim X
Create or Update an ExpenseClaim X
ApproveExpenseClaim X
Delete an ExpenseClaim X
ExpenseReceipt List all ExpenseReceipts X
Create or Update an ExpenseReceipt X
Delete an ExpenseReceipt X
ExternalCommitment List all ExternalCommitments X
Create or Update an ExternalCommitment X
Delete an ExternalCommitment X
FinancialPeriod List all FinancialPeriods X
Retrieve a FinancialPeriod X
Create or Update a FinancialPeriod X
Delete a FinancialPeriod X
FinancialYear List all Financialyears X
Retrieve a FinancialYear X
Create or Update a FinancialYear X
Delete a FinancialYear X
FOBPoint List all FOBPoints X
Retrieve a FOBPoint X
Create or Update a FOBPoint X
Delete a FOBPoint X
Inventory Adjustment List all Inventory Adjustment X
Get an Inventory Adjustment by ID X
Create or Update an Inventory Adjustment X
Delete an Inventory Adjustment X
InventoryAllocationInquiry List all InventoryAllocationInquiries X
InventoryReceipt List all InventoryReceipts X
Retrieve an InventoryReceipt X
Create or Update an InventoryReceipt X
Delete an InventoryReceipt X
InventorySummaryInquiry List all InventorySummaryInquiries X
Invoice List all Invoices X
Retrieve an Invoice X
Create or Update an Invoice X
Delete an Invoice X
ItemClass List all ItemClasses X
Retrieve an ItemClass X
Create or Update an ItemClass X
Delete an ItemClass X
ItemSalesCategory List all ItemSalesCategories X
Retrieve an ItemSalesCategory X
Create or Update an ItemSalesCategory X
Delete an ItemSalesCategory X
ItemWarehouse List all ItemWarehouses X
Create or Update an ItemWarehouse X
Delete an ItemWarehouse X
JournalTransaction List all JournalTransactions X
Retrieve a JournalTransaction X
Create or Update a JournalTransaction X
Delete a JournalTransaction X
KitAssembly List all KitAssemblies X
Retrieve a KitAssembly X
Create or Update a KitAssembly X
Delete a KitAssembly X
KitSpecification List all KitSpecifications X
Retrieve a KitSpecification X
Create or Update a KitSpecification X
Delete a KitSpecification X
LaborCostRate List all LaborCostRates X
Create or Update a LaborCostRate X
Delete a LaborCostRate X
Lead List all Leads X
Retrieve a Lead X
Create or Update a Lead X
Delete a Lead X
Ledger Get all Ledgers X
Get a Ledger by ID X
Create or Update a Ledger X
Delete a Ledger X
List Account Detail for Period List all Account Detail For Period Inquiries X
Get an Account Detail for Period by ID X
LotSerialClass List all LotSerialClasses X
Retrieve a LotSerialClass X
Create or Update a LotSerialClass X
Delete a LotSerialClass X
NonStockItem List all NonStockItems X
Retrieve a NonStockItem X
Create or Update a NonStockItem X
Delete a NonStockItem X
Opportunity List all Opportunities X
Retrieve an Opportunity X
Create or Update an Opportunity X
Delete an Opportunity X
Payment List all Payments X
Retrieve a Payment X
Create or Update a Payment X
PaymentMethod List all PaymentMethods X
Retrieve a PaymentMethod X
Create or Update a PaymentMethod X
Delete a PaymentMethod X
PhysicalInventoryCount List all PhysicalInventoryCounts X
Retrieve a PhysicalInventoryCount X
Create or Update a PhysicalInventoryCount X
Delete a PhysicalInventoryCount X
PhysicalInventoryReview List all PhysicalInventoryReviews X
Retrieve a PhysicalInventoryReview X
Create or Update a PhysicalInventoryReview X
Delete a PhysicalInventoryReview X
ProFormaInvoice List all ProFormaInvoices X
Retrieve a ProFormaInvoice X
Create or Update a ProFormalInvoice X
Delete a ProFormalInvoice X
Project List all Projects X
Retrieve a Project X
Create or Update a Project X
Delete a Project X
ProjectBillingRules List all ProjectBillingRules X
Retrieve a ProjectBillingRule X
Create or Update a ProjectBillingRules X
Delete a ProjectBillingRules X
ProjectBudget List all ProjectBudgets X
Retrieve a ProjectBudget X
Create or Update a ProjectBudget X
Delete a ProjectBudget X
ProjectTask List all ProjectTasks X
Retrieve a ProjectTask X
Create or Update a ProjectTask X
Delete a ProjectTask X
ProjectTemplate List all ProjectTemplates X
Retrieve a ProjectTemplate X
Create or Update a ProjectTemplate X
Delete a ProjectTemplate X
ProjectTemplateTask List all ProjectTemplateTasks X
Retrieve a ProjectTemplateTask X
Create or Update a ProjectTemplateTask X
Delete a ProjectTemplateTask X
ProjectTransaction List all ProjectTransactions X
Retrieve a ProjectTransaction X
Create or Update a ProjectTransaction X
Delete a ProjectTransaction X
PurchaseOrder List all PurchaseOrders X
Retrieve a PurchaseOrder X
Create or Update a PurchaseOrder X
Delete a PurchaseOrder X
PurchaseReceipt List all PurchaseReceipts X
Retrieve a PurchaseReceipt X
Create or Update a PurchaseReceipt X
Delete a PurchaseReceipt X
SalesInvoice List all SalesInvoices X
Retrieve a SalesInvoice X
Create or Update a SalesInvoice X
Delete a SalesInvoice X
SalesOrder List all SalesOrders X
Retrieve a SalesOrder X
Create or Update a SalesOrder X
Cancel SalesOrder X
Delete a SalesOrder X
Salesperson List all SalesPersons X
Retrieve a SalesPerson X
Create or Update a Salesperson X
Delete a Check X
SalesPricesInquiry List all SalesPricesInquiries X
SalesPriceWorksheet List all SalesPriceWorksheets X
Retrieve a SalesPriceWorksheet X
Create or Update a SalesPriceWorksheet X
Delete a SalesPriceWorksheet X
Service Order Get all Service Orders X
Get a Service Orders by ID X
Create or Update a Service Order X
Delete a Service Order by ID X
Shipment List all Shipments X
Retrieve a Shipment X
Create or Update a Shipment X
Delete a Shipment X
ShippingBox List all ShippingBoxes X
Retrieve a ShippingBox X
Create or Update a ShippingBox X
Delete a ShippingBox X
ShippingTerm Create or Update a ShippingTerm X
Delete a ShippingTerm X
ShippingZones List all ShippingZones X
Retrieve a ShippingZone X
Create or Update a ShippingZones X
Delete a ShippingZones X
ShipVia List all ShipVias X
Retrieve a ShipVia X
Create or Update a ShipVia X
Delete a ShipVia X
StatementCycle List all StatementCycles X
Retrieve a StatementCycle X
Create or Update a StatementCycle X
Delete a StatementCycle X
StockItem List all StockItems X
Retrieve a StockItem X
Create or Update a StockItem X
Delete a StockItem X
Storage Details Get Storage Details X
Get Storage Details by ID X
Storage Details by Item Warehouse Location Get Storage Details by Item Warehouse Location X
Get Storage Details by Item Warehouse Location by ID X
Subaccount List all SubAccounts X
Retrieve a SubAccount X
Create or Update a Subaccount X
Delete a Subaccount X
Task List all Tasks X
Retrieve a Task X
Create or Update a Task X
Delete a Task X
Tax List all Taxes X
Retrieve a Tax X
Create or Update a Tax X
Delete a Tax X
TaxCategory List all TaxCategories X
Retrieve a TaxCategory X
Create or Update a TaxCategory X
Delete a TaxCategory X
TaxReporting Settings Get Tax Reporting Settings X
Get Tax Reporting Settings by ID X
TaxZone List all TaxZones X
Retrieve a TaxZone X
Create or Update a TaxZone X
Delete a TaxZone X
TimeEntry List all TimeEntries X
Retrieve a TimeEntry X
Create or Update a TimeEntry X
Delete a TimeEntry X
TransferOrder List all TransferOrders X
Retrieve a TransferOrder X
Create or Update a TransferOrder X
Delete a TransferOrder X
TrialBalance List all TrialBalances X
Retrieve a TrialBalance X
Create or Update a TrialBalance X
Delete a TrialBalance X
UnionLocal List all UnionLocals X
Retrieve an UnionLocal X
Create or Update an UnionLocal X
Delete an UnionLocal X
UnitsOfMeasure List all UnitsOfMeasures X
Retrieve a UnitsOfMeasure X
Create or Update an UnitsOfMeasure X
Delete an UnitsOfMeasure X
Vendor List all Vendors X
Retrieve a Vendor X
Create or Update a Vendor X
Delete a Vendor X
VendorClass List all VendorClasses X
Retrieve a VendorClass X
Create or Update a VendorClass X
Delete a VendorClass X
VendorPricesInquiry List all VendorPricesInquiries X
VendorPriceWorksheet List all VendorPriceWorksheets X
Retrieve a VendorPriceWorksheet X
Create or Update a VendorPriceWorksheet X
Delete a VendorPriceWorksheet X
Warehouse List all Warehouses X
Retrieve a Warehouse X
Create or Update a Warehouse X
Delete a Warehouse X
WorkClassCompensationCode List all WorkClassCompensationCodes X
Retrieve a WorkClassCompensationCode X
Create or Update a WorkClassCompensationCode X
Delete a WorkClassCompensationCode X

The following APIs are supported when you provide the Endpoint version as v18.200.001 while configuring the connection.

Resource API endpoint Export Import
Account List all Accounts X
Retrieve an Account X
Create or Update an Account X
Delete an Account X
AccountByPeriodInquiry List all AccountByPeriodInquiries X
AccountBySubaccountInquiry List all AccountBySubaccountInquiries X
AccountDetailsInquiry List all AccountDetailsInquiries X
AccountGroup List all Account Groups X
Retrieve an Account Group X
Create or Update an AccountGroup X
Delete an AccountGroup X
AccountLocation List all AccountLocations X
AccountLocation Create or Update an AccountLocation X
Delete an AccountLocation X
AccountSummaryInquiry List all AccountSummaryInquiries X
Activity List all Activities X
Retrieve an Activity X
Create or Update an Activity X
Delete an Activity X
Adjustment List all Adjustments X
Retrieve an Adjustment X
Create or Update an Adjustment X
Delete an Adjustment X
AllocationRule List all Allocation Rules X
AllocationRule Retrieve an Allocation Rule X
Create or Update an AllocationRule X
Delete an AllocationRule X
AttributeDefinition Create or Update an AttributeDefinition X
AttributeDefinitions List all AttributeDefinitions X
Retrieve an Attributedefinition X
Bill List all Bills X
Create or Update a Bill X
Delete a Bill X
BusinessAccount List all BusinessAccounts X
Retrieve a Businessaccount X
Create or Update a BusinessAccount X
Delete a BusinessAccount X
Carrier List all Carriers X
Retrieve a Carrier X
Create or Update a Carrier X
Delete a Carrier X
Case List all Cases X
Retrieve a Case X
Create or Update a Case X
Delete a Case X
CashSale List all CashSales X
Retrieve a CashSale X
Create or Update a CashSale X
Delete a CashSale X
ChangeOrder List all ChangeOrders X
Retrieve a ChangeOrder X
Create or Update a ChangeOrder X
Delete a ChangeOrder X
ChangeOrderClass List all ChangeOrderClasses X
Retrieve a ChangeOrderClass X
Create or Update a ChangeOrderClass X
Delete a ChangeOrderClass X
Check List all Checks X
Retrieve a Check X
Create or Update a Check X
Delete a Check X
CommonTask List all CommonTasks X
Retrieve a CommonTask X
Create or Update a CommonTask X
Delete a CommonTask X
CompanyFinancialPeriod List all CompanyFinancialPeriods X
Create or Update a CompanyFinancialPeriod X
Delete a CompanyFinancialPeriod X
Contact List all Contacts X
Retrieve a Contact X
Create or Update a Contact X
Delete a Contact X
ContractUsage List all ContractUsages X
Retrieve a ContractUsage X
Create or Update a ContractUsage X
Delete a ContractUsage X
CostCode List all CostCodes X
Create or Update a CostCode X
Delete a CostCode X
Currency List all Currencies X
Retrieve a Currency X
Create or Update a Currency X
Delete a Currency X
Customer List all Customers X
Retrieve a Customer X
Create or Update a Customer X
Delete a Customer X
CustomerClass List all CustomerClasses X
Retrieve a CustomerClass X
Create or Update a CustomerClass X
Delete a CustomerClass X
CustomerLocation List all CustomerLocations X
Retrieve a CustomerLocation X
Create or Update a CustomerLocation X
Delete a CustomerLocation X
CustomerPaymentMethod List all CustomerPaymentMethods X
Retrieve a CustomerPaymentMethod X
Create or Update a CustomerPaymentMethod X
Delete a CustomerPaymentMethod X
CustomerPriceClass List all CustomerPriceClasses X
Retrieve a CustomerPriceClass X
Create or Update a CustomerPriceClass X
Delete a CustomerPriceClass X
Discount List all Discounts X
Retrieve a Discount X
Create or Update a Discount X
Delete a Discount X
DiscountCode List all DiscountCodes X
Retrieve a DiscountCode X
Create or Update a DiscountCode X
Delete a DiscountCode X
Email List all Emails X
Create or Update an Email X
Delete an Email X
EmailProcessing List all EmailProcessings X
Retrieve an EmailProcessing X
Create or Update an EmailProcessing X
Delete an EmailProcessing X
Employee List all Employees X
Retrieve an Employee X
Create or Update an Employee X
Delete an Employee X
Event List all Events X
Retrieve an Event X
Create or Update an Event X
Delete an Event X
ExpenseClaim List all ExpenseClaims X
Retrieve an ExpenseClaim X
Create or Update an ExpenseClaim X
ApproveExpenseClaim X
Delete an ExpenseClaim X
ExpenseReceipt List all ExpenseReceipts X
Create or Update an ExpenseReceipt X
Delete an ExpenseReceipt X
ExternalCommitment List all ExternalCommitments X
Create or Update an ExternalCommitment X
Delete an ExternalCommitment X
FinancialPeriod List all FinancialPeriods X
Retrieve a FinancialPeriod X
Create or Update a FinancialPeriod X
Delete a FinancialPeriod X
FinancialYear List all Financialyears X
Retrieve a FinancialYear X
Create or Update a FinancialYear X
Delete a FinancialYear X
FOBPoint List all FOBPoints X
Retrieve a FOBPoint X
Create or Update a FOBPoint X
Delete a FOBPoint X
InterBranchAccountMapping List all InterBranchAccountMappings X
Retrieve an InterBranchAccountMapping X
Create or Update an InterBranchAccountMapping X
Delete a InterBranchAccountMapping X
InventoryAllocationInquiry List all InventoryAllocationInquiries X
InventoryReceipt List all InventoryReceipts X
Retrieve an InventoryReceipt X
Create or Update an InventoryReceipt X
Delete an InventoryReceipt X
InventorySummaryInquiry List all InventorySummaryInquiries X
Invoice List all Invoices X
Retrieve an Invoice X
Create or Update an Invoice X
Delete an Invoice X
ItemClass List all ItemClasses X
Retrieve an ItemClass X
Create or Update an ItemClass X
Delete an ItemClass X
ItemSalesCategory List all ItemSalesCategories X
Retrieve an ItemSalesCategory X
Create or Update an ItemSalesCategory X
Delete an ItemSalesCategory X
ItemWarehouse List all ItemWarehouses X
Create or Update an ItemWarehouse X
Delete an ItemWarehouse X
JournalTransaction List all JournalTransactions X
Retrieve a JournalTransaction X
Create or Update a JournalTransaction X
Delete a JournalTransaction X
JournalVoucher List all JournalVouchers X
Retrieve a JournalVoucher X
Create or Update a JournalVoucher X
Delete a JournalVoucher X
KitAssembly List all KitAssemblies X
Retrieve a KitAssembly X
Create or Update a KitAssembly X
Delete a KitAssembly X
KitSpecification List all KitSpecifications X
Retrieve a KitSpecification X
Create or Update a KitSpecification X
Delete a KitSpecification X
LaborCostRate List all LaborCostRates X
Create or Update a LaborCostRate X
Delete a LaborCostRate X
Lead List all Leads X
Retrieve a Lead X
Create or Update a Lead X
Delete a Lead X
LotSerialClass List all LotSerialClasses X
Retrieve a LotSerialClass X
Create or Update a LotSerialClass X
Delete a LotSerialClass X
NonStockItem List all NonStockItems X
Retrieve a NonStockItem X
Create or Update a NonStockItem X
Delete a NonStockItem X
Opportunity List all Opportunities X
Retrieve an Opportunity X
Create or Update an Opportunity X
Delete an Opportunity X
Payment List all Payments X
Retrieve a Payment X
Create or Update a Payment X
Release a Payment X
Delete a Payment X
PaymentMethod List all PaymentMethods X
Retrieve a PaymentMethod X
Create or Update a PaymentMethod X
Delete a PaymentMethod X
PhysicalInventoryCount List all PhysicalInventoryCounts X
Retrieve a PhysicalInventoryCount X
Create or Update a PhysicalInventoryCount X
Delete a PhysicalInventoryCount X
PhysicalInventoryReview List all PhysicalInventoryReviews X
Retrieve a PhysicalInventoryReview X
Create or Update a PhysicalInventoryReview X
Delete a PhysicalInventoryReview X
ProFormaInvoice List all ProFormaInvoices X
Retrieve a ProFormaInvoice X
Create or Update a ProFormaInvoice X
Delete a ProFormaInvoice X
Project List all Projects X
Retrieve a Project X
Create or Update a Project X
Delete a Project X
ProjectBillingRules List all ProjectBillingRules X
Retrieve a ProjectBillingRule X
Create or Update a ProjectBillingRules X
Delete a ProjectBillingRules X
ProjectBudget List all ProjectBudgets X
Retrieve a ProjectBudget X
Create or Update a ProjectBudget X
Delete a ProjectBudget X
ProjectTask List all ProjectTasks X
Retrieve a ProjectTask X
Create or Update a ProjectTask X
Delete a ProjectTask X
ProjectTemplate List all ProjectTemplates X
Retrieve a ProjectTemplate X
Create or Update a ProjectTemplate X
Delete a ProjectTemplate X
ProjectTemplateTask List all ProjectTemplateTasks X
Retrieve a ProjectTemplateTask X
Create or Update a ProjectTemplateTask X
Delete a ProjectTemplateTask X
ProjectTransaction List all ProjectTransactions X
Retrieve a ProjectTransaction X
Create or Update a ProjectTransaction X
Delete a ProjectTransaction X
PurchaseOrder List all PurchaseOrders X
Retrieve a PurchaseOrder X
Create or Update a PurchaseOrder X
Delete a PurchaseOrder X
PurchaseReceipt List all PurchaseReceipts X
Retrieve a PurchaseReceipt X
Create or Update a PurchaseReceipt X
Delete a PurchaseReceipt X
ReportingSettings List all ReportingSettings X
Retrieve a ReportingSettings X
Create or Update a ReportingSettings X
Delete a ReportingSettings X
SalesInvoice List all SalesInvoices X
Retrieve a SalesInvoice X
Create or Update a SalesInvoice X
Delete a SalesInvoice X
Release a SalesInvoice X
SalesOrder List all SalesOrders X
Retrieve a SalesOrder X
Create or Update a SalesOrder X
Cancel SalesOrder X
Delete a SalesOrder X
Salesperson List all SalesPersons X
Retrieve a SalesPerson X
Create or Update a Salesperson X
Delete a Check X
SalesPricesInquiry List all SalesPricesInquiries X
SalesPriceWorksheet List all SalesPriceWorksheets X
Retrieve a SalesPriceWorksheet X
Create or Update a SalesPriceWorksheet X
Delete a SalesPriceWorksheet X
Shipment List all Shipments X
Retrieve a Shipment X
Create or Update a Shipment X
Delete a Shipment X
Confirm Shipment X
ShippingBox List all ShippingBoxes X
Retrieve a ShippingBox X
Create or Update a ShippingBox X
Delete a ShippingBox X
ShippingTerm Create or Update a ShippingTerm X
Delete a ShippingTerm X
ShippingZones List all ShippingZones X
Retrieve a ShippingZone X
Create or Update a ShippingZones X
Delete a ShippingZones X
ShipVia List all ShipVias X
Retrieve a ShipVia X
Create or Update a ShipVia X
Delete a ShipVia X
StatementCycle List all StatementCycles X
Retrieve a StatementCycle X
Create or Update a StatementCycle X
Delete a StatementCycle X
StockItem List all StockItems X
Retrieve a StockItem X
Create or Update a StockItem X
Delete a StockItem X
Subaccount List all SubAccounts X
Retrieve a SubAccount X
Create or Update a Subaccount X
Delete a Subaccount X
Task List all Tasks X
Retrieve a Task X
Create or Update a Task X
Delete a Task X
Tax List all Taxes X
Retrieve a Tax X
Create or Update a Tax X
Delete a Tax X
TaxCategory List all TaxCategories X
Retrieve a TaxCategory X
Create or Update a TaxCategory X
Delete a TaxCategory X
TaxZone List all TaxZones X
Retrieve a TaxZone X
Create or Update a TaxZone X
Delete a TaxZone X
TimeEntry List all TimeEntries X
Retrieve a TimeEntry X
Create or Update a TimeEntry X
Delete a TimeEntry X
TransferOrder List all TransferOrders X
Retrieve a TransferOrder X
Create or Update a TransferOrder X
Delete a TransferOrder X
TrialBalance List all TrialBalances X
Retrieve a TrialBalance X
Create or Update a TrialBalance X
Delete a TrialBalance X
UnionLocal List all UnionLocals X
Retrieve an UnionLocal X
Create or Update an UnionLocal X
Delete an UnionLocal X
UnitsOfMeasure List all UnitsOfMeasures X
Retrieve a UnitsOfMeasure X
Create or Update an UnitsOfMeasure X
Delete an UnitsOfMeasure X
Vendor List all Vendors X
Retrieve a Vendor X
Create or Update a Vendor X
Delete a Vendor X
VendorClass List all VendorClasses X
Retrieve a VendorClass X
Create or Update a VendorClass X
Delete a VendorClass X
VendorPricesInquiry List all VendorPricesInquiries X
VendorPriceWorksheet List all VendorPriceWorksheets X
Retrieve a VendorPriceWorksheet X
Create or Update a VendorPriceWorksheet X
Delete a VendorPriceWorksheet X
VoucherEntryCode List all VoucherEntryCodes X
Retrieve a VoucherEntrycode X
Create or Update a VoucherEntryCode X
Delete a VoucherEntryCode X
Warehouse List all Warehouses X
Retrieve a Warehouse X
Create or Update a Warehouse X
Delete a Warehouse X
WorkClassCompensationCode List all WorkClassCompensationCodes X
Retrieve a WorkClassCompensationCode X
Create or Update a WorkClassCompensationCode X
Delete a WorkClassCompensationCode X

The following APIs are supported when you provide the Endpoint version as v17.200.001 while configuring the connection.

Resource API endpoint Export Import
Account List all Accounts X
Retrieve an Account X
Create or Update an Account X
Delete an Account X
AccountByPeriodInquiry List all AccountByPeriodInquiries X
AccountDetailsInquiry List all AccountDetailsInquiries X
AccountLocation List all AccountLocations X
Retrieve an AccountLocation X
Create or Update an AccountLocation X
Delete an AccountLocation X
AccountSummaryInquiry List all AccountSummaryInquiries X
Adjustment List all Adjustments X
Retrieve an Adjustment X
Create or Update an Adjustment X
Delete an Adjustment X
AttributeDefinition Create or Update an AttributeDefinition X
AttributeDefinitions List all AttributeDefinitions X
Retrieve an Attributedefinition X
Bill List all Bills X
Create or Update a Bill X
Delete a Bill X
BusinessAccount List all BusinessAccounts X
Retrieve a Businessaccount X
Create or Update a BusinessAccount X
Delete a BusinessAccount X
Carrier List all Carriers X
Retrieve a Carrier X
Create or Update a Carrier X
Delete a Carrier X
Case List all Cases X
Retrieve a Case X
Create or Update a Case X
Delete a Case X
CashSale List all CashSales X
Retrieve a CashSale X
Create or Update a CashSale X
Delete a CashSale X
Check List all Checks X
Retrieve a Check X
Create or Update a Check X
Delete a Check X
Contact List all Contacts X
Retrieve a Contact X
Create or Update a Contact X
Delete a Contact X
ContractUsage List all ContractUsages X
Retrieve a ContractUsage X
Create or Update a ContractUsage X
Delete a ContractUsage X
Currency List all Currencies X
Retrieve a Currency X
Create or Update a Currency X
Delete a Currency X
Customer List all Customers X
Retrieve a Customer X
Create or Update a Customer X
Delete a Customer X
CustomerClass List all CustomerClasses X
Retrieve a CustomerClass X
Create or Update a CustomerClass X
Delete a CustomerClass X
CustomerLocation List all CustomerLocations X
Retrieve a CustomerLocation X
Create or Update a CustomerLocation X
Delete a CustomerLocation X
CustomerPaymentMethod List all CustomerPaymentMethods X
Retrieve a CustomerPaymentMethod X
Create or Update a CustomerPaymentMethod X
Delete a CustomerPaymentMethod X
CustomerPriceClass List all CustomerPriceClasses X
Retrieve a CustomerPriceClass X
Create or Update a CustomerPriceClass X
Delete a CustomerPriceClass X
Discount List all Discounts X
Retrieve a Discount X
Create or Update a Discount X
Delete a Discount X
DiscountCode List all DiscountCodes X
Retrieve a DiscountCode X
Create or Update a DiscountCode X
Delete a DiscountCode X
Email List all Emails X
Create or Update an Email X
Delete a BusinessAccount X
EmailProcessing List all EmailProcessings X
Retrieve an EmailProcessing X
Create or Update an EmailProcessing X
Delete an EmailProcessing X
Employee List all Employees X
Retrieve an Employee X
Create or Update an Employee X
Delete an Employee X
Event List all Events X
Retrieve an Event X
Create or Update an Event X
Delete an Event X
FinancialPeriod List all FinancialPeriods X
Retrieve a FinancialPeriod X
Create or Update a FinancialPeriod X
Delete a FinancialPeriod X
FinancialYear List all Financialyears X
Create or Update a FinancialYear X
Delete a FinancialYear X
FOBPoint List all FOBPoints X
Retrieve a FOBPoint X
Create or Update a FOBPoint X
Delete a FOBPoint X
InterBranchAccountMapping List all InterBranchAccountMappings X
Retrieve an InterBranchAccountMapping X
Create or Update an InterBranchAccountMapping X
Delete a InterBranchAccountMapping X
InventoryAllocationInquiry List all InventoryAllocationInquiries X
InventoryReceipt List all InventoryReceipts X
Retrieve an InventoryReceipt X
Create or Update an InventoryReceipt X
Delete an InventoryReceipt X
InventorySummaryInquiry List all InventorySummaryInquiries X
Invoice List all Invoices X
Retrieve an Invoice X
Create or Update an Invoice X
Delete an Invoice X
ItemClass List all ItemClasses X
Retrieve an ItemClass X
Create or Update an ItemClass X
Delete an ItemClass X
ItemSalesCategory List all ItemSalesCategories X
Retrieve an ItemSalesCategory X
Create or Update an ItemSalesCategory X
Delete an ItemSalesCategory X
ItemWarehouse List all ItemWarehouses X
Create or Update an ItemWarehouse X
Delete an ItemWarehouse X
JournalTransaction List all JournalTransactions X
Retrieve a JournalTransaction X
Create or Update a JournalTransaction X
Delete a JournalTransaction X
JournalVoucher List all JournalVouchers X
Retrieve a JournalVoucher X
Create or Update a JournalVoucher X
Delete a JournalVoucher X
KitAssembly List all KitAssemblies X
Retrieve a KitAssembly X
Create or Update a KitAssembly X
Delete a KitAssembly X
KitSpecification List all KitSpecifications X
Retrieve a KitSpecification X
Create or Update a KitSpecification X
Delete a KitSpecification X
Lead List all Leads X
Retrieve a Lead X
Create or Update a Lead X
Delete a Lead X
LotSerialClass List all LotSerialClasses X
Retrieve a LotSerialClass X
Create or Update a LotSerialClass X
Delete a LotSerialClass X
NonStockItem List all NonStockItems X
Retrieve a NonStockItem X
Create or Update a NonStockItem X
Delete a NonStockItem X
Opportunity List all Opportunities X
Retrieve an Opportunity X
Create or Update an Opportunity X
Delete an Opportunity X
Payment List all Payments X
Retrieve a Payment X
Create or Update a Payment X
Release a Payment X
Delete a Payment X
PaymentMethod List all PaymentMethods X
Retrieve a PaymentMethod X
Create or Update a PaymentMethod X
Delete a PaymentMethod X
PhysicalInventoryCount List all PhysicalInventoryCounts X
Retrieve a PhysicalInventoryCount X
Create or Update a PhysicalInventoryCount X
Delete a PhysicalInventoryCount X
PhysicalInventoryReview List all PhysicalInventoryReviews X
Retrieve a PhysicalInventoryReview X
Create or Update a PhysicalInventoryReview X
Delete a PhysicalInventoryReview X
ProjectTransaction List all ProjectTransactions X
Retrieve a ProjectTransaction X
Create or Update a ProjectTransaction X
Delete a ProjectTransaction X
PurchaseOrder List all PurchaseOrders X
Retrieve a PurchaseOrder X
Create or Update a PurchaseOrder X
Delete a PurchaseOrder X
PurchaseReceipt List all PurchaseReceipts X
Retrieve a PurchaseReceipt X
Create or Update a PurchaseReceipt X
Delete a PurchaseReceipt X
ReportingSettings List all ReportingSettings X
Retrieve a ReportingSettings X
Create or Update a ReportingSettings X
Delete a ReportingSettings X
SalesInvoice List all SalesInvoices X
Retrieve a SalesInvoice X
Create or Update a SalesInvoice X
Delete a SalesInvoice X
Release a SalesInvoice X
SalesOrder List all SalesOrders X
Retrieve a SalesOrder X
Create or Update a SalesOrder X
Cancel SalesOrder X
Delete a SalesOrder X
Salesperson List all SalesPersons X
Retrieve a SalesPerson X
Create or Update a Salesperson X
Delete a Check X
SalesPricesInquiry List all SalesPricesInquiries X
SalesPriceWorksheet List all SalesPriceWorksheets X
Retrieve a SalesPriceWorksheet X
Shipment List all Shipments X
Retrieve a Shipment X
Create or Update a Shipment X
Delete a Shipment X
Confirm Shipment X
ShippingBox List all ShippingBoxes X
Retrieve a ShippingBox X
Create or Update a ShippingBox X
Delete a ShippingBox X
ShippingTerm Create or Update a ShippingTerm X
Delete a ShippingTerm X
ShippingZones List all ShippingZones X
Retrieve a ShippingZone X
Create or Update a ShippingZones X
Delete a ShippingZones X
ShipVia List all ShipVias X
Retrieve a ShipVia X
Create or Update a ShipVia X
Delete a ShipVia X
StatementCycle List all StatementCycles X
Retrieve a StatementCycle X
Create or Update a StatementCycle X
Delete a StatementCycle X
StockItem List all StockItems X
Retrieve a StockItem X
Create or Update a StockItem X
Delete a StockItem X
Subaccount List all SubAccounts X
Retrieve a SubAccount X
Create or Update a Subaccount X
Delete a Subaccount X
Task List all Tasks X
Retrieve a Task X
Create or Update a Task X
Delete a Task X
Tax List all Taxes X
Retrieve a Tax X
Create or Update a Tax X
Delete a Tax X
TaxCategory List all TaxCategories X
Retrieve a TaxCategory X
Create or Update a TaxCategory X
Delete a TaxCategory X
TaxZone List all TaxZones X
Retrieve a TaxZone X
Create or Update a TaxZone X
Delete a TaxZone X
TransferOrder List all TransferOrders X
Retrieve a TransferOrder X
Create or Update a TransferOrder X
Delete a TransferOrder X
TrialBalance List all TrialBalances X
Retrieve a TrialBalance X
Create or Update a TrialBalance X
Delete a TrialBalance X
UnitsOfMeasure List all UnitsOfMeasures X
Retrieve a UnitsOfMeasure X
Create or Update an UnitsOfMeasure X
Delete an UnitsOfMeasure X
Vendor List all Vendors X
Retrieve a Vendor X
Create or Update a Vendor X
Delete a Vendor X
VendorClass List all VendorClasses X
Retrieve a VendorClass X
Create or Update a VendorClass X
Delete a VendorClass X
VendorPricesInquiry List all VendorPricesInquiries X
VendorPriceWorksheet List all VendorPriceWorksheets X
Retrieve a VendorPriceWorksheet X
Create or Update a VendorPriceWorksheet X
Delete a VendorPriceWorksheet X
VoucherEntryCode List all VoucherEntryCodes X
Retrieve a VoucherEntrycode X
Create or Update a VoucherEntryCode X
Delete a VoucherEntryCode X
Warehouse List all Warehouses X
Retrieve a Warehouse X
Create or Update a Warehouse X
Delete a Warehouse X

Available DI objects

The following objects are available when using Acumatica as a source in Celigo Data Integration (DI).

Primary key: All Acumatica DI objects use id as the primary key.

Object API endpoint Available extract modes Delta field
Account List all accounts Full —
Bill List all bills Full —
Contact List all contacts Full, Incremental $filter
Customer List all customers Full, Incremental $filter
Employee List all employees Full —
Sales order List all salesorders Full, Incremental $filter
Shipment List all shipments Full, Incremental $filter
Stock item List all stockitems Full, Incremental $filter

Response schemas

Click an object below to view its response fields and delta configuration.

Account — List all accounts

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
AccountCD string
AccountClass string
AccountGroup string
AccountID number
Active boolean
CashAccount boolean
ChartOfAccountsOrder number
ConsolidationAccount string
CreatedDateTime string
CurrencyID string
Description string
LastModifiedDateTime string
PostOption string
RequireUnits boolean
RevaluationRateType string
Secured boolean
TaxCategory string
Type string
UseDefaultSubaccount boolean
_workflowActions object
Bill — List all bills

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
Amount number
Applications objectarray
Applications.id string
Applications.rowNumber number
Applications.note string
Applications.custom object
Applications.error string
Applications.files objectarray
Applications.files.id string
Applications.files.filename string
Applications.files.href string
Applications.files.comment string
Applications._links object
Applications.AmountPaid number
Applications.Balance number
Applications.DocType string
Applications.ReferenceNbr string
Applications.Status string
ApprovedForPayment boolean
Balance number
BranchID string
CashAccount string
CurrencyID string
Date string
Description string
Details objectarray
Details.id string
Details.rowNumber number
Details.note string
Details.custom object
Details.error string
Details.files objectarray
Details.files.id string
Details.files.filename string
Details.files.href string
Details.files.comment string
Details._links object
Details.Account string
Details.Amount number
Details.Branch string
Details.CalculateDiscountsOnImport boolean
Details.CostCode string
Details.Description string
Details.ExtendedCost number
Details.InventoryID string
Details.LCLineNbr number
Details.LCNbr string
Details.LCType string
Details.NonBillable boolean
Details.POLine number
Details.POOrderNbr string
Details.POOrderType string
Details.POReceiptLine number
Details.POReceiptType string
Details.POReceiptNbr string
Details.Project string
Details.ProjectTask string
Details.Qty number
Details.Subaccount string
Details.TaxCategory string
Details.TransactionDescription string
Details.UnitCost number
Details.UOM string
DueDate string
Hold boolean
LocationID string
PostPeriod string
Project string
ReferenceNbr string
RetainageDocuments objectarray
RetainageDocuments.id string
RetainageDocuments.rowNumber number
RetainageDocuments.note string
RetainageDocuments.custom object
RetainageDocuments.error string
RetainageDocuments.files objectarray
RetainageDocuments.files.id string
RetainageDocuments.files.filename string
RetainageDocuments.files.href string
RetainageDocuments.files.comment string
RetainageDocuments._links object
RetainageDocuments.Amount number
RetainageDocuments.Balance number
RetainageDocuments.Date string
RetainageDocuments.Description string
RetainageDocuments.PaymentMethod string
RetainageDocuments.PostPeriod string
RetainageDocuments.ReferenceNbr string
RetainageDocuments.Status string
RetainageDocuments.Type string
RetainageDocuments.VendorRef string
Status string
TaxDetails objectarray
TaxDetails.id string
TaxDetails.rowNumber number
TaxDetails.note string
TaxDetails.custom object
TaxDetails.error string
TaxDetails.files objectarray
TaxDetails.files.id string
TaxDetails.files.filename string
TaxDetails.files.href string
TaxDetails.files.comment string
TaxDetails._links object
TaxDetails.TaxableAmount number
TaxDetails.TaxAmount number
TaxDetails.TaxID string
TaxDetails.TaxRate number
TaxTotal number
Terms string
Type string
Vendor string
VendorRef string
IsTaxValid boolean
LastModifiedDateTime string
_workflowActions object
Contact — List all contacts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter $filter = LastModifiedDateTime ge datetimeoffset'{{lastExportDateTime}}'
Date format YYYY-MM-DDTHH:mm:ssZ

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
Active boolean
Activities objectarray
Activities.id string
Activities.rowNumber number
Activities.note string
Activities.custom object
Activities.error string
Activities.files objectarray
Activities.files.id string
Activities.files.filename string
Activities.files.href string
Activities.files.comment string
Activities._links object
Activities.Billable boolean
Activities.Overtime string
Activities.BillableOvertime string
Activities.BillableTime string
Activities.Category string
Activities.CostCode string
Activities.CreatedDateTime string
Activities.LastModifiedDateTime string
Activities.CreatedByID string
Activities.NoteID string
Activities.Owner string
Activities.Project string
Activities.ProjectTask string
Activities.RefNoteID string
Activities.Released boolean
Activities.StartDate string
Activities.Status string
Activities.Summary string
Activities.TimeSpent string
Activities.Type string
Activities.WorkgroupID string
Address object
OverrideAccountAddress boolean
AddressValidated boolean
Attention string
Attributes objectarray
Attributes.id string
Attributes.rowNumber number
Attributes.note string
Attributes.custom object
Attributes.error string
Attributes.files objectarray
Attributes.files.id string
Attributes.files.filename string
Attributes.files.href string
Attributes.files.comment string
Attributes._links object
Attributes.AttributeID string
Attributes.AttributeDescription string
Attributes.IsActive boolean
Attributes.RefNoteID string
Attributes.Required boolean
Attributes.Value string
Attributes.ValueDescription string
BusinessAccount string
Campaigns objectarray
Campaigns.id string
Campaigns.rowNumber number
Campaigns.note string
Campaigns.custom object
Campaigns.error string
Campaigns.files objectarray
Campaigns.files.id string
Campaigns.files.filename string
Campaigns.files.href string
Campaigns.files.comment string
Campaigns._links object
Campaigns.CampaignID string
Campaigns.CampaignName string
Campaigns.ContactID number
Campaigns.Stage string
Cases objectarray
Cases.id string
Cases.rowNumber number
Cases.note string
Cases.custom object
Cases.error string
Cases.files objectarray
Cases.files.id string
Cases.files.filename string
Cases.files.href string
Cases.files.comment string
Cases._links object
Cases.CaseID string
Cases.ClassID string
Cases.ClosingDate string
Cases.DateReported string
Cases.Estimation string
Cases.InitialResponse string
Cases.Owner string
Cases.Reason string
Cases.Severity string
Cases.Status string
Cases.Subject string
Cases.Workgroup string
CompanyName string
ContactClass string
ContactID number
ContactMethod string
ConvertedBy string
DateOfBirth string
DisplayName string
DoNotCall boolean
DoNotEmail boolean
DoNotFax boolean
DoNotMail boolean
Duplicate string
DuplicateFound boolean
Duplicates objectarray
Duplicates.id string
Duplicates.rowNumber number
Duplicates.note string
Duplicates.custom object
Duplicates.error string
Duplicates.files objectarray
Duplicates.files.id string
Duplicates.files.filename string
Duplicates.files.href string
Duplicates.files.comment string
Duplicates._links object
Duplicates.BusinessAccount string
Duplicates.BusinessAccountName string
Duplicates.BusinessAccountType string
Duplicates.DisplayName string
Duplicates.Duplicate string
Duplicates.Email string
Duplicates.LastModifiedDate string
Duplicates.Type string
Email string
Fax string
FaxType string
FirstName string
Gender string
Image string
JobTitle string
LanguageOrLocale string
LastIncomingActivity string
LastModifiedDateTime string
LastName string
LastOutgoingActivity string
MaritalStatus string
MarketingLists objectarray
MarketingLists.id string
MarketingLists.rowNumber number
MarketingLists.note string
MarketingLists.custom object
MarketingLists.error string
MarketingLists.files objectarray
MarketingLists.files.id string
MarketingLists.files.filename string
MarketingLists.files.href string
MarketingLists.files.comment string
MarketingLists._links object
MarketingLists.ContactID number
MarketingLists.DynamicList boolean
MarketingLists.Format string
MarketingLists.ListName string
MarketingLists.MarketingListID number
MarketingLists.Subscribed boolean
MiddleName string
NoMarketing boolean
NoMassMail boolean
Notifications objectarray
Notifications.id string
Notifications.rowNumber number
Notifications.note string
Notifications.custom object
Notifications.error string
Notifications.files objectarray
Notifications.files.id string
Notifications.files.filename string
Notifications.files.href string
Notifications.files.comment string
Notifications._links object
Notifications.Active boolean
Notifications.Bcc boolean
Notifications.ClassID string
Notifications.Description string
Notifications.Format string
Notifications.MailingID string
Notifications.Module string
Notifications.NotificationID number
Notifications.Report string
Notifications.Source string
Opportunities objectarray
Opportunities.id string
Opportunities.rowNumber number
Opportunities.note string
Opportunities.custom object
Opportunities.error string
Opportunities.files objectarray
Opportunities.files.id string
Opportunities.files.filename string
Opportunities.files.href string
Opportunities.files.comment string
Opportunities._links object
Opportunities.Currency string
Opportunities.DisplayName string
Opportunities.Estimation string
Opportunities.Owner string
Opportunities.Probability number
Opportunities.Stage string
Opportunities.Status string
Opportunities.Subject string
Opportunities.Total number
Opportunities.Workgroup string
Owner string
OwnerEmployeeName string
ParentAccount string
Phone1 string
Phone1Type string
Phone2 string
Phone2Type string
Phone3 string
Phone3Type string
QualificationDate string
Reason string
Relations objectarray
Relations.id string
Relations.rowNumber number
Relations.note string
Relations.custom object
Relations.error string
Relations.files objectarray
Relations.files.id string
Relations.files.filename string
Relations.files.href string
Relations.files.comment string
Relations._links object
Relations.Account string
Relations.AddToCc boolean
Relations.ContactDisplayName string
Relations.ContactID number
Relations.Document string
Relations.DocumentTargetNoteIDDescription string
Relations.Email string
Relations.Name string
Relations.Primary boolean
Relations.RelationID number
Relations.Role string
Relations.Type string
Relations.DocumentDate string
RoleAssignments objectarray
RoleAssignments.id string
RoleAssignments.rowNumber number
RoleAssignments.note string
RoleAssignments.custom object
RoleAssignments.error string
RoleAssignments.files objectarray
RoleAssignments.files.id string
RoleAssignments.files.filename string
RoleAssignments.files.href string
RoleAssignments.files.comment string
RoleAssignments._links object
RoleAssignments.RoleAssignmentID number
RoleAssignments.BAccountID number
RoleAssignments.ContactID number
RoleAssignments.LocationCD string
RoleAssignments.Role string
RoleAssignments.CreatedDateTime string
RoleAssignments.LastModifiedDateTime string
Source string
SourceCampaign string
SpouseOrPartnerName string
Status string
Synchronize boolean
Title string
Type string
UserInfo object
UserInfo.id string
UserInfo.rowNumber number
UserInfo.note string
UserInfo.custom object
UserInfo.error string
UserInfo.files objectarray
UserInfo.files.id string
UserInfo.files.filename string
UserInfo.files.href string
UserInfo.files.comment string
UserInfo._links object
UserInfo.GeneratePassword boolean
UserInfo.Login string
UserInfo.Password string
UserInfo.Roles objectarray
UserInfo.Roles.id string
UserInfo.Roles.rowNumber number
UserInfo.Roles.note string
UserInfo.Roles.custom object
UserInfo.Roles.error string
UserInfo.Roles.files objectarray
UserInfo.Roles._links object
UserInfo.Roles.RoleDescription string
UserInfo.Roles.RoleName string
UserInfo.Roles.Selected boolean
UserInfo.Roles.UserType number
UserInfo.Status string
UserInfo.UserType string
WebSite string
Workgroup string
WorkgroupDescription string
NoteID string
FullName string
ExtRefNbr string
_workflowActions object
Customer — List all customers

Delta configuration: use it to request incremental data.

Setting Value
Delta filter $filter = LastModifiedDateTime ge datetimeoffset'{{lastExportDateTime}}'
Date format YYYY-MM-DDTHH:mm:ssZ

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
AccountRef string
ApplyOverdueCharges boolean
Attributes objectarray
Attributes.id string
Attributes.rowNumber number
Attributes.note string
Attributes.custom object
Attributes.error string
Attributes.files objectarray
Attributes.files.id string
Attributes.files.filename string
Attributes.files.href string
Attributes.files.comment string
Attributes._links object
Attributes.AttributeID string
Attributes.AttributeDescription string
Attributes.IsActive boolean
Attributes.RefNoteID string
Attributes.Required boolean
Attributes.Value string
Attributes.ValueDescription string
AutoApplyPayments boolean
BAccountID number
BillingAddressOverride boolean
BillingContact object
BillingContactOverride boolean
Contacts objectarray
Contacts.id string
Contacts.rowNumber number
Contacts.note string
Contacts.custom object
Contacts.error string
Contacts.files objectarray
Contacts.files.id string
Contacts.files.filename string
Contacts.files.href string
Contacts.files.comment string
Contacts._links object
Contacts.Contact object
Contacts.ContactID number
Contacts.LastModifiedDateTime string
CreatedDateTime string
CreditVerificationRules object
CreditVerificationRules.id string
CreditVerificationRules.rowNumber number
CreditVerificationRules.note string
CreditVerificationRules.custom object
CreditVerificationRules.error string
CreditVerificationRules.files objectarray
CreditVerificationRules.files.id string
CreditVerificationRules.files.filename string
CreditVerificationRules.files.href string
CreditVerificationRules.files.comment string
CreditVerificationRules._links object
CreditVerificationRules.CreditDaysPastDue number
CreditVerificationRules.CreditLimit number
CreditVerificationRules.CreditVerification string
CreditVerificationRules.FirstDueDate string
CreditVerificationRules.OpenOrdersBalance number
CreditVerificationRules.RemainingCreditLimit number
CreditVerificationRules.UnreleasedBalance number
CurrencyID string
CurrencyRateType string
CustomerClass string
CustomerID string
CustomerCategory string
CustomerName string
Email string
EnableCurrencyOverride boolean
EnableRateOverride boolean
EnableWriteOffs boolean
FOBPoint string
LastModifiedDateTime string
LeadTimedays number
LocationName string
MainContact object
MultiCurrencyStatements boolean
OrderPriority number
ParentRecord string
PaymentInstructions objectarray
PaymentInstructions.id string
PaymentInstructions.rowNumber number
PaymentInstructions.note string
PaymentInstructions.custom object
PaymentInstructions.error string
PaymentInstructions.files objectarray
PaymentInstructions.files.id string
PaymentInstructions.files.filename string
PaymentInstructions.files.href string
PaymentInstructions.files.comment string
PaymentInstructions._links object
PaymentInstructions.Description string
PaymentInstructions.LocationID number
PaymentInstructions.PaymentInstructionsID string
PaymentInstructions.PaymentMethod string
PaymentInstructions.Value string
PriceClassID string
PrimaryContact object
PrimaryContactID number
PrintDunningLetters boolean
PrintInvoices boolean
PrintStatements boolean
ResidentialDelivery boolean
Salespersons objectarray
Salespersons.id string
Salespersons.rowNumber number
Salespersons.note string
Salespersons.custom object
Salespersons.error string
Salespersons.files objectarray
Salespersons.files.id string
Salespersons.files.filename string
Salespersons.files.href string
Salespersons.files.comment string
Salespersons._links object
Salespersons.Commission number
Salespersons.Default boolean
Salespersons.LocationID string
Salespersons.LocationName string
Salespersons.Name string
Salespersons.SalespersonID string
SaturdayDelivery boolean
SendDunningLettersbyEmail boolean
SendInvoicesbyEmail boolean
SendStatementsbyEmail boolean
ShippingAddressOverride boolean
ShippingBranch string
ShippingContact object
ShippingContactOverride boolean
ShippingRule string
ShippingTerms string
ShippingZoneID string
ShipVia string
StatementCycleID string
StatementType string
Status string
TaxRegistrationID string
TaxZone string
Terms string
WarehouseID string
WriteOffLimit number
RestrictVisibilityTo string
CreditLimit number
NoteID string
EntityUsageType string
TaxExemptionNumber string
IsGuestCustomer boolean
_workflowActions object
Employee — List all employees

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
Attributes objectarray
Attributes.id string
Attributes.rowNumber number
Attributes.note string
Attributes.custom object
Attributes.error string
Attributes.files objectarray
Attributes.files.id string
Attributes.files.filename string
Attributes.files.href string
Attributes.files.comment string
Attributes._links object
Attributes.AttributeID string
Attributes.AttributeDescription string
Attributes.IsActive boolean
Attributes.RefNoteID string
Attributes.Required boolean
Attributes.Value string
Attributes.ValueDescription string
CompanyTreeInfo objectarray
CompanyTreeInfo.id string
CompanyTreeInfo.rowNumber number
CompanyTreeInfo.note string
CompanyTreeInfo.custom object
CompanyTreeInfo.error string
CompanyTreeInfo.files objectarray
CompanyTreeInfo.files.id string
CompanyTreeInfo.files.filename string
CompanyTreeInfo.files.href string
CompanyTreeInfo.files.comment string
CompanyTreeInfo._links object
CompanyTreeInfo.Active boolean
CompanyTreeInfo.Owner boolean
CompanyTreeInfo.WorkgroupID string
ContactInfo object
Delegates objectarray
Delegates.id string
Delegates.rowNumber number
Delegates.note string
Delegates.custom object
Delegates.error string
Delegates.files objectarray
Delegates.files.id string
Delegates.files.filename string
Delegates.files.href string
Delegates.files.comment string
Delegates._links object
Delegates.Delegate string
Delegates.EmployeeName string
Delegates.DelegationOf string
Delegates.StartsOn string
Delegates.ExpiresOn string
Delegates.IsActive boolean
EmployeeID string
EmployeeName string
EmployeeSettings object
EmploymentHistory objectarray
EmploymentHistory.id string
EmploymentHistory.rowNumber number
EmploymentHistory.note string
EmploymentHistory.custom object
EmploymentHistory.error string
EmploymentHistory.files objectarray
EmploymentHistory.files.id string
EmploymentHistory.files.filename string
EmploymentHistory.files.href string
EmploymentHistory.files.comment string
EmploymentHistory._links object
EmploymentHistory.Active boolean
EmploymentHistory.EndDate string
EmploymentHistory.LineNbr number
EmploymentHistory.PositionID string
EmploymentHistory.RehireEligible boolean
EmploymentHistory.StartDate string
EmploymentHistory.StartReason string
EmploymentHistory.Terminated boolean
EmploymentHistory.TerminationReason string
FinancialSettings object
LastModifiedDateTime string
Status string
_workflowActions object
Sales order — List all salesorders

Delta configuration: use it to request incremental data.

Setting Value
Delta filter $filter = LastModified ge datetimeoffset'{{lastExportDateTime}}'
Date format YYYY-MM-DDTHH:mm:ssZ

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
Approved boolean
BaseCurrencyID string
BillToAddress object
BillToAddressOverride boolean
BillToAddressValidated boolean
BillToContact object
BillToContact.id string
BillToContact.rowNumber number
BillToContact.note string
BillToContact.custom object
BillToContact.error string
BillToContact.files objectarray
BillToContact.files.id string
BillToContact.files.filename string
BillToContact.files.href string
BillToContact.files.comment string
BillToContact._links object
BillToContact.Attention string
BillToContact.BusinessName string
BillToContact.Email string
BillToContact.Phone1 string
BillToContactOverride boolean
Branch string
CashAccount string
Commissions object
Commissions.id string
Commissions.rowNumber number
Commissions.note string
Commissions.custom object
Commissions.error string
Commissions.files objectarray
Commissions.files.id string
Commissions.files.filename string
Commissions.files.href string
Commissions.files.comment string
Commissions._links object
Commissions.DefaultSalesperson string
Commissions.SalesPersons objectarray
Commissions.SalesPersons.id string
Commissions.SalesPersons.rowNumber number
Commissions.SalesPersons.note string
Commissions.SalesPersons.custom object
Commissions.SalesPersons.error string
Commissions.SalesPersons.files objectarray
Commissions.SalesPersons._links object
Commissions.SalesPersons.CommissionableAmount number
Commissions.SalesPersons.CommissionAmount number
Commissions.SalesPersons.CommissionPercent number
Commissions.SalesPersons.SalespersonID string
ContactID string
ControlTotal number
CreatedDate string
CreditHold boolean
CurrencyID string
CurrencyRate number
CurrencyRateTypeID string
CustomerID string
CustomerOrder string
Date string
Description string
DestinationWarehouseID string
Details objectarray
Details.id string
Details.rowNumber number
Details.note string
Details.custom object
Details.error string
Details.files objectarray
Details.files.id string
Details.files.filename string
Details.files.href string
Details.files.comment string
Details._links object
Details.Account string
Details.Allocations objectarray
Details.Allocations.id string
Details.Allocations.rowNumber number
Details.Allocations.note string
Details.Allocations.custom object
Details.Allocations.error string
Details.Allocations.files objectarray
Details.Allocations._links object
Details.Allocations.Allocated boolean
Details.Allocations.AllocWarehouseID string
Details.Allocations.Completed boolean
Details.Allocations.CustomerOrderNbr string
Details.Allocations.ExpirationDate string
Details.Allocations.InventoryID string
Details.Allocations.LineNbr number
Details.Allocations.LocationID string
Details.Allocations.LotSerialNbr string
Details.Allocations.OrderNbr string
Details.Allocations.OrderType string
Details.Allocations.Qty number
Details.Allocations.QtyOnShipments number
Details.Allocations.QtyReceived number
Details.Allocations.RelatedDocument string
Details.Allocations.SchedOrderDate string
Details.Allocations.ShipOn string
Details.Allocations.SplitLineNbr number
Details.Allocations.Subitem string
Details.Allocations.UOM string
Details.AlternateID string
Details.Amount number
Details.AutoCreateIssue boolean
Details.AverageCost number
Details.Branch string
Details.CalculateDiscountsOnImport boolean
Details.Commissionable boolean
Details.Completed boolean
Details.CostCode string
Details.CustomerOrderNbr string
Details.DiscountAmount number
Details.DiscountCode string
Details.DiscountedUnitPrice number
Details.DiscountPercent number
Details.ExtendedPrice number
Details.FreeItem boolean
Details.InventoryID string
Details.InvoiceLineNbr number
Details.InvoiceNbr string
Details.InvoiceType string
Details.LastModifiedDate string
Details.LineDescription string
Details.LineNbr number
Details.LineType string
Details.Location string
Details.ManualDiscount boolean
Details.MarkForPO boolean
Details.OpenQty number
Details.Operation string
Details.OrderQty number
Details.OvershipThreshold number
Details.POSource string
Details.ProjectTask string
Details.PurchaseWarehouse string
Details.PurchasingDetails objectarray
Details.PurchasingDetails.id string
Details.PurchasingDetails.rowNumber number
Details.PurchasingDetails.note string
Details.PurchasingDetails.custom object
Details.PurchasingDetails.error string
Details.PurchasingDetails.files objectarray
Details.PurchasingDetails._links object
Details.PurchasingDetails.POOrderLineNbr number
Details.PurchasingDetails.POOrderNbr string
Details.PurchasingDetails.POOrderType string
Details.PurchasingDetails.POReceiptLine number
Details.PurchasingDetails.POReceiptType string
Details.PurchasingDetails.POReceiptNbr string
Details.PurchasingDetails.Selected boolean
Details.VendorID string
Details.QtyOnShipments number
Details.ReasonCode string
Details.RequestedOn string
Details.SalespersonID string
Details.SchedOrderDate string
Details.ShipOn string
Details.ShippingRule string
Details.ShipToLocation string
Details.Subitem string
Details.TaxCategory string
Details.TaxZone string
Details.UnbilledAmount number
Details.UndershipThreshold number
Details.UnitCost number
Details.UnitPrice number
Details.UOM string
Details.WarehouseID string
Details.AssociatedOrderLineNbr number
Details.GiftMessage string
Details.ManualPrice boolean
Details.LotSerialNbr string
Details.NoteID string
Details.ExternalRef string
DisableAutomaticDiscountUpdate boolean
DisableAutomaticTaxCalculation boolean
DiscountDetails objectarray
DiscountDetails.id string
DiscountDetails.rowNumber number
DiscountDetails.note string
DiscountDetails.custom object
DiscountDetails.error string
DiscountDetails.files objectarray
DiscountDetails.files.id string
DiscountDetails.files.filename string
DiscountDetails.files.href string
DiscountDetails.files.comment string
DiscountDetails._links object
DiscountDetails.Description string
DiscountDetails.DiscountableAmount number
DiscountDetails.DiscountableQty number
DiscountDetails.DiscountAmount number
DiscountDetails.DiscountCode string
DiscountDetails.DiscountPercent number
DiscountDetails.ExternalDiscountCode string
DiscountDetails.FreeItem string
DiscountDetails.FreeItemQty number
DiscountDetails.ManualDiscount boolean
DiscountDetails.SequenceID string
DiscountDetails.SkipDiscount boolean
DiscountDetails.Type string
EffectiveDate string
ExternalRef string
FinancialSettings object
Hold boolean
IsTaxValid boolean
LastModified string
LocationID string
MaxRiskScore number
OrderedQty number
OrderNbr string
OrderRisks objectarray
OrderRisks.id string
OrderRisks.rowNumber number
OrderRisks.note string
OrderRisks.custom object
OrderRisks.error string
OrderRisks.files objectarray
OrderRisks.files.id string
OrderRisks.files.filename string
OrderRisks.files.href string
OrderRisks.files.comment string
OrderRisks._links object
OrderRisks.Message string
OrderRisks.Recommendation string
OrderRisks.Score number
OrderTotal number
OrderType string
PaymentMethod string
Payments objectarray
Payments.id string
Payments.rowNumber number
Payments.note string
Payments.custom object
Payments.error string
Payments.files objectarray
Payments.files.id string
Payments.files.filename string
Payments.files.href string
Payments.files.comment string
Payments._links object
Payments.ApplicationDate string
Payments.AppliedToOrder number
Payments.Authorize boolean
Payments.Balance number
Payments.CardAccountNbr string
Payments.Capture boolean
Payments.CashAccount string
Payments.Currency string
Payments.CreditCardTransactionInfo objectarray
Payments.CreditCardTransactionInfo.id string
Payments.CreditCardTransactionInfo.rowNumber number
Payments.CreditCardTransactionInfo.note string
Payments.CreditCardTransactionInfo.custom object
Payments.CreditCardTransactionInfo.error string
Payments.CreditCardTransactionInfo.files objectarray
Payments.CreditCardTransactionInfo._links object
Payments.CreditCardTransactionInfo.AuthNbr string
Payments.CreditCardTransactionInfo.ExtProfileId string
Payments.CreditCardTransactionInfo.NeedValidation boolean
Payments.CreditCardTransactionInfo.TranDate string
Payments.CreditCardTransactionInfo.TranNbr string
Payments.CreditCardTransactionInfo.TranType string
Payments.CreditCardTransactionInfo.CardType string
Payments.Description string
Payments.DocType string
Payments.Hold boolean
Payments.LastModifiedDateTime string
Payments.OrigTransactionNbr string
Payments.PaymentAmount number
Payments.PaymentMethod string
Payments.PaymentRef string
Payments.ProcessingCenterID string
Payments.ReferenceNbr string
Payments.Refund boolean
Payments.SaveCard boolean
Payments.Status string
Payments.TransferredtoInvoice number
Payments.ValidateCCRefundOrigTransaction boolean
Payments.ExternalRef string
Payments.NoteID string
PreferredWarehouseID string
Project string
ReciprocalRate number
Relations objectarray
Relations.id string
Relations.rowNumber number
Relations.note string
Relations.custom object
Relations.error string
Relations.files objectarray
Relations.files.id string
Relations.files.filename string
Relations.files.href string
Relations.files.comment string
Relations._links object
Relations.Account string
Relations.AddToCc boolean
Relations.ContactDisplayName string
Relations.ContactID number
Relations.Document string
Relations.DocumentTargetNoteIDDescription string
Relations.Email string
Relations.Name string
Relations.Primary boolean
Relations.RelationID number
Relations.Role string
Relations.Type string
Relations.DocumentDate string
RequestedOn string
Shipments objectarray
Shipments.id string
Shipments.rowNumber number
Shipments.note string
Shipments.custom object
Shipments.error string
Shipments.files objectarray
Shipments.files.id string
Shipments.files.filename string
Shipments.files.href string
Shipments.files.comment string
Shipments._links object
Shipments.InventoryDocType string
Shipments.InventoryRefNbr string
Shipments.InvoiceNbr string
Shipments.InvoiceType string
Shipments.ShipmentDate string
Shipments.ShipmentNbr string
Shipments.ShipmentType string
Shipments.ShippedQty number
Shipments.ShippedVolume number
Shipments.ShippedWeight number
Shipments.Status string
Shipments.InventoryNoteID string
Shipments.LastModifiedDateTime string
Shipments.OrderNoteID string
Shipments.ShippingNoteID string
ShippingSettings object
ShipToAddress object
ShipToAddressOverride boolean
ShipToAddressValidated boolean
ShipToContact object
ShipToContact.id string
ShipToContact.rowNumber number
ShipToContact.note string
ShipToContact.custom object
ShipToContact.error string
ShipToContact.files objectarray
ShipToContact.files.id string
ShipToContact.files.filename string
ShipToContact.files.href string
ShipToContact.files.comment string
ShipToContact._links object
ShipToContact.Attention string
ShipToContact.BusinessName string
ShipToContact.Email string
ShipToContact.Phone1 string
ShipToContactOverride boolean
ShipVia string
Status string
TaxDetails objectarray
TaxDetails.id string
TaxDetails.rowNumber number
TaxDetails.note string
TaxDetails.custom object
TaxDetails.error string
TaxDetails.files objectarray
TaxDetails.files.id string
TaxDetails.files.filename string
TaxDetails.files.href string
TaxDetails.files.comment string
TaxDetails._links object
TaxDetails.CustomerTaxZone string
TaxDetails.IncludeInVATExemptTotal boolean
TaxDetails.LineNbr number
TaxDetails.OrderNbr string
TaxDetails.OrderType string
TaxDetails.PendingVAT boolean
TaxDetails.RecordID number
TaxDetails.ReverseVAT boolean
TaxDetails.StatisticalVAT boolean
TaxDetails.TaxableAmount number
TaxDetails.TaxAmount number
TaxDetails.TaxID string
TaxDetails.TaxRate number
TaxDetails.TaxType string
TaxTotal number
Totals object
VATExemptTotal number
VATTaxableTotal number
ExternalOrderOriginal boolean
ExternalRefundRef string
WillCall boolean
PaymentRef string
NoteID string
UsrExternalOrderOriginal boolean
ExternalOrderOrigin string
ExternalOrderSource string
TaxCalcMode string
CreatedDate string
_workflowActions object
Shipment — List all shipments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter $filter = CreatedDateTime ge datetimeoffset'{{lastExportDateTime}}'
Date format YYYY-MM-DDTHH:mm:ssZ

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
BaseCurrencyID string
ControlQty number
CreatedDateTime string
CurrencyRate number
CurrencyRateTypeID string
CurrencyViewState boolean
CustomerID string
CreateNewShipmentForEveryOrder boolean
Details objectarray
Details.id string
Details.rowNumber number
Details.note string
Details.custom object
Details.error string
Details.files objectarray
Details.files.id string
Details.files.filename string
Details.files.href string
Details.files.comment string
Details._links object
Details.Allocations objectarray
Details.Allocations.id string
Details.Allocations.rowNumber number
Details.Allocations.note string
Details.Allocations.custom object
Details.Allocations.error string
Details.Allocations.files objectarray
Details.Allocations._links object
Details.Allocations.Description string
Details.Allocations.ExpirationDate string
Details.Allocations.InventoryID string
Details.Allocations.LocationID string
Details.Allocations.LotSerialNbr string
Details.Allocations.OrderNbr string
Details.Allocations.OrderType string
Details.Allocations.Qty number
Details.Allocations.Subitem string
Details.Allocations.SplitLineNbr number
Details.Allocations.UOM string
Details.Description string
Details.ExpirationDate string
Details.FreeItem boolean
Details.InventoryID string
Details.LineNbr number
Details.LocationID string
Details.LotSerialNbr string
Details.OpenQty number
Details.OrderedQty number
Details.OrderLineNbr number
Details.OrderNbr string
Details.OrderType string
Details.OriginalQty number
Details.ReasonCode string
Details.ShippedQty number
Details.Subitem string
Details.UOM string
Details.WarehouseID string
Description string
EffectiveDate string
FOBPoint string
OverrideFreightPrice boolean
FreightPrice number
FreightCost number
FreightCurrencyID string
GroundCollect boolean
Hold boolean
Insurance boolean
LastModifiedDateTime string
LocationID string
Operation string
Orders objectarray
Orders.id string
Orders.rowNumber number
Orders.note string
Orders.custom object
Orders.error string
Orders.files objectarray
Orders.files.id string
Orders.files.filename string
Orders.files.href string
Orders.files.comment string
Orders._links object
Orders.InventoryDocType string
Orders.InventoryRefNbr string
Orders.InvoiceNbr string
Orders.InvoiceType string
Orders.OrderNbr string
Orders.OrderType string
Orders.ShipmentNbr string
Orders.ShipmentType string
Orders.ShippedQty number
Orders.ShippedVolume number
Orders.ShippedWeight number
Orders.OrderNoteID string
Owner string
PackageCount number
Packages objectarray
Packages.id string
Packages.rowNumber number
Packages.note string
Packages.custom object
Packages.error string
Packages.files objectarray
Packages.files.id string
Packages.files.filename string
Packages.files.href string
Packages.files.comment string
Packages._links object
Packages.BoxID string
Packages.CODAmount number
Packages.Confirmed boolean
Packages.CustomRefNbr1 string
Packages.CustomRefNbr2 string
Packages.DeclaredValue number
Packages.Description string
Packages.TrackingNbr string
Packages.Type string
Packages.UOM string
Packages.Weight number
Packages.Length number
Packages.Width number
Packages.Height number
Packages.PackageContents objectarray
Packages.PackageContents.id string
Packages.PackageContents.rowNumber number
Packages.PackageContents.note string
Packages.PackageContents.custom object
Packages.PackageContents.error string
Packages.PackageContents.files objectarray
Packages.PackageContents._links object
Packages.PackageContents.InventoryID string
Packages.PackageContents.LotSerialNbr string
Packages.PackageContents.OrigOrderNbr string
Packages.PackageContents.OrigOrderType string
Packages.PackageContents.Quantity number
Packages.PackageContents.ShipmentSplitLineNbr number
Packages.PackageContents.Subitem string
Packages.PackageContents.UOM string
Packages.LineNbr number
Packages.NoteID string
PackageWeight number
Picked boolean
ReciprocalRate number
ResidentialDelivery boolean
SaturdayDelivery boolean
ShipmentDate string
ShipmentNbr string
ShippedQty number
ShippedVolume number
ShippedWeight number
ShippingSettings object
ShippingSettings.id string
ShippingSettings.rowNumber number
ShippingSettings.note string
ShippingSettings.custom object
ShippingSettings.error string
ShippingSettings.files objectarray
ShippingSettings.files.id string
ShippingSettings.files.filename string
ShippingSettings.files.href string
ShippingSettings.files.comment string
ShippingSettings._links object
ShippingSettings.ShipToAddress object
ShippingSettings.ShipToAddressOverride boolean
ShippingSettings.ShipToContact object
ShippingSettings.ShipToContact.id string
ShippingSettings.ShipToContact.rowNumber number
ShippingSettings.ShipToContact.note string
ShippingSettings.ShipToContact.custom object
ShippingSettings.ShipToContact.error string
ShippingSettings.ShipToContact.files objectarray
ShippingSettings.ShipToContact._links object
ShippingSettings.ShipToContact.Attention string
ShippingSettings.ShipToContact.BusinessName string
ShippingSettings.ShipToContact.Email string
ShippingSettings.ShipToContact.Phone1 string
ShippingSettings.ShipToContactOverride boolean
ShippingSettings.Validated boolean
ShippingTerms string
ShippingZoneID string
ShipVia string
Status string
ToWarehouseID string
Type string
UnlimitedPackages boolean
UseCustomersAccount boolean
WarehouseID string
WorkgroupID string
NoteID string
_workflowActions object
Stock item — List all stockitems

Delta configuration: use it to request incremental data.

Setting Value
Delta filter $filter = LastModified ge datetimeoffset'{{lastExportDateTime}}'
Date format YYYY-MM-DDTHH:mm:ssZ

Response schema:

Field Type
id string (Primary key)
rowNumber number
note string
custom object
error string
files objectarray
files.id string
files.filename string
files.href string
files.comment string
_links object
ABCCode string
Attributes objectarray
Attributes.id string
Attributes.rowNumber number
Attributes.note string
Attributes.custom object
Attributes.error string
Attributes.files objectarray
Attributes.files.id string
Attributes.files.filename string
Attributes.files.href string
Attributes.files.comment string
Attributes._links object
Attributes.AttributeID string
Attributes.AttributeDescription string
Attributes.IsActive boolean
Attributes.RefNoteID string
Attributes.Required boolean
Attributes.Value string
Attributes.ValueDescription string
AutoIncrementalValue string
AverageCost number
BaseUOM string
Boxes objectarray
Boxes.id string
Boxes.rowNumber number
Boxes.note string
Boxes.custom object
Boxes.error string
Boxes.files objectarray
Boxes.files.id string
Boxes.files.filename string
Boxes.files.href string
Boxes.files.comment string
Boxes._links object
Boxes.BoxID string
Boxes.Description string
Boxes.MaxQty number
Boxes.MaxVolume number
Boxes.MaxWeight number
Boxes.Qty number
Boxes.UOM string
Categories objectarray
Categories.id string
Categories.rowNumber number
Categories.note string
Categories.custom object
Categories.error string
Categories.files objectarray
Categories.files.id string
Categories.files.filename string
Categories.files.href string
Categories.files.comment string
Categories._links object
Categories.CategoryID number
COGSAccount string
COGSSubaccount string
Content string
CountryOfOrigin string
CrossReferences objectarray
CrossReferences.id string
CrossReferences.rowNumber number
CrossReferences.note string
CrossReferences.custom object
CrossReferences.error string
CrossReferences.files objectarray
CrossReferences.files.id string
CrossReferences.files.filename string
CrossReferences.files.href string
CrossReferences.files.comment string
CrossReferences._links object
CrossReferences.AlternateID string
CrossReferences.AlternateType string
CrossReferences.Description string
CrossReferences.Subitem string
CrossReferences.VendorOrCustomer string
CrossReferences.UOM string
CurrentStdCost number
DefaultIssueLocationID string
DefaultPrice number
DefaultReceiptLocationID string
DefaultSubitem string
DefaultWarehouseID string
DeferralAccount string
DeferralSubaccount string
Description string
DimensionVolume number
DimensionWeight number
DiscountAccount string
DiscountSubaccount string
ImageUrl string
InventoryAccount string
InventoryID string
InventorySubaccount string
IsAKit boolean
ItemClass string
ItemStatus string
ItemType string
LandedCostVarianceAccount string
LandedCostVarianceSubaccount string
LastCost number
LastModified string
LastModifiedDateTime string
LastStdCost number
LotSerialClass string
Markup number
MaxCost number
MinCost number
MinMarkup number
MSRP number
PackagingOption string
PackSeparately boolean
PendingStdCost number
POAccrualAccount string
POAccrualSubaccount string
PostingClass string
PriceClass string
PriceManager string
PriceWorkgroup string
ProductManager string
ProductWorkgroup string
PurchasePriceVarianceAccount string
PurchasePriceVarianceSubaccount string
PurchaseUOM string
ReasonCodeSubaccount string
ReplenishmentParameters objectarray
ReplenishmentParameters.id string
ReplenishmentParameters.rowNumber number
ReplenishmentParameters.note string
ReplenishmentParameters.custom object
ReplenishmentParameters.error string
ReplenishmentParameters.files objectarray
ReplenishmentParameters.files.id string
ReplenishmentParameters.files.filename string
ReplenishmentParameters.files.href string
ReplenishmentParameters.files.comment string
ReplenishmentParameters._links object
ReplenishmentParameters.DemandForecastModel string
ReplenishmentParameters.ForecastPeriodType string
ReplenishmentParameters.LaunchDate string
ReplenishmentParameters.MaxQty number
ReplenishmentParameters.MaxShelfLifeInDays number
ReplenishmentParameters.Method string
ReplenishmentParameters.PeriodsToAnalyze number
ReplenishmentParameters.ReorderPoint number
ReplenishmentParameters.ReplenishmentClass string
ReplenishmentParameters.ReplenishmentWarehouse string
ReplenishmentParameters.SafetyStock number
ReplenishmentParameters.Seasonality string
ReplenishmentParameters.ServiceLevel number
ReplenishmentParameters.Source string
ReplenishmentParameters.TerminationDate string
ReplenishmentParameters.TransferERQ number
SalesAccount string
SalesSubaccount string
SalesUOM string
StandardCostRevaluationAccount string
StandardCostRevaluationSubaccount string
StandardCostVarianceAccount string
StandardCostVarianceSubaccount string
SubjectToCommission boolean
TaxCategory string
TariffCode string
UOMConversions objectarray
UOMConversions.id string
UOMConversions.rowNumber number
UOMConversions.note string
UOMConversions.custom object
UOMConversions.error string
UOMConversions.files objectarray
UOMConversions.files.id string
UOMConversions.files.filename string
UOMConversions.files.href string
UOMConversions.files.comment string
UOMConversions._links object
UOMConversions.ConversionFactor number
UOMConversions.FromUOM string
UOMConversions.MultiplyOrDivide string
UOMConversions.ToUOM string
UseOnEntry boolean
ValuationMethod string
VendorDetails objectarray
VendorDetails.id string
VendorDetails.rowNumber number
VendorDetails.note string
VendorDetails.custom object
VendorDetails.error string
VendorDetails.files objectarray
VendorDetails.files.id string
VendorDetails.files.filename string
VendorDetails.files.href string
VendorDetails.files.comment string
VendorDetails._links object
VendorDetails.Active boolean
VendorDetails.AddLeadTimeDays number
VendorDetails.CurrencyID string
VendorDetails.Default boolean
VendorDetails.EOQ number
VendorDetails.LastVendorPrice number
VendorDetails.LeadTimeDays number
VendorDetails.Location string
VendorDetails.LotSize number
VendorDetails.MaxOrderQty number
VendorDetails.MinOrderFrequencyInDays number
VendorDetails.MinOrderQty number
VendorDetails.Override boolean
VendorDetails.PurchaseUnit string
VendorDetails.RecordID number
VendorDetails.Subitem string
VendorDetails.VendorID string
VendorDetails.VendorName string
VendorDetails.Warehouse string
VolumeUOM string
WarehouseDetails objectarray
WarehouseDetails.id string
WarehouseDetails.rowNumber number
WarehouseDetails.note string
WarehouseDetails.custom object
WarehouseDetails.error string
WarehouseDetails.files objectarray
WarehouseDetails.files.id string
WarehouseDetails.files.filename string
WarehouseDetails.files.href string
WarehouseDetails.files.comment string
WarehouseDetails._links object
WarehouseDetails.DailyDemandForecast number
WarehouseDetails.DailyDemandForecastErrorSTDEV number
WarehouseDetails.DefaultIssueLocationID string
WarehouseDetails.DefaultReceiptLocationID string
WarehouseDetails.InventoryAccount string
WarehouseDetails.InventorySubaccount string
WarehouseDetails.IsDefault boolean
WarehouseDetails.LastForecastDate string
WarehouseDetails.Override boolean
WarehouseDetails.OverridePreferredVendor boolean
WarehouseDetails.OverrideReplenishmentSettings boolean
WarehouseDetails.OverrideStdCost boolean
WarehouseDetails.PreferredVendor string
WarehouseDetails.PriceOverride boolean
WarehouseDetails.ProductManager string
WarehouseDetails.ProductWorkgroup string
WarehouseDetails.QtyOnHand number
WarehouseDetails.ReplenishmentSource string
WarehouseDetails.ReplenishmentWarehouse string
WarehouseDetails.Seasonality string
WarehouseDetails.ServiceLevel number
WarehouseDetails.Status string
WarehouseDetails.WarehouseID string
WeightUOM string
CurySpecificMSRP number
CurySpecificPrice number
Availability string
CustomURL string
ExportToExternal boolean
FileURLs objectarray
FileURLs.id string
FileURLs.rowNumber number
FileURLs.note string
FileURLs.custom object
FileURLs.error string
FileURLs.files objectarray
FileURLs.files.id string
FileURLs.files.filename string
FileURLs.files.href string
FileURLs.files.comment string
FileURLs._links object
FileURLs.FileType string
FileURLs.FileURL string
FileURLs.NoteID string
MetaDescription string
MetaKeywords string
NoteID string
PageTitle string
SearchKeywords string
TemplateItemID string
Visibility string
NotAvailable string
_workflowActions object