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.

See Transactions - Order Entry in the Sage Intacct Help Center for more information.

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.

Permissions and other requirements
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







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


 
 Example:  446
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": "2024-03-29",
    • "audit": {
      • "createdDateTime": "2024-11-10T18:36:30Z",
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2024-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": "2024-03-29",
      • "rate": "1"
      },
    • "subtotalInTxnCurrency": "750.55",
    • "totalInTxnCurrency": "742.5",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2024-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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







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 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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


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


 
 Example:  "2024-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:  "2023-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 Order Entry document.


 
 Example:  "2024-04-04"
postingDate
string <date> 
The date on which the Order Entry document posts to the General Ledger.


 
 Example:  "2024-04-04"
referenceNumber
string
Reference to another document, as needed.


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


 
 Example:  "Fast order"
memo
string
Text to appear on the printed 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:  "2024-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:  "2024-04-04"
shippedDate
string <date> 
The date that the order was shipped.


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


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


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


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


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


 
 Example:  "2024-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 procedures that are in force and applicable during execution of work."
object
Additional details for Quote, 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 in yyyy-mm-dd format for the work (caused by changes).(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
Set to true if a performance bond is required. (Construction subscription)


 
 Example:  false
isReceived
boolean
 Default:  false
Set to true if a performance bond was received. (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
Unique key for the vendor.


 
 Example:  "11"
id
string
Unique ID for the vendor.


 
 Example:  "VND-IND-0081"
object
Payment bond details from the vendor for an order. (Construction subscription)


 
isRequired
boolean
 Default:  false
Set to true if a payment bond is required.


 
 Example:  false
isReceived
boolean
 Default:  false
Set to true if a payment bond was received. (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.


 
 Example:  "21"
id
string
Unique ID for the vendor.


 
 Example:  "VND-IND-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.


 
 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.


 
 Example:  "HGS-1024"
description
string
Project contract description.


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


 
 Example:  "2024-05-08"
billingThroughDate
string <date> 
Billing through date.


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


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


 
originalContractAmount
string <decimal-precision-10> 
Original contract amount.


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


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


 
previousBalanceAmount
string <decimal-precision-10> 
Previous retainage balance amount.


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


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


 
 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.


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


 
 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.


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


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


 
key
string
Unique key for the contact.


 
 Example:  "1"
id
string
Unique ID for the contact.


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


 
key
string
Unique key for the project contract.


 
 Example:  "1"
id
string
Unique ID for the project contract.


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


 
object
Primary contact for the document.


 
id
string
ID for the primary contact.


 
 Example:  "contact"
object
Ship-to contact for the document.


 
id
string
ID for the ship-to contact.


 
 Example:  "contact"
object
Bill-to contact for the document.


 
id
string
ID for the bill-to contact.


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


 
key
string
Unique key for the shipping method.


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


 
 Example:  "Air"
object
Transaction definition that is associated with the document.


 
key
string
Unique key for the transaction definition.


 
 Example:  "11"
id
string
Name or other unique ID for the transaction definition.


 
 Example:  "Sales Invoice"
object
The source transaction from which the Order Entry document was created.


 
key
string
Unique key for the source document.


 
 Example:  "44"
id
string
Unique ID for the source document.


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


 
 Example:  "IBN"
id
required
string
Unique ID for the customer.


 
 Example:  "customer"
key
string
Unique key for the customer.


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


 
key
string
Unique 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
Unique key for the term.


 
 Example:  "75"
id
string
Name or other unique ID for the 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
Unique key for the tax solution.


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


 
 Example:  "Avalara"
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
This field is only applicable if for companies subscribed to Contracts. This field displays the Multiplier value from the contract line. Defaults to 1 if no Multiplier was used on the contract line.


 
 Example:  1
object
Source Order Entry document.


 
object
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 revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the 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 drop-ship 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:  "2024-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


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


 
object
Line-level retainage details. (Construction subscription)


 
isReverseConversion
boolean
 Default:  false
Indicates whether the document line is reverse converted.


 
 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 a specific project contract line. (Construction subscription)


 
object
In tax-enabled companies, the 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 line subtotal.


 
Array of objects
Lines of the Order Entry document subtotal.


 
 Array 
description
string
Description of the document subtotal.


 
 Example:  "Tax"
percentValue
string <decimal-precision-10> 
Specify a percentage that will be applied to the transaction total. For example, for a restocking fee that's 3 percent of the total transaction, specify 3 in this field.


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


 
 Example:  "44.78"
object
Dimensions associated with the document subtotal.


 
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": "2024-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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the document.


 
 Example:  41
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": "2024-03-29",
    • "audit": {
      • "createdDateTime": "2024-11-10T18:36:30Z",
      • "createdBy": "1",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2024-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": "2024-03-29",
      • "rate": "1"
      },
    • "subtotalInTxnCurrency": "750.55",
    • "totalInTxnCurrency": "742.5",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2024-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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the document.


 
 Example:  41
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:  "2023-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 Order Entry document.


 
 Example:  "2024-04-04"
dueDate
string <date> 
Due date for the Order Entry document.


 
 Example:  "2024-04-04"
postingDate
string <date> 
The date on which the Order Entry document posts to the General Ledger.


 
 Example:  "2024-04-04"
referenceNumber
string
Reference to another document, as needed.


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


 
 Example:  "Fast order"
memo
string
Text to appear on the printed 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:  "2024-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:  "2024-04-04"
shippedDate
string <date> 
The date that the order was shipped.


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


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


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


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


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


 
 Example:  "2024-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 procedures that are in force and applicable during execution of work."
object
Additional details for Quote, 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 in yyyy-mm-dd format for the work (caused by changes).(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
Set to true if a performance bond is required. (Construction subscription)


 
 Example:  false
isReceived
boolean
 Default:  false
Set to true if a performance bond was received. (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
Unique key for the vendor.


 
 Example:  "11"
id
string
Unique ID for the vendor.


 
 Example:  "VND-IND-0081"
object
Payment bond details from the vendor for an order. (Construction subscription)


 
isRequired
boolean
 Default:  false
Set to true if a payment bond is required.


 
 Example:  false
isReceived
boolean
 Default:  false
Set to true if a payment bond was received. (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.


 
 Example:  "21"
id
string
Unique ID for the vendor.


 
 Example:  "VND-IND-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.


 
 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.


 
 Example:  "HGS-1024"
description
string
Project contract description.


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


 
 Example:  "2024-05-08"
billingThroughDate
string <date> 
Billing through date.


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


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


 
originalContractAmount
string <decimal-precision-10> 
Original contract amount.


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


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


 
previousBalanceAmount
string <decimal-precision-10> 
Previous retainage balance amount.


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


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


 
 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.


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


 
 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.


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


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


 
key
string
Unique key for the contact.


 
 Example:  "1"
id
string
Unique ID for the contact.


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


 
key
string
Unique key for the project contract.


 
 Example:  "1"
id
string
Unique ID for the project contract.


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


 
object
Primary contact for the document.


 
id
string
ID for the primary contact.


 
 Example:  "contact"
object
Ship-to contact for the document.


 
id
string
ID for the ship-to contact.


 
 Example:  "contact"
object
Bill-to contact for the document.


 
id
string
ID for the bill-to contact.


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


 
key
string
Unique key for the shipping method.


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


 
 Example:  "Air"
object
Transaction definition that is associated with the document.


 
key
string
Unique key for the transaction definition.


 
 Example:  "11"
id
string
Name or other unique ID for the transaction definition.


 
 Example:  "Sales Invoice"
object
The source transaction from which the Order Entry document was created.


 
key
string
Unique key for the source document.


 
 Example:  "44"
id
string
Unique ID for the source document.


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


 
key
string
Unique key for the customer.


 
 Example:  "15"
id
string
Unique ID for the customer.


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


 
key
string
Unique 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
Unique key for the term.


 
 Example:  "75"
id
string
Name or other unique ID for the 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
Unique key for the tax solution.


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


 
 Example:  "Avalara"
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
This field is only applicable if for companies subscribed to Contracts. This field displays the Multiplier value from the contract line. Defaults to 1 if no Multiplier was used on the contract line.


 
 Example:  1
object
Source Order Entry document.


 
object
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 revenue recognition schedule and/or renewal schedule get started.


 
 Example:  "2023-04-04"
revenueRecognitionEndDate
string <date> 
The date on which the 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 drop-ship 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:  "2024-04-01"
servicePeriodEndDate
string or null <date> 
Service period end date.


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


 
object
Line-level retainage details. (Construction subscription)


 
isReverseConversion
boolean
 Default:  false
Indicates whether the document line is reverse converted.


 
 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 a specific project contract line. (Construction subscription)


 
object
In tax-enabled companies, the 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 line subtotal.


 
Array of objects
Lines of the Order Entry document subtotal.


 
 Array 
description
string
Description of the document subtotal.


 
 Example:  "Tax"
percentValue
string <decimal-precision-10> 
Specify a percentage that will be applied to the transaction total. For example, for a restocking fee that's 3 percent of the total transaction, specify 3 in this field.


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


 
 Example:  "44.78"
object
Dimensions associated with the document subtotal.


 
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.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Order Entry documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document name


 
 Example:  Sales Invoice
key
required
string
System-assigned key for the document.


 
 Example:  41
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
Use the query service to find documents that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}