A recurring document contains the transaction header, line item details, and schedule information that Sage Intacct uses to create recurring transactions. For more information about recurring transactions, see About recurring transactions - Order Entry in the Sage Intacct Help Center.
Returns a collection with a key, ID, and link for each recurring 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.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View Order Entry documents |
OK
Bad Request
{- "ia::result": [
- {
- "key": "2",
- "id": "2",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/2"
}, - {
- "key": "6",
- "id": "6",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/6"
}, - {
- "key": "14",
- "id": "14",
- "href": "/objects/order-entry/recurring-document::Sales%20Order/14"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Returns detailed information for a specified recurring document.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View Order Entry documents |
key required | string System-assigned unique key for the recurring document. Example: 14 |
OK
Bad Request
{- "ia::result": {
- "id": "14",
- "key": "14",
- "txnDefinition": {
- "key": "86",
- "id": "Sales Invoice",
- "href": "/objects/order-entry/txn-definition::Sales%20Invoice/86"
}, - "status": "active",
- "contacts": {
- "primary": {
- "key": "108",
- "id": "CAR(CCAR)"
}, - "shipTo": {
- "key": "108",
- "id": "CAR(CCAR)"
}, - "billTo": {
- "key": "108",
- "id": "CAR(CCAR)"
}
}, - "referenceNumber": "1012",
- "paymentTerm": {
- "key": "5",
- "id": "N15",
- "href": "/objects/accounts-receivable/term/5"
}, - "shippingMethod": {
- "id": "Air",
- "key": "2",
- "href": "/objects/accounts-receivable/shipping-method/2"
}, - "memo": "Recurring subscription",
- "contractId": null,
- "contractDescription": null,
- "notes": null,
- "subtotal": "11001.32000000000000",
- "total": "11611.21000000000000",
- "recurringSchedule": {
- "id": "15",
- "key": "15",
- "href": "/objects/core/schedule/15"
}, - "documentType": "Sales Invoice",
- "schedule": {
- "startDate": "2025-01-18",
- "endDate": null,
- "nextExecutionDate": "2025-01-18",
- "lastExecutionDate": null,
- "recurringDueDate": "2025-01-18",
- "frequency": "weeks",
- "executionCount": "0",
- "repeatCount": null,
- "repeatBy": "weeks",
- "repeatInterval": "4"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "Bernley Technology Inc",
- "href": "/objects/accounts-receivable/customer/22"
}, - "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRate": {
- "date": "2025-08-08",
- "typeName": null,
- "rate": "1.0000000000",
- "typeId": null
}, - "subtotalInTxnCurrency": "11001.32000000000000",
- "totalInTxnCurrency": "11611.21000000000000",
- "state": "active",
- "audit": {
- "createdDateTime": "2024-08-08T09:19:34Z",
- "modifiedDateTime": "2024-08-08T10:46:15Z",
- "createdByUser": {
- "key": "1",
- "href": "/objects/company-config/user/1"
}, - "createdBy": "1",
- "modifiedByUser": {
- "key": "1",
- "href": "/objects/company-config/user/1"
}, - "modifiedBy": "1",
- "customerPONumber": null,
- "entity": {
- "key": null,
- "id": null,
- "name": null
}
}, - "lines": [
- {
- "id": "814",
- "key": "814",
- "recurringDocumentHeader": {
- "id": "14",
- "key": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "lineNumber": 1,
- "item": {
- "key": "15",
- "id": "Car_Battery",
- "href": "/objects/inventory-control/item/15"
}, - "dimensions": {
- "item": {
- "id": "Car_Battery"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}, - "department": {
- "id": "3",
- "key": "3",
- "href": "/objects/company-config/department/3"
}, - "customer": {
- "key": "36",
- "id": "C-00045--MetroAtlantix, Inc.",
- "name": "MetroAtlantix, Inc.",
- "href": "/objects/accounts-receivable/customer/36"
}, - "vendor": {
- "key": "510",
- "id": "V-00006--HPD Inc",
- "name": "HPD Inc",
- "href": "/objects/accounts-payable/vendor/510"
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}
}, - "itemAlias": {
- "key": null,
- "id": null
}, - "unit": "10 Pack",
- "status": "inactive",
- "recurringStatus": "active",
- "unitQuantity": "9.0000000000",
- "isPriceProrated": null,
- "unitPrice": "1000.1200000000",
- "retailPrice": "0.0000000000",
- "discountMemo": null,
- "currency": "USD",
- "priceInTxnCurrency": "1000.1200000000",
- "conversionType": "quantity",
- "enableTax": false,
- "href": "/objects/order-entry/recurring-document-line/814"
}, - {
- "id": "815",
- "key": "815",
- "recurringDocumentHeader": {
- "id": "14",
- "key": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "lineNumber": 2,
- "item": {
- "key": "157",
- "id": "Car_Battery_D",
- "href": "/objects/inventory-control/item/17"
}, - "dimensions": {
- "item": {
- "id": "Car_Battery_D"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}, - "department": {
- "id": "3",
- "key": "3",
- "href": "/objects/company-config/department/3"
}, - "customer": {
- "key": "36",
- "id": "C-00045--MetroAtlantix, Inc.",
- "name": "MetroAtlantix, Inc.",
- "href": "/objects/accounts-receivable/customer/36"
}, - "vendor": {
- "key": "510",
- "id": "V-00006--HPD Inc",
- "name": "HPD Inc",
- "href": "/objects/accounts-payable/vendor/510"
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}
}, - "itemAlias": {
- "key": null,
- "id": null
}, - "unit": "10 Pack",
- "status": "inactive",
- "recurringStatus": "active",
- "unitQuantity": "6.0000000000",
- "isPriceProrated": null,
- "unitPrice": "1500.1200000000",
- "retailPrice": "0.0000000000",
- "discountMemo": null,
- "currency": "USD",
- "priceInTxnCurrency": "1500.1200000000",
- "conversionType": "quantity",
- "enableTax": false,
- "href": "/objects/order-entry/recurring-document-line/815"
}
], - "subtotals": [
- {
- "id": "1627",
- "key": "1627",
- "recurringDocumentHeader": {
- "key": "14",
- "id": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "description": "Sales Discount",
- "absoluteValue": "275.03",
- "percentValue": "2.50",
- "total": "-275.03000000000000",
- "dimensions": {
- "department": {
- "id": "1",
- "key": "2",
- "href": "/objects/company-config/department/2"
}, - "location": {
- "key": "1--Chicago",
- "id": "1",
- "href": "/objects/company-config/location/1--Chicago"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "CAR",
- "href": "/objects/accounts-receivable/customer/22"
}
}, - "txnAbsoluteValue": "275.03",
- "txnTotal": "-275.03000000000000",
- "href": "/objects/order-entry/recurring-document-subtotal/1627"
}, - {
- "id": "1628",
- "key": "1628",
- "recurringDocumentHeader": {
- "key": "14",
- "id": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "description": "Sales Tax",
- "absoluteValue": "884.92",
- "percentValue": "8.25",
- "total": "884.92000000000000",
- "dimensions": {
- "department": {
- "id": "1",
- "key": "2",
- "href": "/objects/company-config/department/2"
}, - "location": {
- "key": "1--Chicago",
- "id": "1",
- "href": "/objects/company-config/location/1--Chicago"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "CAR",
- "href": "/objects/accounts-receivable/customer/22"
}
}, - "txnAbsoluteValue": "884.92",
- "txnTotal": "884.92000000000000",
- "href": "/objects/order-entry/recurring-document-subtotal/1628"
}
], - "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns a collection with a key, ID, and link for each recurring document with the specified name. For example, to list all recurring 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.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View Order Entry documents |
documentName required | string Document Name Example: Sales Invoice |
OK
Bad Request
{- "ia::result": [
- {
- "key": "171",
- "id": "171",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/171"
}, - {
- "key": "172",
- "id": "172",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/172"
}, - {
- "key": "155",
- "id": "155",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/155"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates a new recurring document. To create a new recurring document, specify the transaction definition that is the template for the new document as documentName
in the request URL.
To access a list of available transaction definitions, use the list transaction definitions operation. For example, to create a new recurring document that uses the Sales Invoice transaction definition as a template, specify Sales Invoice
for the documentName
in the request URL.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View, Add Order Entry documents |
documentName required | string Document Name Example: Sales Invoice |
state | string Default: "active" State of the recurring document. Example: "active" | ||||||||||||||||||||||||||||||||||||
object Contacts associated with the recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Shipping method for the document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
referenceNumber | string Reference to another document, as needed. Example: "SALES-100" | ||||||||||||||||||||||||||||||||||||
contractId | string Sales contract ID associated with the transaction. Example: "CN100123" | ||||||||||||||||||||||||||||||||||||
contractDescription | string Sales contract description. Example: "Sales & Service" | ||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
notes | string Notes about the recurring document. Example: "Fast order" | ||||||||||||||||||||||||||||||||||||
memo | string Text to appear on the printed document. Example: "Lowry solutions" | ||||||||||||||||||||||||||||||||||||
customerPONumber | string Customer PO number associated with the transaction. Example: "ABOTT-1001" | ||||||||||||||||||||||||||||||||||||
object Customer associated with the recurring document. Example: "IBN" | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Define the scheduling details for the recurring document. Example: "{ \"startDate\": \"2024-07-01\", \"frequency\": \"weeks\", \"repeatCount\": \"2\", \"repeatBy\": \"weeks\", \"repeatInterval\": \"1\" }" | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Transaction definition that is associated with this recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Array of objects Lines of the recurring document. | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
Array of objects Lines of the recurring document subtotal. | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "referenceNumber": "RMF-001",
- "memo": "Discounted order",
- "txnCurrency": "USD",
- "baseCurrency": "USD",
- "shippingMethod": {
- "id": "Air"
}, - "paymentTerm": {
- "id": "N15"
}, - "customer": {
- "id": "22"
}, - "schedule": {
- "startDate": "2024-07-01",
- "repeatBy": "weeks",
- "repeatInterval": "2",
- "endDate": "2025-12-01'"
}, - "lines": [
- {
- "unit": "10 Pack",
- "unitQuantity": "1",
- "unitPrice": "1000.12",
- "dimensions": {
- "item": {
- "id": "Car_Battery"
}, - "warehouse": {
- "id": "WareHouse10004"
}, - "location": {
- "id": "1"
}
}
}
]
}
{- "ia::result": {
- "key": "13977",
- "id": "13977",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/13977"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified recurring 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.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View Order Entry documents |
documentName required | string Document Name Example: Sales Invoice |
key required | string System-assigned key for the order entry recurring document. Example: 41 |
OK
Bad Request
{- "ia::result": {
- "id": "14",
- "key": "14",
- "txnDefinition": {
- "key": "86",
- "id": "Sales Invoice",
- "href": "/objects/order-entry/txn-definition::Sales%20Invoice/86"
}, - "status": "active",
- "contacts": {
- "primary": {
- "key": "108",
- "id": "CAR(CCAR)"
}, - "shipTo": {
- "key": "108",
- "id": "CAR(CCAR)"
}, - "billTo": {
- "key": "108",
- "id": "CAR(CCAR)"
}
}, - "referenceNumber": "1012",
- "paymentTerm": {
- "key": "5",
- "id": "N15",
- "href": "/objects/accounts-receivable/term/5"
}, - "shippingMethod": {
- "id": "Air",
- "key": "2",
- "href": "/objects/accounts-receivable/shipping-method/2"
}, - "memo": "Recurring subscription",
- "contractId": null,
- "contractDescription": null,
- "notes": null,
- "subtotal": "11001.32000000000000",
- "total": "11611.21000000000000",
- "recurringSchedule": {
- "id": "15",
- "key": "15",
- "href": "/objects/core/schedule/15"
}, - "documentType": "Sales Invoice",
- "schedule": {
- "startDate": "2025-01-18",
- "endDate": null,
- "nextExecutionDate": "2025-01-18",
- "lastExecutionDate": null,
- "recurringDueDate": "2025-01-18",
- "frequency": "weeks",
- "executionCount": "0",
- "repeatCount": null,
- "repeatBy": "weeks",
- "repeatInterval": "4"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "Bernley Technology Inc",
- "href": "/objects/accounts-receivable/customer/22"
}, - "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRate": {
- "date": "2025-08-08",
- "typeName": null,
- "rate": "1.0000000000",
- "typeId": null
}, - "subtotalInTxnCurrency": "11001.32000000000000",
- "totalInTxnCurrency": "11611.21000000000000",
- "state": "active",
- "audit": {
- "createdDateTime": "2024-08-08T09:19:34Z",
- "modifiedDateTime": "2024-08-08T10:46:15Z",
- "createdByUser": {
- "key": "1",
- "href": "/objects/company-config/user/1"
}, - "createdBy": "1",
- "modifiedByUser": {
- "key": "1",
- "href": "/objects/company-config/user/1"
}, - "modifiedBy": "1",
- "customerPONumber": null,
- "entity": {
- "key": null,
- "id": null,
- "name": null
}
}, - "lines": [
- {
- "id": "814",
- "key": "814",
- "recurringDocumentHeader": {
- "id": "14",
- "key": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "lineNumber": 1,
- "item": {
- "key": "15",
- "id": "Car_Battery",
- "href": "/objects/inventory-control/item/15"
}, - "dimensions": {
- "item": {
- "id": "Car_Battery"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}, - "department": {
- "id": "3",
- "key": "3",
- "href": "/objects/company-config/department/3"
}, - "customer": {
- "key": "36",
- "id": "C-00045--MetroAtlantix, Inc.",
- "name": "MetroAtlantix, Inc.",
- "href": "/objects/accounts-receivable/customer/36"
}, - "vendor": {
- "key": "510",
- "id": "V-00006--HPD Inc",
- "name": "HPD Inc",
- "href": "/objects/accounts-payable/vendor/510"
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}
}, - "itemAlias": {
- "key": null,
- "id": null
}, - "unit": "10 Pack",
- "status": "inactive",
- "recurringStatus": "active",
- "unitQuantity": "9.0000000000",
- "isPriceProrated": null,
- "unitPrice": "1000.1200000000",
- "retailPrice": "0.0000000000",
- "discountMemo": null,
- "currency": "USD",
- "priceInTxnCurrency": "1000.1200000000",
- "conversionType": "quantity",
- "enableTax": false,
- "href": "/objects/order-entry/recurring-document-line/814"
}, - {
- "id": "815",
- "key": "815",
- "recurringDocumentHeader": {
- "id": "14",
- "key": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "lineNumber": 2,
- "item": {
- "key": "157",
- "id": "Car_Battery_D",
- "href": "/objects/inventory-control/item/17"
}, - "dimensions": {
- "item": {
- "id": "Car_Battery_D"
}, - "warehouse": {
- "id": "WareHouse10004",
- "key": "4",
- "href": "/objects/inventory-control/warehouse/4"
}, - "location": {
- "id": "1",
- "key": "6",
- "href": "/objects/company-config/location/6"
}, - "department": {
- "id": "3",
- "key": "3",
- "href": "/objects/company-config/department/3"
}, - "customer": {
- "key": "36",
- "id": "C-00045--MetroAtlantix, Inc.",
- "name": "MetroAtlantix, Inc.",
- "href": "/objects/accounts-receivable/customer/36"
}, - "vendor": {
- "key": "510",
- "id": "V-00006--HPD Inc",
- "name": "HPD Inc",
- "href": "/objects/accounts-payable/vendor/510"
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}
}, - "itemAlias": {
- "key": null,
- "id": null
}, - "unit": "10 Pack",
- "status": "inactive",
- "recurringStatus": "active",
- "unitQuantity": "6.0000000000",
- "isPriceProrated": null,
- "unitPrice": "1500.1200000000",
- "retailPrice": "0.0000000000",
- "discountMemo": null,
- "currency": "USD",
- "priceInTxnCurrency": "1500.1200000000",
- "conversionType": "quantity",
- "enableTax": false,
- "href": "/objects/order-entry/recurring-document-line/815"
}
], - "subtotals": [
- {
- "id": "1627",
- "key": "1627",
- "recurringDocumentHeader": {
- "key": "14",
- "id": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "description": "Sales Discount",
- "absoluteValue": "275.03",
- "percentValue": "2.50",
- "total": "-275.03000000000000",
- "dimensions": {
- "department": {
- "id": "1",
- "key": "2",
- "href": "/objects/company-config/department/2"
}, - "location": {
- "key": "1--Chicago",
- "id": "1",
- "href": "/objects/company-config/location/1--Chicago"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "CAR",
- "href": "/objects/accounts-receivable/customer/22"
}
}, - "txnAbsoluteValue": "275.03",
- "txnTotal": "-275.03000000000000",
- "href": "/objects/order-entry/recurring-document-subtotal/1627"
}, - {
- "id": "1628",
- "key": "1628",
- "recurringDocumentHeader": {
- "key": "14",
- "id": "14",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "description": "Sales Tax",
- "absoluteValue": "884.92",
- "percentValue": "8.25",
- "total": "884.92000000000000",
- "dimensions": {
- "department": {
- "id": "1",
- "key": "2",
- "href": "/objects/company-config/department/2"
}, - "location": {
- "key": "1--Chicago",
- "id": "1",
- "href": "/objects/company-config/location/1--Chicago"
}, - "customer": {
- "key": "22",
- "id": "CAR",
- "name": "CAR",
- "href": "/objects/accounts-receivable/customer/22"
}
}, - "txnAbsoluteValue": "884.92",
- "txnTotal": "884.92000000000000",
- "href": "/objects/order-entry/recurring-document-subtotal/1628"
}
], - "href": "/objects/order-entry/recurring-document::Sales%20Invoice/14"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing recurring document by setting field values. Any fields not provided remain unchanged.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View, Edit Order Entry documents |
documentName required | string Document Name Example: Sales Invoice |
key required | string System-assigned key for the order entry recurring document. Example: 41 |
state | string Default: "active" State of the recurring document. Example: "active" | ||||||||||||||||||||||||||||||||||||
object Contacts associated with the recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Shipping method for the document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
referenceNumber | string Reference to another document, as needed. Example: "SALES-100" | ||||||||||||||||||||||||||||||||||||
contractId | string Sales contract ID associated with the transaction. Example: "CN100123" | ||||||||||||||||||||||||||||||||||||
contractDescription | string Sales contract description. Example: "Sales & Service" | ||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
notes | string Notes about the recurring document. Example: "Fast order" | ||||||||||||||||||||||||||||||||||||
memo | string Text to appear on the printed document. Example: "Lowry solutions" | ||||||||||||||||||||||||||||||||||||
customerPONumber | string Customer PO number associated with the transaction. Example: "ABOTT-1001" | ||||||||||||||||||||||||||||||||||||
object Customer associated with the recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Define the scheduling details for the recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
object Transaction definition that is associated with this recurring document. | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Array of objects Lines of the recurring document. | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
Array of objects Lines of the recurring document subtotal. | |||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "value": {
- "referenceNumber": "Recur-1012",
- "lines": [
- {
- "dimensions": {
- "item": {
- "key": "15"
}, - "warehouse": {
- "key": "4"
}, - "location": {
- "key": "6"
}
}, - "item": {
- "key": "15"
}, - "unit": "10 Pack"
}
]
}
}
{- "ia::result": {
- "key": "52",
- "id": "52",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/52"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a recurring document.
Subscription | Order Entry |
---|---|
User type | Business, Employee, Project Manager, Warehouse |
Permissions | List, View, Delete Order Entry documents |
documentName required | string Document Name Example: Sales Invoice |
key required | string System-assigned key for the order entry recurring document. Example: 41 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "order-entry/recurring-document" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 has (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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the result set, 4000 maximum. Example: 100 |
OK
Bad Request
{- "object": "order-entry/recurring-document",
- "filters": [
- {
- "$eq": {
- "documentType": "Sales Invoice"
}
}
], - "fields": [
- "id",
- "href",
- "status",
- "customer.id",
- "totalInTxnCurrency"
]
}
{- "ia::result": [
- {
- "id": "6",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/6",
- "status": "active",
- "customer.id": "MI",
- "totalInTxnCurrency": "7200.00000000000000"
}, - {
- "id": "7",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/7",
- "status": "active",
- "customer.id": "BigSmalls",
- "totalInTxnCurrency": "1800.00000000000000"
}, - {
- "id": "9",
- "href": "/objects/order-entry/recurring-document::Sales%20Invoice/9",
- "status": "active",
- "customer.id": "WestSnack",
- "totalInTxnCurrency": "2100.00000000000000"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}