Cogs Entries

Cogs Entries

Returns a cogs entry from the system by its ID.

This method will look up a cogs entry by the specified ID and return it back.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the cogs entry to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The cogs entry was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The cogs entry could not be found.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error.
get/cogsEntries/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/cogsEntries/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "bin_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "type": "adjustment",
  • "unit_cost": 0,
  • "quantity": 0,
  • "total_cost": 0,
  • "inventory_transaction_id": "string",
  • "inventory_adjustment_id": "string",
  • "inventory_fulfillment_id": "string",
  • "inventory_return_id": "string",
  • "inventory_receipt_id": "string",
  • "notes": "string",
  • "parent_cogs_entry_id": "string",
  • "status": "open",
  • "custom_field_values": [
    ],
  • "sys_fiscal_period_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a cogs entry with the specified ID.

This method will update an existing cogs entry with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the cogs entry to update.

Request Body schema: application/json

The updated cogs entry that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this cogs entry

business_unit_id
required
string (Business Unit)

The business unit

order_id
string (Order)

The order to which this entry is connected

order_line_item_id
string (Order Line Item)

The order line item to which this entry is connected

product_inventory_id
required
string (Product Inventory)

The product inventory being supported by this entry

warehouse_id
required
string (Warehouse)

The warehouse

bin_id
string (Bin)

The bin

product_type
required
string (Product Type)

The type of the product

product_id
required
string (Product)

The product ID

date
string <date-time> (Date)

The date of the entry

fiscal_year_id
required
string (Fiscal Year)

The fiscal year of the entry

fiscal_period
required
number <float> (Fiscal Period) [ 1 .. 23 ]

The fiscal period of the entry

type
required
string (Type)

The type of entry

Enum: "adjustment" "fulfillment" "receipt" "return"
unit_cost
required
number <double> (Unit Cost)

The unit cost

quantity
required
integer (Quantity)

The quantity represented in the COGS entry

total_cost
required
number <double> (Total Cost)

The total cost

inventory_transaction_id
required
string (Inventory Transaction)

A pointer to the inventory transaction that generated this entry

inventory_adjustment_id
required
string (Inventory Adjustment)

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_id
required
string (Inventory Fulfillment)

A pointer to the inventory fulfillment transaction that generated this entry

inventory_return_id
required
string (Inventory Return)

A pointer to the inventory return transaction that generated this entry

inventory_receipt_id
required
string (Inventory Receipt)

A pointer to the inventory receipt transaction that generated this entry

notes
string (Notes)

Notes/description of this entry

parent_cogs_entry_id
string (Parent Cogs Entry)

The parent COGS entry for this one

status
required
string (Status)

The status of the entry

Enum: "open" "processed"
Array of objects (Custom Field Values)
sys_fiscal_period_id
string (Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

Responses
200The cogs entry was updated successfully.
400The cogs entry supplied was not valid.
401Unauthorized.
403Forbidden.
404The cogs entry could not be found.
409The cogs entry could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error.
put/cogsEntries/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "bin_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "type": "adjustment",
  • "unit_cost": 0,
  • "quantity": 0,
  • "total_cost": 0,
  • "inventory_transaction_id": "string",
  • "inventory_adjustment_id": "string",
  • "inventory_fulfillment_id": "string",
  • "inventory_return_id": "string",
  • "inventory_receipt_id": "string",
  • "notes": "string",
  • "parent_cogs_entry_id": "string",
  • "status": "open",
  • "custom_field_values": [
    ],
  • "sys_fiscal_period_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "bin_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "type": "adjustment",
  • "unit_cost": 0,
  • "quantity": 0,
  • "total_cost": 0,
  • "inventory_transaction_id": "string",
  • "inventory_adjustment_id": "string",
  • "inventory_fulfillment_id": "string",
  • "inventory_return_id": "string",
  • "inventory_receipt_id": "string",
  • "notes": "string",
  • "parent_cogs_entry_id": "string",
  • "status": "open",
  • "custom_field_values": [
    ],
  • "sys_fiscal_period_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a cogs entry with the specified ID.

This method will patch an existing cogs entry with the specified ID, using the HTTP PATCH specification.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the cogs entry to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The cogs entry was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The cogs entry could not be found.
409The cogs entry could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error.
patch/cogsEntries/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "product_inventory_id": "string",
  • "warehouse_id": "string",
  • "bin_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "type": "adjustment",
  • "unit_cost": 0,
  • "quantity": 0,
  • "total_cost": 0,
  • "inventory_transaction_id": "string",
  • "inventory_adjustment_id": "string",
  • "inventory_fulfillment_id": "string",
  • "inventory_return_id": "string",
  • "inventory_receipt_id": "string",
  • "notes": "string",
  • "parent_cogs_entry_id": "string",
  • "status": "open",
  • "custom_field_values": [
    ],
  • "sys_fiscal_period_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a cogs entry from the system by its ID.

This method will delete a cogs entry with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the cogs entry to delete.

Responses
200The cogs entry was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The cogs entry could not be found.
409The cogs entry could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete cogs entry based on tenant limits.
500General server error.
delete/cogsEntries/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.rhythmsoftware.com/cogsEntries/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a list of COGS entries for a transaction ID

Returns a list of COGS entries for a transaction ID

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

inventoryTransactionId
required
string

The inventoryTransactionId to look up

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

Responses
200The cogs entry was retrieved successfully
400The request was not valid.
404The cogs entry could not be found.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error
get/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/cogsEntries/:tenantId/inventoryTransaction/:inventoryTransactionId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a list of COGS entries for an order id

Returns a list of COGS entries for an order id

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

orderId
required
string

The order ID to look up

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

Responses
200The cogs entry was retrieved successfully
400The request was not valid.
404The cogs entry could not be found.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error
get/cogsEntries/{tenantId}/order/{orderId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/cogsEntries/:tenantId/order/:orderId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a list of COGS entries in a fiscal period

Returns a list of COGS entries in a fiscal period

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

fiscal_year_id
required
string

The fiscal year ID to look up

fiscal_period
required
integer

The fiscal period to look up

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

Responses
200The cogs entry was retrieved successfully
400The request was not valid.
404The cogs entry could not be found.
429Limit exceeded... unable to retrieve cogs entry based on tenant limits.
500General server error
get/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/cogsEntries/:tenantId/fiscalperiod/:fiscal_year_id/:fiscal_period?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]