Transaction definition source document details

This object provides document conversion details for purchasing transactions.

List purchasing transaction source document detail objects

get/objects/purchasing-txn-definition-source-document-detail

Returns a collection with a key, ID, and link for each purchasing transaction source document detail object.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  {"id":"PO Receiver"}
id
required
string
ID for the transaction definition.


 
 Example:  "PO Receiver"
key
string
Unique key for the transaction definition.


 
 Example:  "44"
object
Purchasing transaction definition associated with this source document detail object.


 
 Example:  {"key":"96"}
key
required
string  <= 8 characters 
Unique key for the  transaction definition.


 
 Example:  "96"
id
string  <= 30 characters 
ID for the transaction definition.


 
 Example:  "Purchase Quote"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "sourceDocument": {
    • "id": "PO Receiver"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "78",
    • "id": "78",
    • "href": "/objects/purchasing/txn-definition-source-document-detail/78"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition source document detail object
get/objects/purchasing/txn-definition-source-document-detail/{key}
Returns detailed information for a specified transaction definition source document detail object.


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


 
 Example:  136
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "76",
    • "key": "76",
    • "purchasingTxnDefinition": {
      • "key": "96",
      • "id": "DEMO1",
      • "href": "/objects/purchasing/txn-definition/96"
      },
    • "sourceDocument": {
      • "key": "6",
      • "id": "PO Receiver",
      • "href": "/objects/purchasing/txn-definition/6"
      },
    • "href": "/objects/purchasing/txn-definition-source-document-detail/76"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition source document detail object
patch/objects/purchasing/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.


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


 
 Example:  136
Request Body schema: application/json
object
Specify the transaction definitions from which this transaction can be converted. For example, a purchasing invoice can be converted from a purchase order.


 
key
string
Unique key for the transaction definition.


 
 Example:  "44"
id
string
ID for the transaction definition.


 
 Example:  "Purchase order"
object
Purchasing transaction definition associated with this source document detail object.


 
key
string  <= 8 characters 
Unique key for the  transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
ID for the transaction definition.


 
 Example:  "Purchase Quote"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "sourceDocument": {
    • "id": "PO Return"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "78",
    • "id": "78",
    • "href": "/objects/purchasing/txn-definition-source-document-detail/78"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition source document detail object
delete/objects/purchasing/txn-definition-source-document-detail/{key}
Deletes a transaction definition source document detail object.


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


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