Avalara

App · 25 actions

Calculate AvaTax transactions, manage transaction lifecycle and read tax configuration and exemption records.

Actions

ActionWhat it does
Adjust transactionAdjust transaction.
Check connectionCheck connection.
Commit transactionCommit transaction.
Create itemsCreate items.
Create transactionCreate transaction.
Get certificateGet certificate.
Get companyGet company.
Get company nexusGet company nexus.
Get customerGet customer.
Get itemGet item.
Get locationGet location.
Get transactionGet transaction.
List certificatesList certificates.
List companiesList companies.
List company nexusList company nexus.
List company tax codesList company tax codes.
List customersList customers.
List itemsList items.
List locationsList locations.
List tax codesList tax codes.
List transactionsList transactions.
Refund transactionRefund transaction.
Resolve addressResolve address.
Uncommit transactionUncommit transaction.
Void transactionVoid transaction.

Adjust transaction

Adjust transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Includeincludetext
$include.
Adjustment reasonadjustment_reasontextRequired
Adjustmentreason.One of: NotAdjusted, SourcingIssue, ReconciledWithGeneralLedger, ExemptCertApplied, PriceAdjusted, ProductReturned, ProductExchanged, BadDebt, Other, Offline, Offset.
Adjustment descriptionadjustment_descriptiontext
Adjustmentdescription.
New transactionnew_transactionobjectRequired
Newtransaction.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Check connection

Check connection. Returns the service response.

Inputs

None.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "authenticated": false,
    "authenticatedAccountId": 1,
    "authenticatedCompanyId": 1,
    "authenticatedUserId": 1,
    "authenticatedUserName": "example",
    "authenticationType": "None",
    "crmid": "example",
    "version": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Commit transaction

Commit transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Includeincludetext
$include.
Commitcommittrue/falseRequired
Commit.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Create items

Create items. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
Process recommendations synchronouslyprocess_recommendations_synchronouslytrue/false
Processrecommendationssynchronously.
RecordsrecordslistRequired
Records.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

Create transaction

Create transaction. Returns the service response.

Inputs

Includeincludetext
$include.
Codecodetext
Code.
LineslineslistRequired
Lines.
Typetypetext
Type.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Company codecompany_codetext
Companycode.
DatedatedateRequired
Date.
Salesperson codesalesperson_codetext
Salespersoncode.
Customer codecustomer_codetextRequired
Customercode.
Customer usage typecustomer_usage_typetext
Customerusagetype.
Entity use codeentity_use_codetext
Entityusecode.
Discountdiscountnumber
Discount.
Purchase order nopurchase_order_notext
Purchaseorderno.
Exemption noexemption_notext
Exemptionno.
Addressesaddressesobject
Addresses.
Parametersparameterslist
Parameters.
User defined fieldsuser_defined_fieldslist
Userdefinedfields.
Reference codereference_codetext
Referencecode.
Reporting location codereporting_location_codetext
Reportinglocationcode.
Commitcommittrue/false
Commit.
Batch codebatch_codetext
Batchcode.
Tax overridetax_overrideobject
Taxoverride.
Currency codecurrency_codetext
Currencycode.
Service modeservice_modetext
Servicemode.One of: Automatic, Local, Remote.
Exchange rateexchange_ratenumber
Exchangerate.
Exchange rate effective dateexchange_rate_effective_datedate
Exchangerateeffectivedate.
Exchange rate currency codeexchange_rate_currency_codetext
Exchangeratecurrencycode.
Pos lane codepos_lane_codetext
Poslanecode.
Business identification nobusiness_identification_notext
Businessidentificationno.
Is seller importer of recordis_seller_importer_of_recordtrue/false
Issellerimporterofrecord.
Descriptiondescriptiontext
Description.
Emailemailtext
Email.
Debug leveldebug_leveltext
Debuglevel.One of: Normal, Diagnostic.
Customer supplier namecustomer_supplier_nametext
Customersuppliername.
Vendor namevendor_nametext
Vendorname.
Data source iddata_source_idnumber
Datasourceid.
Delivery termsdelivery_termstext
Deliveryterms.One of: DAP, DDP, FOB, FCA, FAS, EXW, DPU, CPT, CIP, CIF, CFR.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Get certificate

