Transaction definition document conversion details

Specify the transaction definitions from which this transaction can be converted.

List transaction definition document conversion detail objects

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

Returns a collection with a key, ID, and link for each document conversion detail object.

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 document conversion detail object
post/objects/order-entry/txn-definition-source-document-detail
Creates a new document conversion detail object.


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


 
key
string
System-assigned key for the order entry transaction definition.


 
 Example:  "23"
id
string
Document id.


 
 Example:  "Sales order"
isDefault
boolean
 Default:  false
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 document conversion detail object
get/objects/order-entry/txn-definition-source-document-detail/{key}
Returns detailed information for a specified document conversion detail object.


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


 
 Example:  9
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 document conversion detail object
patch/objects/order-entry/txn-definition-source-document-detail/{key}
Updates an existing document conversion detail object by setting field values. Any fields not provided remain unchanged.


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


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


 
key
string
System-assigned key for the order entry transaction definition.


 
 Example:  "23"
id
string
Document id.


 
 Example:  "Sales order"
isDefault
boolean
 Default:  false
Default for bulk conversion.


 
 Example:  true
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "order-entry-txn-definition": {
    • "key": "64"
    },
  • "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 document conversion detail object
delete/objects/order-entry/txn-definition-source-document-detail/{key}
Deletes a document conversion detail object.


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


 
 Example:  9
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


Request samples