Documents

A purchasing document contains information about purchasing transactions. A purchasing transaction can be a purchase requisition, purchase order, receipt, vendor 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 Add a purchase transaction in the Sage Intacct Help Center for more information.

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 purchasing documents

get/objects/purchasing/document

Returns a collection with a key, ID, and link for each purchasing 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
SubscriptionPurchasing
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Purchasing documents
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "73",
      • "id": "Vendor Invoice-Po-0204-Rec",
      • "href": "/objects/purchasing/document::Vendor%20Invoice/73"
      },
    • {
      • "key": "76",
      • "id": "PO Receiver Invoice-Po-0205-Rec",
      • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/76"
      },
    • {
      • "key": "77",
      • "id": "PO Receiver Invoice-Po-0206-Rec",
      • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/77"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a purchasing document
get/objects/purchasing/document/{key}
Returns detailed information for a specified purchasing document.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1428",
    • "documentNumber": "POIR-003",
    • "id": "PO Receiver Invoice-POIR-003",
    • "sourceDocument": {
      • "id": "Purchase Order-PO-00063",
      • "key": "1293",
      • "documentType": "Purchase Order",
      • "href": "/objects/purchasing/document::Purchase%20Order/1293"
      },
    • "state": "pending",
    • "txnDate": "2024-06-01",
    • "audit": {
      • "createdDateTime": "2024-10-03T23:08:54Z",
      • "createdBy": "39",
      • "modifiedBy": "39",
      • "modifiedDateTime": "2024-10-03T23:08:57Z"
      },
    • "dueDate": "2024-07-01",
    • "referenceNumber": "Sales Order-SO-00173",
    • "vendorDocumentNumber": null,
    • "documentType": "PO Receiver Invoice",
    • "txnDefinition": {
      • "id": "PO Receiver Invoice",
      • "key": "258",
      • "href": "/objects/purchasing/txn-definition::PO%20Receiver%20Invoice/258"
      },
    • "paymentTerm": {
      • "key": "4",
      • "id": "NET30",
      • "href": "/objects/accounts-payable/term/4"
      },
    • "notes": null,
    • "shippingMethod": {
      • "key": null,
      • "id": null
      },
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        },
      • "deliverTo": {
        }
      },
    • "memo": "For MetroBank21 customers.",
    • "isPrinted": false,
    • "isBackordered": false,
    • "subtotal": "1875.00",
    • "total": "1875.00",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2025-03-29",
      • "rate": "1.0000000000"
      },
    • "subtotalInTxnCurrency": "1875.00",
    • "totalInTxnCurrency": "1875.00",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2024-06-01",
    • "taxSolution": {
      • "key": null,
      • "id": null,
      • "showMultilineTax": null,
      • "taxCalculationMethod": null
      },
    • "retainagePercent": null,
    • "paymentStatus": "selected",
    • "requestedShippingDate": null,
    • "doNotShipBeforeDate": null,
    • "doNotShipAfterDate": null,
    • "promisedDate": null,
    • "contractStartDate": null,
    • "contractEndDate": null,
    • "cancelAfterDate": null,
    • "vendor": {
      • "key": "510",
      • "id": "V-00006",
      • "href": "/objects/accounts-payable/vendor/510"
      },
    • "lines": [
      • {
        }
      ],
    • "history": [
      • {
        },
      • {
        }
      ],
    • "subtotals": [ ],
    • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/1428"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