Get certificate. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
IdidnumberRequired
Id.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "attributes": [],
    "businessNumberType": "example",
    "companyId": 1,
    "createdDate": "2026-01-01T00:00:00Z",
    "customFields": [],
    "customers": [],
    "documentExists": false,
    "ecmStatus": "None",
    "ecmsId": 1,
    "ecmsStatus": "example",
    "exemptPercentage": 1,
    "exemptionNumber": "example",
    "exemptionReason": {
      "id": 1,
      "name": "example"
    },
    "expirationDate": "2026-01-01",
    "exposureZone": {
      "companyId": 1,
      "country": "example",
      "created": "2026-01-01T00:00:00Z",
      "description": "example",
      "id": 1,
      "modified": "2026-01-01T00:00:00Z",
      "name": "example",
      "region": "example",
      "tag": "example"
    },
    "exposureZoneName": "example",
    "filename": "example",
    "histories": [],
    "id": 1,
    "invalidReasons": [],
    "isSingleCertificate": false,
    "jobs": [],
    "jurisdictions": [],
    "logs": [],
    "modifiedDate": "2026-01-01",
    "originalFilename": "example",
    "pageCount": 1,
    "pages": [],
    "pdf": "example",
    "poNumbers": [],
    "signedDate": "2026-01-01",
    "status": "example",
    "taxNumberType": "example",
    "valid": false,
    "validatedExemptionReason": {
      "id": 1,
      "name": "example"
    },
    "verified": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Get company

Get company. Returns the service response.

Inputs

IdidnumberRequired
Id.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "accountId": 1,
    "baseCurrencyCode": "example",
    "businessIdentificationNo": "example",
    "companyCode": "example",
    "companyDescription": "example",
    "companyUrl": "example",
    "contacts": [],
    "createdDate": "2026-01-01T00:00:00Z",
    "createdUserId": 1,
    "defaultCountry": "example",
    "defaultLocationId": 1,
    "exemptCerts": [],
    "hasProfile": false,
    "id": 1,
    "inProgress": false,
    "isActive": false,
    "isAdvSave": false,
    "isDefault": false,
    "isDeleted": false,
    "isFein": false,
    "isReportingEntity": false,
    "isTest": false,
    "items": [],
    "locations": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "mossCountry": "example",
    "mossId": "example",
    "name": "example",
    "nexus": [],
    "nonReportingChildCompanies": [],
    "parameters": [],
    "parentCompanyId": 1,
    "roundingLevelId": "Line",
    "settings": [],
    "sstEffectiveDate": "2026-01-01",
    "sstPid": "example",
    "supplierandcustomers": [],
    "taxCodes": [],
    "taxDependencyLevelId": "Document",
    "taxRules": [],
    "taxpayerIdNumber": "example",
    "upcs": [],
    "warningsEnabled": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Get company nexus

Get company nexus. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
IdidnumberRequired
Id.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "companyId": 1,
    "country": "example",
    "createdDate": "2026-01-01T00:00:00Z",
    "createdUserId": 1,
    "effectiveDate": "2026-01-01",
    "endDate": "2026-01-01",
    "hasLocalNexus": false,
    "hasPermanentEstablishment": false,
    "id": 1,
    "isSSTActive": false,
    "isSellerImporterOfRecord": false,
    "jurisCode": "example",
    "jurisName": "example",
    "jurisTypeId": "STA",
    "jurisdictionTypeId": "Country",
    "localNexusTypeId": "Selected",
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "nexusTaxTypeGroup": "example",
    "nexusTypeId": "None",
    "parameters": [],
    "region": "example",
    "shortName": "example",
    "signatureCode": "example",
    "sourcing": "Mixed",
    "stateAssignedNo": "example",
    "streamlinedSalesTax": false,
    "taxAuthorityId": 1,
    "taxId": "example",
    "taxName": "example",
    "taxTypeGroup": "example",
    "taxableNexus": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Get customer

Get customer. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
Customer codecustomer_codetextRequired
Customercode.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "activeCertificates": [],
    "alternateId": "example",
    "attnName": "example",
    "attributes": [],
    "billTos": [],
    "certificates": [],
    "city": "example",
    "companyId": 1,
    "contactName": "example",
    "country": "example",
    "createdDate": "2026-01-01T00:00:00Z",
    "customFields": [],
    "customerCode": "example",
    "emailAddress": "example",
    "exposureZones": [],
    "faxNumber": "example",
    "histories": [],
    "id": 1,
    "isBill": false,
    "isShip": false,
    "lastTransaction": "2026-01-01T00:00:00Z",
    "line1": "example",
    "line2": "example",
    "logs": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "name": "example",
    "phoneNumber": "example",
    "postalCode": "example",
    "region": "example",
    "shipToStates": [],
    "shipTos": [],
    "taxpayerIdNumber": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get item

