Documents

An order entry document contains information about sales transactions. An order entry transaction can be a quote, order, shipper, invoice, or adjustment. When you create a new document, it represents the first transaction in a workflow, and it can only be converted to the next transaction in a workflow.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List order entry documents

get/objects/order-entry/document

Returns a collection with a key, ID, and link for each order entry document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "453",
      • "id": "Sales Invoice-SUBINV#0182#doc",
      • "href": "/objects/order-entry/document::Sales%20Invoice/453"
      },
    • {
      • "key": "442",
      • "id": "Sales Order-SO0023",
      • "href": "/objects/order-entry/document::Sales%20Order/442"
      },
    • {
      • "key": "446",
      • "id": "Sales Order-SO0024",
      • "href": "/objects/order-entry/document::Sales%20Order/446"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get an order entry document
get/objects/order-entry/document/{key}
Returns detailed information for a specified order entry document.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the order entry document.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "453",
    • "documentNumber": "SUBINV#0182#doc",
    • "id": "Sales Invoice-SUBINV#0182#doc",
    • "sourceDocument": {
      • "id": "Sales Order-SO0026",
      • "key": "451",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry/document::Sales%20Order/451"
      },
    • "state": "pending",
    • "txnDate": "2023-03-29",
    • "audit": {
      • "createdDateTime": "2023-11-10T18:36:30Z",
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2023-11-10T18:36:32Z"
      },
    • "entity": {
      • "key": "46",
      • "id": "CORP",
      • "name": "Corp",
      • "href": "/objects/company-config/entity/46"
      },
    • "status": "active",
    • "dueDate": "2024-10-28",
    • "documentType": "Sales Invoice",
    • "txnDefinition": {
      • "id": "Sales Invoice",
      • "key": "188",
      • "href": "/objects/order-entry-txn-definition::Sales%20Invoice/188"
      },
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        }
      },
    • "isPrinted": false,
    • "isBackordered": false,
    • "subtotal": "750.44",
    • "total": "742.54",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2023-03-29",
      • "rate": "1"
      },
    • "subtotalInTxnCurrency": "750.55",
    • "totalInTxnCurrency": "742.5",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2023-03-29",
    • "paymentStatus": "open",
    • "customer": {
      • "key": "1",
      • "id": "1",
      • "name": "Power Aerospace Materials",
      • "href": "/objects/accounts-receivable/customer/1"
      },
    • "lines": [
      • {
        }
      ],
    • "history": [
      • {
        },
      • {
        }
      ],
    • "subtotals": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/order-entry/document::Sales%20Invoice/453"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List named order entry documents
get/objects/order-entry/document::{documentName}
Returns a collection with a key, ID, and link for each order entry document with the specified name. For example, to list all documents that are based on the Sales Invoice transaction definition, specify Sales Invoice as the documentName in the request URL. 


