Sign in
Transactions

Add a transaction item

Adds an item to a transaction. Adding the first item moves budget coding from the transaction to its items. Requires an Idempotency-Key.

post/transactions/{transactionId}/items

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/transactions/{transactionId}/items
  • Auth: HTTP bearer

Path parameters

transactionIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Transaction ID.

Headers

Idempotency-Keystring required

A unique 16-255 character key. Reusing the key with the same body returns the first result. Reusing it with a different body returns 409 idempotency_conflict.

Request body

lineNumberstring
descriptionstring
budgetLineIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

fringeIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

contactIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

qtystring
unitstring
customUnitIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

ratestring
overtimestring
taxablestring
nonTaxablestring
tagIdsId[]

Tag IDs to assign. Duplicate IDs are ignored.

Example request

{
  "budgetLineId": "txn_8f2a1c9e",
  "fringeId": "txn_8f2a1c9e",
  "contactId": "txn_8f2a1c9e",
  "customUnitId": "txn_8f2a1c9e",
  "amount": {
    "amount": 152900,
    "currency": "USD"
  },
  "tagIds": [
    "txn_8f2a1c9e"
  ]
}

Response

The created item.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

lineNumberstring nullable required

Line number shown in the itemization.

descriptionstring nullable

Item description.

budgetLineIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

fringeIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

contactIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

qtystring nullable

Quantity or formula.

unitstring nullable

Unit, such as Day, Hour, or Flat.

customUnitIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

ratestring nullable

Rate or formula.

overtimestring nullable

Overtime amount or formula.

taxablestring nullable

Taxable amount or formula.

nonTaxablestring nullable

Non-taxable amount or formula.

tagIdsId[] required

Tag IDs assigned to this item.

Example response

{
  "id": "txn_8f2a1c9e",
  "lineNumber": "1",
  "budgetLineId": "txn_8f2a1c9e",
  "fringeId": "txn_8f2a1c9e",
  "contactId": "txn_8f2a1c9e",
  "qty": "3",
  "unit": "Day",
  "customUnitId": "txn_8f2a1c9e",
  "amount": {
    "amount": 152900,
    "currency": "USD"
  },
  "account": {
    "id": "txn_8f2a1c9e",
    "name": "Camera",
    "code": "1200"
  },
  "tagIds": [
    "txn_8f2a1c9e"
  ],
  "tags": [
    {
      "id": "txn_8f2a1c9e"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.