Get item. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
IdidnumberRequired
Id.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "category": "example",
    "classifications": [],
    "companyId": 1,
    "createdDate": "2026-01-01T00:00:00Z",
    "createdUserId": 1,
    "customParameters": [],
    "description": "example",
    "hsCodeClassificationStatus": [],
    "id": 1,
    "image": {
      "companyId": 1,
      "createdAt": "2026-01-01T00:00:00Z",
      "createdUserId": 1,
      "itemId": 1,
      "itemImageDetailId": 1,
      "itemImageId": "example",
      "modifiedAt": "2026-01-01T00:00:00Z",
      "modifiedUserId": 1
    },
    "itemCode": "example",
    "itemGroup": "example",
    "itemStatus": [],
    "itemType": "example",
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "parameters": [],
    "properties": {},
    "source": "example",
    "sourceEntityId": "example",
    "summary": "example",
    "tags": [],
    "taxCode": "example",
    "taxCodeDetails": {
      "description": "example",
      "isActive": false,
      "taxCode": "example"
    },
    "taxCodeId": 1,
    "taxCodeRecommendationStatus": {
      "message": "example",
      "status": "example"
    },
    "taxCodeRecommendations": [],
    "upc": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get location

Get location. Returns the service response.

Inputs

Companycompany_idnumberRequired
Companyid.
IdidnumberRequired
Id.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addressCategoryId": "Storefront",
    "addressTypeId": "Location",
    "city": "example",
    "companyId": 1,
    "country": "example",
    "county": "example",
    "createdDate": "2026-01-01T00:00:00Z",
    "createdUserId": 1,
    "dbaName": "example",
    "description": "example",
    "effectiveDate": "2026-01-01",
    "endDate": "2026-01-01",
    "id": 1,
    "isDefault": false,
    "isMarketplaceOutsideUsa": false,
    "isRegistered": false,
    "lastTransactionDate": "2026-01-01T00:00:00Z",
    "latitude": 1,
    "line1": "example",
    "line2": "example",
    "line3": "example",
    "locationCode": "example",
    "longitude": 1,
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "outletName": "example",
    "parameters": [],
    "postalCode": "example",
    "region": "example",
    "registeredDate": "2026-01-01T00:00:00Z",
    "settings": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Get transaction

Get transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List certificates

List certificates. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Includeincludetext
$include.
Filterfiltertext
$filter.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List companies

List companies. Returns one page; use the next page cursor to continue.

Inputs

Includeincludetext
$include.
Filterfiltertext
$filter.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List company nexus

List company nexus. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Filterfiltertext
$filter.
Includeincludetext
$include.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List company tax codes

List company tax codes. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Filterfiltertext
$filter.
Includeincludetext
$include.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List customers

List customers. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Includeincludetext
$include.
Filterfiltertext
$filter.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List items

List items. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Filterfiltertext
$filter.
Includeincludetext
$include.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.
Tag nametag_nametext
Tagname.
Item statusitem_statustext
Itemstatus.
Tax code recommendation statustax_code_recommendation_statustext
Taxcoderecommendationstatus.
Hs code classification statushs_code_classification_statustext
Hscodeclassificationstatus.
Hs code exists in countrieshs_code_exists_in_countriestext
Hscodeexistsincountries.
Hs code does not exists in countrieshs_code_does_not_exists_in_countriestext
Hscodedoesnotexistsincountries.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List locations

List locations. Returns one page; use the next page cursor to continue.

Inputs

Companycompany_idnumberRequired
Companyid.
Filterfiltertext
$filter.
Includeincludetext
$include.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List tax codes

List tax codes. Returns one page; use the next page cursor to continue.

Inputs

Filterfiltertext
$filter.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List transactions

List transactions. Returns one page; use the next page cursor to continue.

Inputs

Company codecompany_codetextRequired
Companycode.
Data source iddata_source_idnumber
Datasourceid.
Includeincludetext
$include.
Filterfiltertext
$filter.
Page sizetopnumber
$top.From 1 to 1000.
Skipskipnumber
$skip.At least 0.
Order byorder_bytext
$orderby.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "@nextLink": "example",
    "@recordsetCount": 1,
    "pageKey": "example",
    "value": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Refund transaction

