Transaction definition COGS details

This object holds the COGS account and Inventory account mapping for the owning transaction definition. This account mapping is supported if:

  • Your company subscribes to Inventory Control.
  • Your company does not subscribe to Inventory Control, but enableCosting is set to true in the owning transaction definition.

The item GL group, warehouse, and customer GL group together form the criteria set for the account mapping. For more information, see Transaction definitions - Order Entry in the Sage Intacct Help Center.

List transaction definition COGS detail objects

get/objects/order-entry/txn-definition-cogs-gl-detail

Returns a collection with a key, ID, and link for each transaction definition COGS 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": "159",
      • "id": "159",
      • "href": "/objects/order-entry/txn-definition-cogs-gl-detail/159"
      },
    • {
      • "key": "160",
      • "id": "160",
      • "href": "/objects/order-entry/txn-definition-cogs-gl-detail/160"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a transaction definition COGS detail object
get/objects/order-entry/txn-definition-cogs-gl-detail/{key}
Returns detailed information for a specified transaction definition COGS 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 COGS detail object.


 
 Example:  160
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "160",
    • "id": "160",
    • "order-entry-txn-definition": {
      • "key": "43",
      • "id": "Sales Invoice",
      • "href": "/objects/order-entry-txn-definition/43"
      },
    • "itemGLGroup": {
      • "key": "16",
      • "id": "HW GL Group",
      • "href": "/objects/inventory-control/item-gl-group/16"
      },
    • "txnType": "debit",
    • "moduleType": "inventory",
    • "glAccount": {
      • "id": "5000",
      • "key": "72",
      • "href": "/objects/general-ledger/account/72"
      },
    • "lineNumber": 11,
    • "href": "/objects/order-entry/txn-definition-cogs-gl-detail/160"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition COGS detail object
patch/objects/order-entry/txn-definition-cogs-gl-detail/{key}
Updates an existing transaction definition COGS 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 COGS detail object.


 
 Example:  160
Request Body schema: application/json
isOffset
boolean
 Default:  false
Set to true if the GL account specified in the glAccount field is an offset account. Each itemGLGroup, warehouse, and customerGLGroup criteria set must have one offset account.


 
 Example:  true
txnType
string
Specify whether to debit or credit the account.


 Enum: "credit" "debit"  
 Example:  "debit"
moduleType
string
Module type.


 Enum: "additional" "inventory" "subledger"  
 Example:  "subledger"
lineNumber
integer  <= 8 characters 
Line number of the transaction.


 
 Example:  1
object
The GL account to which the transaction posts for the mapped criteria set.


 
key
string
Unique key for the GL account.


 
 Example:  "384"
id
string
User-assigned ID for the account.


 
 Example:  "1501.04"
object
Location associated with the transaction definition.


 
key
string
Unique key for the location.


 
 Example:  "3345"
id
string
Unique ID for the location.


 
 Example:  "Arizona"
object
Department associated with the transaction definition.


 
key
string
Unique key for the department.


 
 Example:  "28"
id
string
Unique ID for the department.


 
 Example:  "Sales"
object
The itemGLgroup, warehouse, and customerGLGroup together form the criteria set for the account mapping.


 
key
string
Unique key for the item GL group.


 
 Example:  "13"
id
string
Name or other unique ID for the item GL group.


 
 Example:  "Stockable Kit"
object
The itemGLgroup, warehouse, and customerGLGroup together form the criteria set for the account mapping.


 
key
string
Unique key for the warehouse.


 
 Example:  "23"
id
string
Unique ID for the warehouse.


 
 Example:  "Warehouse-001"
object
The itemGLgroup, warehouse, and customerGLGroup together form the criteria set for the account mapping.


 
id
string
Customer GL group name.


 
 Example:  "Group 1"
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "txnType": "credit",
  • "isOffset": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "191",
    • "id": "191",
    • "href": "/objects/order-entry/txn-definition-cogs-gl-detail/191"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition COGS detail object
delete/objects/order-entry/txn-definition-cogs-gl-detail/{key}
Deletes a transaction definition COGS 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 COGS detail object.


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