Collect

Collect (Finance & Billing) (v1-2025-04-18)

The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of Invoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods and can be used to download batches for import into your accounting package.

Like most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

collect-v1.json

collect-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/

https://collect.api.rhythmsoftware.com/

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of COGS entries in a fiscal period

Request

Returns a list of COGS entries in a fiscal period

Path

tenantIdstringrequired

The id of the tenant being accessed

fiscal_year_idstringrequired

The fiscal year ID to look up

fiscal_periodintegerrequired

The fiscal period to look up

Query

fieldsstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}?fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The cogs entry was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

]

Response

application/json

[
  {
    "bin_id": "string",
    "business_unit_id": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24T14:15:22Z",
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "inventory_adjustment_id": "string",
    "inventory_fulfillment_id": "string",
    "inventory_receipt_id": "string",
    "inventory_return_id": "string",
    "inventory_transaction_id": "string",
    "notes": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "parent_cogs_entry_id": "string",
    "product_id": "string",
    "product_inventory_id": "string",
    "product_type": "string",
    "quantity": 0,
    "status": "open",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_fiscal_period_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_cost": 0.1,
    "type": "adjustment",
    "unit_cost": 0.1,
    "warehouse_id": "string"
  }
]

Returns a list of COGS entries for a transaction ID

Request

Returns a list of COGS entries for a transaction ID

Path

tenantIdstringrequired

The id of the tenant being accessed

inventoryTransactionIdstringrequired

The inventoryTransactionId to look up

Query

fieldsstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}?fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The cogs entry was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

]

Response

application/json

[
  {
    "bin_id": "string",
    "business_unit_id": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24T14:15:22Z",
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "inventory_adjustment_id": "string",
    "inventory_fulfillment_id": "string",
    "inventory_receipt_id": "string",
    "inventory_return_id": "string",
    "inventory_transaction_id": "string",
    "notes": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "parent_cogs_entry_id": "string",
    "product_id": "string",
    "product_inventory_id": "string",
    "product_type": "string",
    "quantity": 0,
    "status": "open",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_fiscal_period_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_cost": 0.1,
    "type": "adjustment",
    "unit_cost": 0.1,
    "warehouse_id": "string"
  }
]

Returns a list of COGS entries for an order id

Request

Returns a list of COGS entries for an order id

Path

tenantIdstringrequired

The id of the tenant being accessed

orderIdstringrequired

The order ID to look up

Query

fieldsstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/order/{orderId}?fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The cogs entry was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

]

Response

application/json

[
  {
    "bin_id": "string",
    "business_unit_id": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24T14:15:22Z",
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "inventory_adjustment_id": "string",
    "inventory_fulfillment_id": "string",
    "inventory_receipt_id": "string",
    "inventory_return_id": "string",
    "inventory_transaction_id": "string",
    "notes": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "parent_cogs_entry_id": "string",
    "product_id": "string",
    "product_inventory_id": "string",
    "product_type": "string",
    "quantity": 0,
    "status": "open",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_fiscal_period_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_cost": 0.1,
    "type": "adjustment",
    "unit_cost": 0.1,
    "warehouse_id": "string"
  }
]

Returns a cogs entry from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the cogs entry to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The cogs entry was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a cogs entry from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the cogs entry to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The cogs entry was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

Response

application/json

{
  "bin_id": "string",
  "business_unit_id": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "inventory_adjustment_id": "string",
  "inventory_fulfillment_id": "string",
  "inventory_receipt_id": "string",
  "inventory_return_id": "string",
  "inventory_transaction_id": "string",
  "notes": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "parent_cogs_entry_id": "string",
  "product_id": "string",
  "product_inventory_id": "string",
  "product_type": "string",
  "quantity": 0,
  "status": "open",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_fiscal_period_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_cost": 0.1,
  "type": "adjustment",
  "unit_cost": 0.1,
  "warehouse_id": "string"
}

Partially updates a cogs entry with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the cogs entry to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The cogs entry was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

Response

application/json

{
  "bin_id": "string",
  "business_unit_id": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "inventory_adjustment_id": "string",
  "inventory_fulfillment_id": "string",
  "inventory_receipt_id": "string",
  "inventory_return_id": "string",
  "inventory_transaction_id": "string",
  "notes": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "parent_cogs_entry_id": "string",
  "product_id": "string",
  "product_inventory_id": "string",
  "product_type": "string",
  "quantity": 0,
  "status": "open",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_fiscal_period_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_cost": 0.1,
  "type": "adjustment",
  "unit_cost": 0.1,
  "warehouse_id": "string"
}