Refund transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Includeincludetext
$include.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Use tax date overrideuse_tax_date_overridetrue/false
Usetaxdateoverride.
Refund transaction coderefund_transaction_codetext
Refundtransactioncode.
Refund daterefund_datedateRequired
Refunddate.
Refund typerefund_typetext
Refundtype.One of: Full, Partial, TaxOnly, Percentage.
Refund percentagerefund_percentagenumber
Refundpercentage.
Refund linesrefund_lineslist
Refundlines.
Reference codereference_codetext
Referencecode.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Resolve address

Resolve address. Returns the service response.

Inputs

Line1line1text
Line1.
Line2line2text
Line2.
Line3line3text
Line3.
Citycitytext
City.
Regionregiontext
Region.
Postal codepostal_codetext
Postalcode.
Countrycountrytext
Country.
Text casetext_casetext
Textcase.One of: Default, Upper, Mixed.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "address": {
      "city": "example",
      "country": "example",
      "latitude": 1,
      "line1": "example",
      "line2": "example",
      "line3": "example",
      "longitude": 1,
      "postalCode": "example",
      "region": "example"
    },
    "coordinates": {
      "latitude": 1,
      "longitude": 1
    },
    "messages": [],
    "resolutionQuality": "NotCoded",
    "taxAuthorities": [],
    "validatedAddresses": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Uncommit transaction

Uncommit transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Includeincludetext
$include.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Void transaction

Void transaction. Returns the service response.

Inputs

Company codecompany_codetextRequired
Companycode.
Transaction codetransaction_codetextRequired
Transactioncode.
Document typedocument_typetext
Documenttype.One of: SalesOrder, SalesInvoice, PurchaseOrder, PurchaseInvoice, ReturnOrder, ReturnInvoice, InventoryTransferOrder, InventoryTransferInvoice, ReverseChargeOrder, ReverseChargeInvoice, and 5 more.
Includeincludetext
$include.
CodecodetextRequired
Code.One of: Unspecified, PostFailed, DocDeleted, DocVoided, AdjustmentCancelled.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "addresses": [],
    "adjustmentDescription": "example",
    "adjustmentReason": "NotAdjusted",
    "apStatus": "example",
    "apStatusCode": "NoAccrualMatch",
    "batchCode": "example",
    "businessIdentificationNo": "example",
    "code": "example",
    "companyId": 1,
    "country": "example",
    "currencyCode": "example",
    "customClearanceFees": [],
    "customerCode": "example",
    "customerSupplierName": "example",
    "customerUsageType": "example",
    "customerVendorCode": "example",
    "dataSourceId": 1,
    "date": "2026-01-01",
    "deliveryTerms": "DAP",
    "description": "example",
    "destinationAddressId": 1,
    "email": "example",
    "entityUseCode": "example",
    "exchangeRate": 1,
    "exchangeRateCurrencyCode": "example",
    "exchangeRateEffectiveDate": "2026-01-01",
    "exchangeRateProvider": "example",
    "exemptNo": "example",
    "id": 1,
    "invoiceMessages": [],
    "isSellerImporterOfRecord": false,
    "lines": [],
    "locationCode": "example",
    "locationTypes": [],
    "locked": false,
    "messages": [],
    "modifiedDate": "2026-01-01T00:00:00Z",
    "modifiedUserId": 1,
    "originAddressId": 1,
    "parameters": [],
    "paymentDate": "2026-01-01",
    "purchaseOrderNo": "example",
    "reconciled": false,
    "referenceCode": "example",
    "region": "example",
    "reportingLocationCode": "example",
    "salespersonCode": "example",
    "softwareVersion": "example",
    "status": "Temporary",
    "summary": [],
    "taxDate": "2026-01-01T00:00:00Z",
    "taxDetailsByTaxType": [],
    "taxOverrideAmount": 1,
    "taxOverrideReason": "example",
    "taxOverrideType": "None",
    "totalAmount": 1,
    "totalDiscount": 1,
    "totalExempt": 1,
    "totalTax": 1,
    "totalTaxCalculated": 1,
    "totalTaxable": 1,
    "type": "SalesOrder",
    "userDefinedFields": [],
    "varianceAmount": 1,
    "vendorName": "example",
    "version": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page