Transaction definition source document details

Specifies the transaction definition from which the transaction can be converted.

For more information, see Transaction definitions - Order Entry in the Sage Intacct Help Center.

List transaction definition source document detail objects

get/objects/order-entry/txn-definition-source-document-detail

Returns a collection with a key, ID, and link for each transaction definition source document detail object. 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, transaction definitions
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "23",
      • "id": "23",
      • "href": "/objects/order-entry/txn-definition-source-document-detail/23"
      },
    • {
      • "key": "19",
      • "id": "19",
      • "href": "/objects/order-entry/txn-definition-source-document-detail/19"
      },
    • {
      • "key": "61",
      • "id": "61",
      • "href": "/objects/order-entry/txn-definition-source-document-detail/61"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction definition source document detail object
post/objects/order-entry/txn-definition-source-document-detail
Creates a new transaction definition source document detail object.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Add transaction definitions







SecurityOAuth2 
Request 
Request Body schema: application/json
required
object
Specify the transaction definition from which this transaction can be converted.
For example, a sales invoice can be converted from a sales order.


 
key
string
Unique key for the transaction definition.


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


 
 Example:  "Sales order"
isDefault
boolean
 Default:  false
Specify whether the sourceDocument is the default for bulk conversion.


 
 Example:  true
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "order-entry-txn-definition": {
    • "key": "64"
    },
  • "sourceDocument": {
    • "id": "Sales Invoice"
    },
  • "isDefault": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "70",
    • "id": "70",
    • "href": "/objects/order-entry/txn-definition-source-document-detail/70"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition source document detail object
get/objects/order-entry/txn-definition-source-document-detail/{key}
Returns detailed information for a specified transaction definition source document detail object.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, transaction definitions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition source document detail object.


 
 Example:  70
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "70",
    • "id": "70",
    • "order-entry-txn-definition": {
      • "key": "64",
      • "id": "Sales Order",
      • "href": "/objects/order-entry/txn-definition/64"
      },
    • "sourceDocument": {
      • "key": "43",
      • "id": "Sales Invoice",
      • "href": "/objects/order-entry/txn-definition/43"
      },
    • "isDefault": true,
    • "href": "/objects/order-entry/txn-definition/source-document-detail/70"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition source document detail object
patch/objects/order-entry/txn-definition-source-document-detail/{key}
Updates an existing transaction definition source document detail object by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Edit transaction definitions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition source document detail object.


 
 Example:  70
Request Body schema: application/json
object
Specify the transaction definition from which this transaction can be converted.
For example, a sales invoice can be converted from a sales order.


 
key
string
Unique key for the transaction definition.


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


 
 Example:  "Sales order"
isDefault
boolean
 Default:  false
Specify whether the sourceDocument is the default for bulk conversion.


 
 Example:  true
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "sourceDocument": {
    • "key": "55"
    },
  • "isDefault": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "70",
    • "id": "70",
    • "href": "/objects/order-entry/txn-definition-source-document-detail/70"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition source document detail object
delete/objects/order-entry/txn-definition-source-document-detail/{key}
Deletes a transaction definition source document detail object.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View, Delete transaction definitions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition source document detail object.


 
 Example:  70
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 transaction definition source document details
post/services/core/query
Use the query service to find transaction definition source document details 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
    }
}