Updates a cogs entry with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the cogs entry to update.

Bodyapplication/jsonrequired

The updated cogs entry that will be saved.

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/cogsEntries/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bin_id": "string",
    "business_unit_id": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "inventory_adjustment_id": "string",
    "inventory_fulfillment_id": "string",
    "inventory_receipt_id": "string",
    "inventory_return_id": "string",
    "inventory_transaction_id": "string",
    "notes": "string",
    "order_id": "string",
    "order_line_item_id": "string",
    "parent_cogs_entry_id": "string",
    "product_id": "string",
    "product_inventory_id": "string",
    "product_type": "string",
    "quantity": 0,
    "status": "open",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_fiscal_period_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total_cost": 0.1,
    "type": "adjustment",
    "unit_cost": 0.1,
    "warehouse_id": "string"
  }'

Responses

The cogs entry was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bin_idstring(Bin)

The bin

business_unit_idstring(Business Unit)required

The business unit

custom_field_valuesArray of objects(Custom Field Values)

datestring(date-time)(Date)

The date of the entry

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 23 ]required

The fiscal period of the entry

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the entry

idstring(ID)^[\w|-]+$required

The unique, string identifier of this cogs entry

inventory_adjustment_idstring(Inventory Adjustment)required

A pointer to the inventory adjustment transaction that generated this entry

inventory_fulfillment_idstring(Inventory Fulfillment)required

A pointer to the inventory fulfillment transaction that generated this entry

inventory_receipt_idstring(Inventory Receipt)required

A pointer to the inventory receipt transaction that generated this entry

inventory_return_idstring(Inventory Return)required

A pointer to the inventory return transaction that generated this entry

inventory_transaction_idstring(Inventory Transaction)required

A pointer to the inventory transaction that generated this entry

notesstring(Notes)

Notes/description of this entry

order_idstring(Order)

The order to which this entry is connected

order_line_item_idstring(Order Line Item)

The order line item to which this entry is connected

parent_cogs_entry_idstring(Parent Cogs Entry)

The parent COGS entry for this one

product_idstring(Product)required

The product ID

product_inventory_idstring(Product Inventory)required

The product inventory being supported by this entry

product_typestring(Product Type)required

The type of the product

quantityinteger(Quantity)required

The quantity represented in the COGS entry

statusstring(Status)required

The status of the entry

Enum"open""processed"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_fiscal_period_idstring(Sys Fiscal Period)

System field to store year + period - DO NOT USE

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

total_costnumber(double)(Total Cost)required

The total cost

typestring(Type)required

The type of entry

Enum"adjustment""fulfillment""receipt""return"

unit_costnumber(double)(Unit Cost)required

The unit cost

warehouse_idstring(Warehouse)required

The warehouse

Response

application/json

{
  "bin_id": "string",
  "business_unit_id": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24T14:15:22Z",
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "inventory_adjustment_id": "string",
  "inventory_fulfillment_id": "string",
  "inventory_receipt_id": "string",
  "inventory_return_id": "string",
  "inventory_transaction_id": "string",
  "notes": "string",
  "order_id": "string",
  "order_line_item_id": "string",
  "parent_cogs_entry_id": "string",
  "product_id": "string",
  "product_inventory_id": "string",
  "product_type": "string",
  "quantity": 0,
  "status": "open",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_fiscal_period_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total_cost": 0.1,
  "type": "adjustment",
  "unit_cost": 0.1,
  "warehouse_id": "string"
}

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Subledger Entries

Operations

Write Offs

Operations

Collect (Finance & Billing) (v1-2025-04-18)

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of COGS entries in a fiscal period

Request

Responses

Was this helpful?

Returns a list of COGS entries for a transaction ID

Request

Responses

Was this helpful?

Returns a list of COGS entries for an order id

Request

Responses

Was this helpful?

Returns a cogs entry from the system by its ID.

Request

Responses

Was this helpful?

Returns a cogs entry from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a cogs entry with the specified ID.

Request

Responses

Was this helpful?

Updates a cogs entry with the specified ID.

RequestExpand all

Responses

Was this helpful?

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Request

Request