This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "171",
      • "id": "Sales Invoice-SUBINV#0147#doc",
      • "href": "/objects/order-entry/document::Sales%20Invoice/171"
      },
    • {
      • "key": "172",
      • "id": "Sales Invoice-SUBINV#0148#doc",
      • "href": "/objects/order-entry/document::Sales%20Invoice/172"
      },
    • {
      • "key": "155",
      • "id": "Sales Invoice-SUBINV#0144#doc",
      • "href": "/objects/order-entry/document::Sales%20Invoice/155"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create an order entry document
post/objects/order-entry/document::{documentName}
Creates a new order entry document. To create a new order entry document, specify the transaction definition that is the template for the new document as documentName in the request URL.


When creating a new document, the field state must be set to one of these values: pending, draft, or submitted. If no value is specified for the state field, it defaults to pending.


To access a list of available transaction definitions, use the list transaction definitions operation. For example, to create a new order entry document that uses the Sales Invoice transaction definition as a template, specify Sales Invoice for the documentName in the request URL.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
Request Body schema: application/json
txnDate
required
string <date> 
Date on the document.


 
 Example:  "2023-04-04"
documentNumber
string
Document number for the order entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction.


 
 Example:  "SI-O122"
state
string
 Default:  "pending"
State of the order entry document.


 Enum: "approved" "closed" "converted" "convertedByLine" "declined" "draft" "exception" "inProgress" "partiallyApproved" "partiallyConverted" "partiallyConvertedByLine" "pending" "submitted"  
 Example:  "draft"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
string <decimal-precision-10> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
dueDate
string <date> 
Due date for the document.


 
 Example:  "2023-04-04"
postingDate
string <date> 
The date on which the order entry document posts to the General Ledger.


 
 Example:  "2023-04-04"
referenceNumber
string
Reference number for the document.


 
 Example:  "SALES-100"
notes
string
Notes about the document.


 
 Example:  "Fast order"
memo
string
Text printed on the document.


 
 Example:  "Lowry solutions"
contractID
string
Sales contract ID associated with the transaction.


 
 Example:  "CN100123"
contractDescription
string
Sales contract description.


 
 Example:  "Sales & Service"
invoiceDate
string <date> 
Original invoice date.


 
 Example:  "2023-04-04"
customerPONumber
string
Customer PO number associated with the transaction.


 
 Example:  "ABOTT-1001"
trackingNumber
string
User-provided tracking reference number.


 
 Example:  "TK-1002"
shipByDate
string <date> 
The ship-by date for the order.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
serviceDeliveryDate
string <date> 
The date on which the service is delivered.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
retainagePercent
number
Default retainage percent on the line item for a transaction (Construction subscription).


 
 Example:  10
scope
string  <= 4000 characters 
Details about the expected scope of work to be performed or materials to be delivered. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract."
inclusions
string  <= 4000 characters 
Details related to items that are explicitly included in the terms of this document. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Includes drive through building"
exclusions
string  <= 4000 characters 
Details related to items that are explicitly excluded in the terms of this document. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Excludes additional purchase"
terms
string  <= 4000 characters 
Additional terms or performance obligations. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Follow all safety rules and security procedure that are in force and applicable during execution of work."
object
Additional details for Quote or Requisition and Order type documents (Construction Subscription).


 
scheduledStartDate
string <date> 
Scheduled start date in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-05-07"
scheduledCompletionDate
string <date> 
Original scheduled date for completion of the work in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-07"
actualStartDate
string <date> 
Actual start date in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-05-07"
actualCompletionDate
string <date> 
Date the work is actually complete in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
revisedCompletionDate
string <date> 
Revised completion date for the work (caused by changes). Specified in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-11-01"
substantialCompletionDate
string <date> 
Date the work is considered substantially complete in the yyyy-mm-dd format. Typically used as a milestone to identify when payment obligations are due. (Construction subscription).


 
 Example:  "2024-10-10"
noticeToProceedDate
string <date> 
Date when a formal notice to proceed was given in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
responseDueDate
string <date> 
Date when a response is expected from an external party in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
executedOnDate
string <date> 
Date the related contract document was formally executed in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
scheduleImpactNotes
string  <= 100 characters 
Details about any impacts on the current schedule. Use 100 or fewer characters. (Construction subscription).


 
 Example:  "None"
object
 
referenceNumber
string
Reference number


 
 Example:  "INT-01"
object
Initiated by


 
key
string
Employee key


 
 Example:  "2"
id
string
Employee id


 
 Example:  "dhatchet"
object
Verbal approval by


 
key
string
Employee key


 
 Example:  "2"
id
string
Employee id


 
 Example:  "sdye"
object
Issued by


 
key
string
Employee key


 
 Example:  "25"
id
string
Employee id


 
 Example:  "amarquess"
issuedOnDate
string <date> 
Issued on date


 
 Example:  "2021-05-30"
object
Approved by


 
key
string
Employee key


 
 Example:  "1"
id
string
Employee id


 
 Example:  "treser"
approvedOnDate
string <date> 
Approved on date


 
 Example:  "2021-10-02"
object
Signed by


 
key
string
Employee key


 
 Example:  "32"
id
string
Employee id


 
 Example:  "broberts"
signedOnDate
string <date> 
Signed on date


 
 Example:  "2021-05-31"
source
string
Internal source


 
 Example:  "Internal"
sourceReferenceNumber
string
Internal source reference number


 
 Example:  "REF-INT-01"
object
 
referenceNumber
string
External reference number


 
 Example:  "A23"
object
Verbal approval by


 
key
string
Contact key


 
 Example:  "6"
id
string
Contact name


 
 Example:  "Johnson"
object
Approved by


 
key
string
Contact key


 
 Example:  "51"
id
string
Contact name


 
 Example:  "Jagadish"
approvedOnDate
string <date> 
Approved on date


 
 Example:  "2021-11-03"
object
Signed by


 
key
string
Contact key


 
 Example:  "200"
id
string
Contact name


 
 Example:  "Modulus Industries"
signedOnDate
string <date> 
Signed on date


 
 Example:  "2021-12-01"
object
Performance bond details from the vendor or a company for an Order (Construction subscription).


 
isRequired
boolean
 Default:  false
Whether a performance bond is required. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
isReceived
boolean
 Default:  false
Whether a performance bond was received. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
amount
string <decimal-precision-2> 
Amount of the performance bond (Construction subscription).


 
 Example:  "1000.00"
object
Vendor for the related surety company providing the performance bond (Construction subscription).


 
key
string
System-assigned key for the vendor  (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the vendor (Construction subscription).


 
 Example:  "VND-IND-0081"
name
string
User-specified name for the vendor (Construction subscription).


 
 Example:  "Vendor-India-0081"
object
Payment bond details from the vendor or a company for an Order (Construction subscription).


 
isRequired
boolean
 Default:  false
Whether a payment bond is required. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
isReceived
boolean
 Default:  false
Whether a payment bond was received. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
amount
string <decimal-precision-2> 
Amount of the payment bond (Construction subscription).


 
 Example:  "1000.00"
object
Vendor for the related surety company providing the payment bond (Construction subscription).


 
key
string
System-assigned key for the vendor (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the vendor (Construction subscription).


 
 Example:  "VND-IND-0081"
name
string
User-specified name for the vendor (Construction subscription).


 
 Example:  "Vendor-India-0081"
object
Revision details post Change Order (Construction subscription).


 
changeLogNumber
number
Log number for tracking the number of changes applied to a source transaction. Default 0 for a source transaction, 1 for a change transaction (Construction subscription).


 
 Example:  1
postedChangesTotal
string <decimal-precision-2> 
Posted changes total (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing details for the Order or Invoice (Construction subscription).


 
externalReferenceNumber
string
Project contract external reference (Construction subscription).


 
 Example:  "HGS-1024"
description
string
Project contract description (Construction subscription).


 
 Example:  "Construction of clubhouse and offices"
contractDate
string <date> 
Project contract date (Construction subscription).


 
 Example:  "2024-05-08"
billingThroughDate
string <date> 
Billing through date (Construction subscription).


 
 Example:  "2024-05-08"
billingApplicationNumber
string  <= 100 characters 
Billing application number (Construction subscription).


 
 Example:  "IA-89115"
object
Project contract billing summary details for the Order or Invoice (Construction subscription).


 
originalContractAmount
string <decimal-precision-10> 
Original contract amount (Construction subscription).


 
 Example:  "1000.00"
lessPriorApplicationAmount
string <decimal-precision-10> 
Less previous billings amount (Construction subscription).


 
 Example:  "1000.00"
object
Retainage details for the Invoice (Construction subscription).


 
previousBalanceAmount
string <decimal-precision-10> 
Previous retainage balance amount (Construction subscription).


 
 Example:  "1000.00"
completedAmount
string <decimal-precision-10> 
Retainage amount from completed work (Construction subscription).


 
 Example:  "1000.00"
storedMaterialsAmount
string <decimal-precision-10> 
Retainage amount from stored materials (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing summary totals on the Invoice (Construction subscription).


 
object
Project contract billing totals approved for the prior month on the Invoice (Construction subscription).


 
additionsAmount
string <decimal-precision-10> 
Total additions amount approved in prior months (Construction subscription).


 
 Example:  "1000.00"
deductionsAmount
string <decimal-precision-10> 
Total deductions amount approved in prior months (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing totals approved for the current month on the Invoice (Construction subscription).


 
additionsAmount
string <decimal-precision-10> 
Total additions amount approved this month (Construction subscription).


 
 Example:  "1000.00"
deductionsAmount
string <decimal-precision-10> 
Total deductions amount approved this month (Construction subscription).


 
 Example:  "1000.00"
object
Reference to an project contract architect contact (Construction subscription).


 
key
string
System-assigned key for the contact (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the contact (Construction subscription).


 
 Example:  "Eberhardt"
object
Reference to the project contract (Construction subscription).


 
key
string
System-assigned key for the project contract (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the project contract (Construction subscription).


 
 Example:  "BTI-01"
object
Contacts associated with the Order Entry document.


 
object
Primary contact


 
id
string
Identifier for the primary contact.


 
 Example:  "contact"
object
Ship-to contact.


 
id
string
Identifier for the ship-to contact.


 
 Example:  "contact"
object
Bill-to contact.


 
id
string
Identifier for the bill-to contact.


 
 Example:  "contact"
object
Shipping method for the order.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "77"
id
string
Identifier for the shipping method.


 
 Example:  "Air"
href
string
URL for the shipping method.


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
object
Transaction definition that is associated with this transaction.


 
key
string
System-assigned key for the transaction definition.


 
 Example:  "11"
id
string
Name for the Order Entry transaction definition.


 
 Example:  "Sales Invoice"
object
Parent/Source document


 
key
string
System-assigned key for the Order Entry document.


 
 Example:  "44"
id
string
The source transaction from which the Order Entry document was created.


 
 Example:  "Sales Order-SO0022"
object
Customer associated with the Order Entry document.


 
 Example:  "IBN"
id
required
string
Customer ID


 
 Example:  "customer"
key
string
System-assigned key for the customer.


 
 Example:  "15"
name
string
IA.CUSTOMER_NAME


 
 Example:  "Grove Apartments"
object
Contract associated with the Order Entry document.


 
key
string
System-assigned key for the contract.


 
 Example:  "46"
id
string
ID of the contract.


 
 Example:  "CNRT1001"
object
Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
System-assigned key for the AR term.


 
 Example:  "75"
id
string
The name of AR term.


 
 Example:  "10 Days"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "44"
id
string
ID for the tax solution.


 
 Example:  "Avalara"
taxCalculationMethod
string or null
 Default:  null
Calculation method used for the tax solution.


 Enum: "VAT" "advancedTax" "avaTax" "noTax" null "simpleTax"  
 Example:  "noTax"
Array of objects
Lines of the Order Entry document.


 
 Array 
unit
required
string
Unit associated with this document line item.


 
 Example:  "Each"
unitQuantity
required
string <decimal-precision-10> 
Unit quantity associated with this document line item.


 
 Example:  "10.10"
unitPrice
required
string <decimal-precision-10> 
Unit price associated with this line item.


 
 Example:  "10.50"
object
Item associated with the document line.


 
object
Alternative name for the Item for a specific customer.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
priceCalculationMemo
string
Memo about price calculation used for the document line item.


 
 Example:  "Fair value price list"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
multiplier
number
Multiplier


 
 Example:  1
object
Parent/Source document


 
object
Parent/Source document line that needs to be converted.


 
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
discountMemo
string
Discount memo for any discounts taken.


 
 Example:  "Festival discount"
isBillable
boolean
 Default:  true
Indicates whether the line is billable.


 
 Example:  true
taxRate
string <decimal-precision-2> 
Tax rate for the document line item.


 
 Example:  "10.05"
discount
string <decimal-precision-2> 
Discount applied to the line item.


 
 Example:  "10.25"
enableTax
boolean
 Default:  false
Indicates whether the line item is taxable.


 
 Example:  false
conversionType
string
 Default:  "quantity"
Conversion type used for the transaction.


 Enum: "price" "quantity"  
 Example:  "quantity"
object
 
 Example:  "{ \"item\": { \"id\": \"1\" }, \"warehouse\": { \"id\": \"1\" }, \"location\": { \"id\": \"1\" }}"
object
The template used for renewal schedules.


 
revenueRecognitionStartDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule ends.


 
 Example:  "2023-04-04"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
shipByDate
string <date> 
The date the goods should be shipped so they arrive when the customer needs them.


 
 Example:  "2023-04-04"
pickTicketPrintedDate
string <date> 
The date on which the pick ticket is printed.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
allowDropship
boolean
 Default:  false
Indicates whether dropship is allowed for the line.


 
 Example:  true
allowBuyToOrder
boolean
 Default:  false
Indicates whether buy-to-order is allowed for the line.


 
 Example:  true
object
Line-level revised details post Change Order (Construction subscription).


 
object
Line-level draft details post Change Order (Construction subscription).


 
object
Line-level posted details post Change Order (Construction subscription).


 
servicePeriodStartDate
string or null <date> 
Service period start date.


 
 Example:  "2022-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


 
 Example:  "2022-04-30"
object
Line-level project contract billing details (Construction subscription).


 
object
Line-level retainage details (Construction subscription).


 
isReverseConversion
boolean
 Default:  false
Whether the entry is reverse converted (Construction subscription).


 
 Example:  false
object
Line-level reverse conversion details (Construction subscription).


 
object
Reference to the source transaction when creating a change order (Construction subscription).


 
object
Reference to the source transaction line when creating a change order (Construction subscription).


 
object
Reference to the project contract (Construction subscription).


 
object
Reference to the specific project contract line (Construction subscription).


 
object
In tax enabled companies tax schedule used to capture tax details in the sales transaction (Construction subscription).


 
object
Contacts for delivering the buy-to-order.


 
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row per item.


 
object
Header lever details for the document line items.


 
Array of objects
Lines of the Order Entry document subtotal.


 
 Array 
description
string
Description about the subtotal.


 
 Example:  "Tax"
percentValue
string <decimal-precision-10> 
Percentage value that is calculated on the total of all line items of the document.


 
 Example:  "10.50"
txnAbsoluteValue
string <decimal-precision-2> 
Non negative transaction amount calculated across all other lines of the document.


 
 Example:  "44.78"
object
 
Array of objects
Lines of the Order Entry document history.


 
 Array 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "customer": {
    • "id": "1"
    },
  • "state": "submitted",
  • "txnDate": "2023-11-01",
  • "dueDate": "2024-12-12",
  • "txnCurrency": "USD",
  • "baseCurrency": "USD",
  • "lines": [
    • {
      • "dimensions": {
        },
      • "unit": "Each",
      • "unitQuantity": "1",
      • "unitPrice": "650"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "13977",
    • "id": "Sales Invoice-SUBINV#0193#doc",
    • "documentType": "Sales Invoice",
    • "href": "/objects/order-entry/document::Sales%20Invoice/469"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a named order entry document
get/objects/order-entry/document::{documentName}/{key}
Returns detailed information for a specified order entry document. For example, to return details about an order entry document that uses the Sales Invoice transaction definition as a template, specify Sales Invoice for the documentName in the request URL.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned key for the order entry document.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "453",
    • "documentNumber": "SUBINV#0182#doc",
    • "id": "Sales Invoice-SUBINV#0182#doc",
    • "sourceDocument": {
      • "id": "Sales Order-SO0026",
      • "key": "451",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry/document::Sales Order/451"
      },
    • "state": "pending",
    • "txnDate": "2023-03-29",
    • "audit": {
      • "createdDateTime": "2023-11-10T18:36:30Z",
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2023-11-10T18:36:32Z"
      },
    • "entity": {
      • "key": "46",
      • "id": "CORP",
      • "name": "Corp",
      • "href": "/objects/company-config/entity/46"
      },
    • "status": "active",
    • "dueDate": "2024-10-28",
    • "documentType": "Sales Invoice",
    • "txnDefinition": {
      • "id": "Sales Invoice",
      • "key": "188",
      • "href": "/objects/order-entry-txn-definition::Sales%20Invoice/188"
      },
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        }
      },
    • "isPrinted": false,
    • "isBackordered": false,
    • "subtotal": "750.66",
    • "total": "742.54",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2023-03-29",
      • "rate": "1"
      },
    • "subtotalInTxnCurrency": "750.55",
    • "totalInTxnCurrency": "742.5",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2023-03-29",
    • "paymentStatus": "open",
    • "customer": {
      • "key": "1",
      • "id": "1",
      • "name": "Power Aerospace Materials",
      • "href": "/objects/accounts-receivable/customer/1"
      },
    • "lines": [
      • {
        }
      ],
    • "history": [
      • {
        },
      • {
        }
      ],
    • "subtotals": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "href": "/objects/order-entry/document::Sales%20Invoice/453"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an order entry document
patch/objects/order-entry/document::{documentName}/{key}
Updates an existing order entry document by setting field values. Any fields not provided remain unchanged. With Edit permissions to order entry transactions, most details for a transaction that has a state of Draft or Pending can be edited.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned key for the order entry document.


 
Request Body schema: application/json
documentNumber
string
Document number for the order entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction.


 
 Example:  "SI-O122"
state
string
 Default:  "pending"
State of the order entry document.


 Enum: "approved" "closed" "converted" "convertedByLine" "declined" "draft" "exception" "inProgress" "partiallyApproved" "partiallyConverted" "partiallyConvertedByLine" "pending" "submitted"  
 Example:  "draft"
baseCurrency
string
Base currency for the transaction.


 
 Example:  "USD"
txnCurrency
string
Currency used for the transaction.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date for this transaction. Can be the current date, the date the transaction was issued, or the date the transaction will be paid.


 
 Example:  "2021-01-23"
rate
string <decimal-precision-10> 
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  "1.0789"
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "1"
typeName
string
The name of exchange rate type.


 
 Example:  "Intacct Daily Rate"
txnDate
string <date> 
Date on the document.


 
 Example:  "2023-04-04"
dueDate
string <date> 
Due date for the document.


 
 Example:  "2023-04-04"
postingDate
string <date> 
The date on which the order entry document posts to the General Ledger.


 
 Example:  "2023-04-04"
referenceNumber
string
Reference number for the document.


 
 Example:  "SALES-100"
notes
string
Notes about the document.


 
 Example:  "Fast order"
memo
string
Text printed on the document.


 
 Example:  "Lowry solutions"
contractID
string
Sales contract ID associated with the transaction.


 
 Example:  "CN100123"
contractDescription
string
Sales contract description.


 
 Example:  "Sales & Service"
invoiceDate
string <date> 
Original invoice date.


 
 Example:  "2023-04-04"
customerPONumber
string
Customer PO number associated with the transaction.


 
 Example:  "ABOTT-1001"
trackingNumber
string
User-provided tracking reference number.


 
 Example:  "TK-1002"
shipByDate
string <date> 
The ship-by date for the order.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
serviceDeliveryDate
string <date> 
The date on which the service is delivered.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
retainagePercent
number
Default retainage percent on the line item for a transaction (Construction subscription).


 
 Example:  10
scope
string  <= 4000 characters 
Details about the expected scope of work to be performed or materials to be delivered. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Subcontractor agrees to provide labor and materials for utility trenching for Five Oaks Storage facilities according to contract."
inclusions
string  <= 4000 characters 
Details related to items that are explicitly included in the terms of this document. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Includes drive through building"
exclusions
string  <= 4000 characters 
Details related to items that are explicitly excluded in the terms of this document. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Excludes additional purchase"
terms
string  <= 4000 characters 
Additional terms or performance obligations. Use 4000 or fewer characters. (Construction subscription).


 
 Example:  "Follow all safety rules and security procedure that are in force and applicable during execution of work."
object
Additional details for Quote or Requisition and Order type documents (Construction Subscription).


 
scheduledStartDate
string <date> 
Scheduled start date in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-05-07"
scheduledCompletionDate
string <date> 
Original scheduled date for completion of the work in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-07"
actualStartDate
string <date> 
Actual start date in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-05-07"
actualCompletionDate
string <date> 
Date the work is actually complete in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
revisedCompletionDate
string <date> 
Revised completion date for the work (caused by changes). Specified in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-11-01"
substantialCompletionDate
string <date> 
Date the work is considered substantially complete in the yyyy-mm-dd format. Typically used as a milestone to identify when payment obligations are due. (Construction subscription).


 
 Example:  "2024-10-10"
noticeToProceedDate
string <date> 
Date when a formal notice to proceed was given in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
responseDueDate
string <date> 
Date when a response is expected from an external party in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
executedOnDate
string <date> 
Date the related contract document was formally executed in the yyyy-mm-dd format (Construction subscription).


 
 Example:  "2024-10-10"
scheduleImpactNotes
string  <= 100 characters 
Details about any impacts on the current schedule. Use 100 or fewer characters. (Construction subscription).


 
 Example:  "None"
object
 
referenceNumber
string
Reference number


 
 Example:  "INT-01"
object
Initiated by


 
key
string
Employee key


 
 Example:  "2"
id
string
Employee id


 
 Example:  "dhatchet"
object
Verbal approval by


 
key
string
Employee key


 
 Example:  "2"
id
string
Employee id


 
 Example:  "sdye"
object
Issued by


 
key
string
Employee key


 
 Example:  "25"
id
string
Employee id


 
 Example:  "amarquess"
issuedOnDate
string <date> 
Issued on date


 
 Example:  "2021-05-30"
object
Approved by


 
key
string
Employee key


 
 Example:  "1"
id
string
Employee id


 
 Example:  "treser"
approvedOnDate
string <date> 
Approved on date


 
 Example:  "2021-10-02"
object
Signed by


 
key
string
Employee key


 
 Example:  "32"
id
string
Employee id


 
 Example:  "broberts"
signedOnDate
string <date> 
Signed on date


 
 Example:  "2021-05-31"
source
string
Internal source


 
 Example:  "Internal"
sourceReferenceNumber
string
Internal source reference number


 
 Example:  "REF-INT-01"
object
 
referenceNumber
string
External reference number


 
 Example:  "A23"
object
Verbal approval by


 
key
string
Contact key


 
 Example:  "6"
id
string
Contact name


 
 Example:  "Johnson"
object
Approved by


 
key
string
Contact key


 
 Example:  "51"
id
string
Contact name


 
 Example:  "Jagadish"
approvedOnDate
string <date> 
Approved on date


 
 Example:  "2021-11-03"
object
Signed by


 
key
string
Contact key


 
 Example:  "200"
id
string
Contact name


 
 Example:  "Modulus Industries"
signedOnDate
string <date> 
Signed on date


 
 Example:  "2021-12-01"
object
Performance bond details from the vendor or a company for an Order (Construction subscription).


 
isRequired
boolean
 Default:  false
Whether a performance bond is required. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
isReceived
boolean
 Default:  false
Whether a performance bond was received. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
amount
string <decimal-precision-2> 
Amount of the performance bond (Construction subscription).


 
 Example:  "1000.00"
object
Vendor for the related surety company providing the performance bond (Construction subscription).


 
key
string
System-assigned key for the vendor  (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the vendor (Construction subscription).


 
 Example:  "VND-IND-0081"
name
string
User-specified name for the vendor (Construction subscription).


 
 Example:  "Vendor-India-0081"
object
Payment bond details from the vendor or a company for an Order (Construction subscription).


 
isRequired
boolean
 Default:  false
Whether a payment bond is required. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
isReceived
boolean
 Default:  false
Whether a payment bond was received. false is No (default) and true is Yes (Construction subscription).


 
 Example:  false
amount
string <decimal-precision-2> 
Amount of the payment bond (Construction subscription).


 
 Example:  "1000.00"
object
Vendor for the related surety company providing the payment bond (Construction subscription).


 
key
string
System-assigned key for the vendor (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the vendor (Construction subscription).


 
 Example:  "VND-IND-0081"
name
string
User-specified name for the vendor (Construction subscription).


 
 Example:  "Vendor-India-0081"
object
Revision details post Change Order (Construction subscription).


 
changeLogNumber
number
Log number for tracking the number of changes applied to a source transaction. Default 0 for a source transaction, 1 for a change transaction (Construction subscription).


 
 Example:  1
postedChangesTotal
string <decimal-precision-2> 
Posted changes total (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing details for the Order or Invoice (Construction subscription).


 
externalReferenceNumber
string
Project contract external reference (Construction subscription).


 
 Example:  "HGS-1024"
description
string
Project contract description (Construction subscription).


 
 Example:  "Construction of clubhouse and offices"
contractDate
string <date> 
Project contract date (Construction subscription).


 
 Example:  "2024-05-08"
billingThroughDate
string <date> 
Billing through date (Construction subscription).


 
 Example:  "2024-05-08"
billingApplicationNumber
string  <= 100 characters 
Billing application number (Construction subscription).


 
 Example:  "IA-89115"
object
Project contract billing summary details for the Order or Invoice (Construction subscription).


 
originalContractAmount
string <decimal-precision-10> 
Original contract amount (Construction subscription).


 
 Example:  "1000.00"
lessPriorApplicationAmount
string <decimal-precision-10> 
Less previous billings amount (Construction subscription).


 
 Example:  "1000.00"
object
Retainage details for the Invoice (Construction subscription).


 
previousBalanceAmount
string <decimal-precision-10> 
Previous retainage balance amount (Construction subscription).


 
 Example:  "1000.00"
completedAmount
string <decimal-precision-10> 
Retainage amount from completed work (Construction subscription).


 
 Example:  "1000.00"
storedMaterialsAmount
string <decimal-precision-10> 
Retainage amount from stored materials (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing summary totals on the Invoice (Construction subscription).


 
object
Project contract billing totals approved for the prior month on the Invoice (Construction subscription).


 
additionsAmount
string <decimal-precision-10> 
Total additions amount approved in prior months (Construction subscription).


 
 Example:  "1000.00"
deductionsAmount
string <decimal-precision-10> 
Total deductions amount approved in prior months (Construction subscription).


 
 Example:  "1000.00"
object
Project contract billing totals approved for the current month on the Invoice (Construction subscription).


 
additionsAmount
string <decimal-precision-10> 
Total additions amount approved this month (Construction subscription).


 
 Example:  "1000.00"
deductionsAmount
string <decimal-precision-10> 
Total deductions amount approved this month (Construction subscription).


 
 Example:  "1000.00"
object
Reference to an project contract architect contact (Construction subscription).


 
key
string
System-assigned key for the contact (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the contact (Construction subscription).


 
 Example:  "Eberhardt"
object
Reference to the project contract (Construction subscription).


 
key
string
System-assigned key for the project contract (Construction subscription).


 
 Example:  "1"
id
string
Unique identifier for the project contract (Construction subscription).


 
 Example:  "BTI-01"
object
Contacts associated with the Order Entry document.


 
object
Primary contact


 
id
string
Identifier for the primary contact.


 
 Example:  "contact"
object
Ship-to contact.


 
id
string
Identifier for the ship-to contact.


 
 Example:  "contact"
object
Bill-to contact.


 
id
string
Identifier for the bill-to contact.


 
 Example:  "contact"
object
Shipping method for the order.


 
key
string
System-assigned key for the shipping method.


 
 Example:  "77"
id
string
Identifier for the shipping method.


 
 Example:  "Air"
href
string
URL for the shipping method.


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
object
Transaction definition that is associated with this transaction.


 
key
string
System-assigned key for the transaction definition.


 
 Example:  "11"
id
string
Name for the Order Entry transaction definition.


 
 Example:  "Sales Invoice"
object
Parent/Source document


 
key
string
System-assigned key for the Order Entry document.


 
 Example:  "44"
id
string
The source transaction from which the Order Entry document was created.


 
 Example:  "Sales Order-SO0022"
object
Customer associated with the Order Entry document.


 
key
string
System-assigned key for the customer.


 
 Example:  "15"
id
string
Customer ID


 
 Example:  "customer"
name
string
IA.CUSTOMER_NAME


 
 Example:  "Grove Apartments"
object
Contract associated with the Order Entry document.


 
key
string
System-assigned key for the contract.


 
 Example:  "46"
id
string
ID of the contract.


 
 Example:  "CNRT1001"
object
Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
System-assigned key for the AR term.


 
 Example:  "75"
id
string
The name of AR term.


 
 Example:  "10 Days"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "44"
id
string
ID for the tax solution.


 
 Example:  "Avalara"
taxCalculationMethod
string or null
 Default:  null
Calculation method used for the tax solution.


 Enum: "VAT" "advancedTax" "avaTax" "noTax" null "simpleTax"  
 Example:  "noTax"
Array of objects
Lines of the Order Entry document.


 
 Array 
object
Item associated with the document line.


 
object
Alternative name for the Item for a specific customer.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
priceCalculationMemo
string
Memo about price calculation used for the document line item.


 
 Example:  "Fair value price list"
unit
string
Unit associated with this document line item.


 
 Example:  "Each"
unitQuantity
string <decimal-precision-10> 
Unit quantity associated with this document line item.


 
 Example:  "10.10"
unitPrice
string <decimal-precision-10> 
Unit price associated with this line item.


 
 Example:  "10.50"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
discountPercent
string <decimal-precision-10> 
Discount percentage for the document line item.


 
 Example:  "10.50"
multiplier
number
Multiplier


 
 Example:  1
object
Parent/Source document


 
object
Parent/Source document line that needs to be converted.


 
isPriceProrated
boolean
 Default:  true
Indicates whether the price is prorated.


 
 Example:  true
discountMemo
string
Discount memo for any discounts taken.


 
 Example:  "Festival discount"
isBillable
boolean
 Default:  true
Indicates whether the line is billable.


 
 Example:  true
taxRate
string <decimal-precision-2> 
Tax rate for the document line item.


 
 Example:  "10.05"
discount
string <decimal-precision-2> 
Discount applied to the line item.


 
 Example:  "10.25"
enableTax
boolean
 Default:  false
Indicates whether the line item is taxable.


 
 Example:  false
conversionType
string
 Default:  "quantity"
Conversion type used for the transaction.


 Enum: "price" "quantity"  
 Example:  "quantity"
object
 
object
The template used for renewal schedules.


 
revenueRecognitionStartDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the either revenue recognition schedule and/or renewal schedule ends.


 
 Example:  "2023-04-04"
requestedShippingDate
string <date> 
The date the customer requests the goods to arrive on their premises. The default is the due date.


 
 Example:  "2023-04-04"
shipByDate
string <date> 
The date the goods should be shipped so they arrive when the customer needs them.


 
 Example:  "2023-04-04"
pickTicketPrintedDate
string <date> 
The date on which the pick ticket is printed.


 
 Example:  "2023-04-04"
cancelAfterDate
string <date> 
Indicates the date after which the order can be canceled.


 
 Example:  "2023-04-04"
doNotShipBeforeDate
string <date> 
Do not ship before this date.


 
 Example:  "2023-04-04"
doNotShipAfterDate
string <date> 
Do not ship after this date.


 
 Example:  "2023-04-04"
shippedDate
string <date> 
The date that the order was shipped.


 
 Example:  "2023-04-04"
allowDropship
boolean
 Default:  false
Indicates whether dropship is allowed for the line.


 
 Example:  true
allowBuyToOrder
boolean
 Default:  false
Indicates whether buy-to-order is allowed for the line.


 
 Example:  true
object
Line-level revised details post Change Order (Construction subscription).


 
object
Line-level draft details post Change Order (Construction subscription).


 
object
Line-level posted details post Change Order (Construction subscription).


 
servicePeriodStartDate
string or null <date> 
Service period start date.


 
 Example:  "2022-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


 
 Example:  "2022-04-30"
object
Line-level project contract billing details (Construction subscription).


 
object
Line-level retainage details (Construction subscription).


 
isReverseConversion
boolean
 Default:  false
Whether the entry is reverse converted (Construction subscription).


 
 Example:  false
object
Line-level reverse conversion details (Construction subscription).


 
object
Reference to the source transaction when creating a change order (Construction subscription).


 
object
Reference to the source transaction line when creating a change order (Construction subscription).


 
object
Reference to the project contract (Construction subscription).


 
object
Reference to the specific project contract line (Construction subscription).


 
object
In tax enabled companies tax schedule used to capture tax details in the sales transaction (Construction subscription).


 
object
Contacts for delivering the buy-to-order.


 
Array of objects
List of warehouse inventory details including serial number, aisle, bin, and row per item.


 
object
Header lever details for the document line items.


 
Array of objects
Lines of the Order Entry document subtotal.


 
 Array 
description
string
Description about the subtotal.


 
 Example:  "Tax"
percentValue
string <decimal-precision-10> 
Percentage value that is calculated on the total of all line items of the document.


 
 Example:  "10.50"
txnAbsoluteValue
string <decimal-precision-2> 
Non negative transaction amount calculated across all other lines of the document.


 
 Example:  "44.78"
object
 
Array of objects
Lines of the Order Entry document history.


 
 Array 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "referenceNumber": "1012",
  • "lines": [
    • {
      • "dimensions": {
        },
      • "item": {
        },
      • "unit": "10 Pack"
      },
    • {
      • "key": "22",
      • "unitQuantity": "9",
      • "price": "750"
      },
    • {
      • "key": "59",
      • "ia::operation": "delete"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "52",
    • "id": "Sales Invoice-SUBINV#0182#doc",
    • "documentType": "Sales Invoice",
    • "href": "/objects/order-entry/document::Sales%20Invoice/52"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an order entry document
delete/objects/order-entry/document::{documentName}/{key}
Deletes an order entry document. Several factors determine whether an order entry document can be deleted. See Order Entry transactions in the Sage Intacct Help Center for more information.


SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
key
required
string
System-assigned key for the order entry document.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query documents
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "order-entry/document"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}