List named purchasing documents
get/objects/purchasing/document::{documentName}
Returns a collection with a key, ID, and link for each purchasing document with the specified name.
For example, to list all documents that are based on the Purchase Order transaction definition, specify Purchase Order 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



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing 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": "1157",
      • "id": "Purchase Order-PO-00037",
      • "href": "/objects/purchasing/document::Purchase%20Order/1157"
      },
    • {
      • "key": "1158",
      • "id": "Purchase Order-PO-00038",
      • "href": "/objects/purchasing/document::Purchase%20Order/1158"
      },
    • {
      • "key": "1159",
      • "id": "Purchase Order-PO-00039",
      • "href": "/objects/purchasing/document::Purchase%20Order/1159"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a purchasing document
post/objects/purchasing/document::{documentName}
Creates a new purchasing document. To create a new purchasing 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 purchasing document that uses the Purchase Requisition transaction definition as a template, specify Purchase Requisition for the documentName in the request URL.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


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


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


 
 Example:  "PO-O122"
state
string
 Default:  "pending"
State of the purchasing document.


 Enum: "analyzing" "approved" "closed" "converted" "declined" "draft" "exception" "inProgress" "partiallyApproved" "partiallyConverted" "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:  "2024-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 purchasing document.


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


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


 
 Example:  "PURCHASE-100"
vendorDocumentNumber
string
The number by which to reference a bill or other vendor document. A number is required only if Accounts Payable is configured to require numbers on bills, adjustments, and recurring bills.


 
 Example:  "A2330-12"
notes
string
Notes about the purchasing document.


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


 
 Example:  "Lowry solutions"
cancelAfterDate
string <date> 
Indicates the date after which the transaction should be be canceled.


 
 Example:  "2024-05-04"
doNotShipBeforeDate
string <date> 
The date before which goods cannot be shipped.


 
 Example:  "2024-04-04"
doNotShipAfterDate
string <date> 
The date after which goods cannot be shipped.


 
 Example:  "2024-05-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-12"
promisedDate
string <date> 
The date the vendor promised to deliver the goods.


 
 Example:  "2024-04-08"
contractStartDate
string <date> 
Valid start date of a purchase order or purchase contract.


 
 Example:  "2024-04-04"
contractEndDate
string <date> 
Valid end date of a purchase order or purchase contract.


 
 Example:  "2024-05-04"
retainagePercent
string <decimal-precision-2> 
Default retainage percentage.


 
 Example:  "50.10"
object
Contacts associated with the purchasing document.


 
object
Primary contact for the purchasing document.


 
id
string
Unique ID for the primary contact.


 
 Example:  "Main contact"
object
Contact to ship to.


 
id
string
Unique ID for the contact to ship to.


 
 Example:  "shipping contact"
object
Contact to bill to.


 
id
string
Unique ID for the contact to bill to.


 
 Example:  "Main billing contact"
object
Contact to deliver to.


 
id
string
Unique ID for the contact to deliver to.


 
 Example:  "Main deliver-to contact"
object
Shipping method for the order.


 
key
string
Unique key for the shipping method.


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


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


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
object
Accounts Payable (AP) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
Unique key for the AP term.


 
 Example:  "75"
id
string
Unique ID for the AP term.


 
 Example:  "10 Days"
object
Transaction definition that is associated with this transaction.


 
key
string
Unique key for the transaction definition.


 
 Example:  "11"
id
string
Name of the transaction definition.


 
 Example:  "Purchase Invoice"
object
The source transaction from which the purchasing document was created.


 
key
string
Unique key for the source document.


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


 
 Example:  "Purchase Order-PO0022"
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
Unique ID for the tax solution.


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


 Enum: "VAT" "advancedTax" "avaTax" "noTax" null "simpleTax"  
 Example:  "noTax"
object
Vendor associated with the purchasing document.


 
 Example:  "AXN"
id
required
string
Unique ID for the vendor.


 
 Example:  "ALPHA001"
key
string
Unique key for the vendor.


 
 Example:  "15"
name
string
IA.VENDOR_NAME


 
 Example:  "ALPH Apartments"
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"
Array of objects
Lines of the purchasing 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.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
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
Parent/Source document


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


 
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\" }}"
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"
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"
deliveryDueDate
string <date> 
Promised by date


 
 Example:  "2023-04-04"
orderConfirmationDate
string <date> 
Date confirmed


 
 Example:  "2023-04-04"
object
Transaction allocation template for the line item, which distributes the amount across specified dimensions.


 
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 purchasing 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 purchasing document history.


 
 Array 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "vendor": {
    • "id": "V-00013"
    },
  • "txnDate": "2024-03-29",
  • "dueDate": "2024-05-29",
  • "lines": [
    • {
      • "dimensions": {
        },
      • "unit": "Each",
      • "unitQuantity": "1",
      • "unitPrice": "10.10"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1908",
    • "id": "Purchase Requisition-12",
    • "href": "/objects/purchasing/document::Purchase%20Requisition/1908"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a named purchasing document
get/objects/purchasing/document::{documentName}/{key}
Returns detailed information for a specified purchasing document. For example, to return details about a purchasing document that uses the PO Receiver Invoice transaction definition as a template, specify PO Receiver Invoice for the documentName in the request URL.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned unique key for the document.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1428",
    • "documentNumber": "POIR-003",
    • "id": "PO Receiver Invoice-POIR-003",
    • "sourceDocument": {
      • "id": "Purchase Order-PO-00063",
      • "key": "1293",
      • "documentType": "Purchase Order",
      • "href": "/objects/purchasing/document::Purchase%20Order/1293"
      },
    • "state": "pending",
    • "txnDate": "2024-06-01",
    • "audit": {
      • "createdDateTime": "2024-10-03T23:08:54Z",
      • "createdBy": "39",
      • "modifiedBy": "39",
      • "modifiedDateTime": "2024-10-03T23:08:57Z"
      },
    • "dueDate": "2024-07-01",
    • "referenceNumber": "Sales Order-SO-00173",
    • "vendorDocumentNumber": null,
    • "documentType": "PO Receiver Invoice",
    • "txnDefinition": {
      • "id": "PO Receiver Invoice",
      • "key": "258",
      • "href": "/objects/purchasing/txn-definition::PO%20Receiver%20Invoice/258"
      },
    • "paymentTerm": {
      • "key": "4",
      • "id": "NET30",
      • "href": "/objects/accounts-payable/term/4"
      },
    • "notes": null,
    • "shippingMethod": {
      • "key": null,
      • "id": null
      },
    • "contacts": {
      • "primary": {
        },
      • "shipTo": {
        },
      • "billTo": {
        },
      • "deliverTo": {
        }
      },
    • "memo": "For MetroBank21 customers.",
    • "isPrinted": false,
    • "isBackordered": false,
    • "subtotal": "1875.00",
    • "total": "1875.00",
    • "txnCurrency": "USD",
    • "exchangeRate": {
      • "date": "2025-03-29",
      • "rate": "1.0000000000"
      },
    • "subtotalInTxnCurrency": "1875.00",
    • "totalInTxnCurrency": "1875.00",
    • "baseCurrency": "USD",
    • "isSystemGeneratedDocument": false,
    • "postingDate": "2024-06-01",
    • "taxSolution": {
      • "key": null,
      • "id": null,
      • "showMultilineTax": null,
      • "taxCalculationMethod": null
      },
    • "retainagePercent": null,
    • "paymentStatus": "selected",
    • "requestedShippingDate": null,
    • "doNotShipBeforeDate": null,
    • "doNotShipAfterDate": null,
    • "promisedDate": null,
    • "contractStartDate": null,
    • "contractEndDate": null,
    • "cancelAfterDate": null,
    • "vendor": {
      • "key": "510",
      • "id": "V-00006",
      • "href": "/objects/accounts-payable/vendor/510"
      },
    • "lines": [
      • {
        }
      ],
    • "history": [
      • {
        },
      • {
        }
      ],
    • "subtotals": [ ],
    • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/1428"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a purchasing document
patch/objects/purchasing/document::{documentName}/{key}
Updates an existing purchasing document by setting field values. Any fields not provided remain unchanged. With Edit permissions to Purchasing transactions, most details for a transaction that has a state of Draft or Pending can be edited.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned unique key for the document.


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


 
 Example:  "PO-O122"
state
string
 Default:  "pending"
State of the purchasing document.


 Enum: "analyzing" "approved" "closed" "converted" "declined" "draft" "exception" "inProgress" "partiallyApproved" "partiallyConverted" "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:  "2024-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 purchasing document.


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


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


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


 
 Example:  "PURCHASE-100"
vendorDocumentNumber
string
The number by which to reference a bill or other vendor document. A number is required only if Accounts Payable is configured to require numbers on bills, adjustments, and recurring bills.


 
 Example:  "A2330-12"
notes
string
Notes about the purchasing document.


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


 
 Example:  "Lowry solutions"
cancelAfterDate
string <date> 
Indicates the date after which the transaction should be be canceled.


 
 Example:  "2024-05-04"
doNotShipBeforeDate
string <date> 
The date before which goods cannot be shipped.


 
 Example:  "2024-04-04"
doNotShipAfterDate
string <date> 
The date after which goods cannot be shipped.


 
 Example:  "2024-05-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-12"
promisedDate
string <date> 
The date the vendor promised to deliver the goods.


 
 Example:  "2024-04-08"
contractStartDate
string <date> 
Valid start date of a purchase order or purchase contract.


 
 Example:  "2024-04-04"
contractEndDate
string <date> 
Valid end date of a purchase order or purchase contract.


 
 Example:  "2024-05-04"
retainagePercent
string <decimal-precision-2> 
Default retainage percentage.


 
 Example:  "50.10"
object
Contacts associated with the purchasing document.


 
object
Primary contact for the purchasing document.


 
id
string
Unique ID for the primary contact.


 
 Example:  "Main contact"
object
Contact to ship to.


 
id
string
Unique ID for the contact to ship to.


 
 Example:  "shipping contact"
object
Contact to bill to.


 
id
string
Unique ID for the contact to bill to.


 
 Example:  "Main billing contact"
object
Contact to deliver to.


 
id
string
Unique ID for the contact to deliver to.


 
 Example:  "Main deliver-to contact"
object
Shipping method for the order.


 
key
string
Unique key for the shipping method.


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


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


 
 Example:  "/objects/accounts-receivable/shipping-method/77"
object
Accounts Payable (AP) term, which determines the expiration date for quotes and the due date for invoices.


 
key
string
Unique key for the AP term.


 
 Example:  "75"
id
string
Unique ID for the AP term.


 
 Example:  "10 Days"
object
Transaction definition that is associated with this transaction.


 
key
string
Unique key for the transaction definition.


 
 Example:  "11"
id
string
Name of the transaction definition.


 
 Example:  "Purchase Invoice"
object
The source transaction from which the purchasing document was created.


 
key
string
Unique key for the source document.


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


 
 Example:  "Purchase Order-PO0022"
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
Unique ID for the tax solution.


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


 Enum: "VAT" "advancedTax" "avaTax" "noTax" null "simpleTax"  
 Example:  "noTax"
object
Vendor associated with the purchasing document.


 
key
string
Unique key for the vendor.


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


 
 Example:  "ALPHA001"
name
string
IA.VENDOR_NAME


 
 Example:  "ALPH Apartments"
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"
Array of objects
Lines of the purchasing document.


 
 Array 
object
Item associated with the document line.


 
memo
string
Memo about the document line item.


 
 Example:  "Payment ACH"
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"
object
Parent/Source document


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


 
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
 
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"
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"
deliveryDueDate
string <date> 
Promised by date


 
 Example:  "2023-04-04"
orderConfirmationDate
string <date> 
Date confirmed


 
 Example:  "2023-04-04"
object
Transaction allocation template for the line item, which distributes the amount across specified dimensions.


 
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 purchasing 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 purchasing document history.


 
 Array 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "referenceNumber": "PURCHASE-100",
  • "lines": [
    • {
      • "dimensions": {
        },
      • "unit": "10 Pack",
      • "unitQuantity": "8",
      • "multiplier": 1,
      • "unitPrice": "100.0000000000"
      },
    • {
      • "key": "46",
      • "unitQuantity": "11"
      },
    • {
      • "ia::operation": "delete",
      • "key": "44"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "70",
    • "id": "PO Receiver Invoice-Po-0202-Rec",
    • "href": "/objects/purchasing/document::PO%20Receiver%20Invoice/70"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a purchasing document
delete/objects/purchasing/document::{documentName}/{key}
Deletes a purchasing document. Several factors determine whether a purchasing transaction can be deleted. See Purchasing transactions in the Sage Intacct Help Center for more information.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete Purchasing documents







SecurityOAuth2 
Request 
path Parameters
documentName
required
string
Document Name


 
key
required
string
System-assigned unique key for the 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
    }
}
Submit a purchasing document
post/workflows/purchasing/document/submit
Submit a purchasing document


SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned key for the purchasing document.


 
 Example:  "66"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "66"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "66",
    • "id": "Purchase Invoice-PO-O122",
    • "href": "/objects/purchasing/document::Purchase%20Invoice/66",
    • "state": "submitted"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Approve a purchasing document
post/workflows/purchasing/document/approve
Approve a purchasing document


SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned key for the purchasing document.


 
 Example:  "66"
notes
string
Notes or comments about this purchasing document.


 
 Example:  "Approved, ready for use"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "66",
  • "notes": "Approved, ready for use"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "66",
    • "id": "Purchase Invoice-PO-O122",
    • "href": "/objects/purchasing/document::Purchase%20Invoice/66",
    • "state": "approved"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Decline a purchasing document
post/workflows/purchasing/document/decline
Decline a purchasing document


SecurityOAuth2 
Request 
Request Body schema: application/json
key
required
string
System-assigned key for the purchasing document.


 
 Example:  "132"
notes
string
Notes or comments about this purchasing document.


 
 Example:  "Declined, missing information"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "132",
  • "notes": "Declined, missing information"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "66",
    • "id": "Purchase Invoice-PO-O122",
    • "href": "/objects/purchasing/document::Purchase%20Invoice/66",
    • "state": "declined"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "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:  "purchasing/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": "purchasing/document",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "isBackordered",
    • "txnDefinition.id"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "797",
      • "id": "Purchase Order with Back Order-PO-00008-B",
      • "isBackordered": true,
      • "txnDefinition.id": "Purchase Order with Back Order"
      },
    • {
      • "key": "1293",
      • "id": "Purchase Order-PO-00063",
      • "isBackordered": false,
      • "txnDefinition.id": "Purchase Order"
      },
    • {
      • "key": "1395",
      • "id": "Purchase Order-PO-00068",
      • "isBackordered": false,
      • "txnDefinition.id": "Purchase Order"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}