Saltar al contenido

Update a budget line

Módulo Finance

PATCH/budget-lines/{id}budgetLines.update

A budget line. A blank unit price is unpriced; zero is a claim. Fee and Contingency are line types. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad finance.budget.write.
  • Alcances de OAuth: finance.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

budgetLines.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the budget line.

Cuerpo de la solicitud: BudgetLineUpdate

budgetLines.update: BudgetLineUpdate
CampoTipoObligatorioDescripción
cost_center_idstring (uuid) | nullNoIdentifier of the cost center.
uridUridAtAnyGrainNoURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
xyzXyzNoXYZ schema-family tag (Section 3.6): X Resource, Y Process, Z Timeline.Restricciones: pattern ^[XYZ]$
xyz_basisstringNoBasis for the XYZ tag.Restricciones: length 1 to 300
line_typeLineTypeNoBudget line type from the budget template specification (Bible tab 34). Fee and Contingency are line types, not accounts.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
grade_codestring | nullNoPrice band grade of the catalog element.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
element_idItemIdNoCatalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
descriptionstringNoLine description.Restricciones: length 1 to 300
quantitynumberNoQuantity; defaults to 1.
unit_basisUnitCodeNoUnit basis from the controlled unit list in `xpms.dim_unit_alias`.Restricciones: pattern ^[a-z][a-z0-9_-]*$
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerNoLine number within the budget.Restricciones: range 1 to any
phase_codePhaseCode | nullNo
tier_codeTierCode | nullNo
{
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "xyz_basis": "Rented inventory",
  "grade_code": "base",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_price_minor": 4500,
  "line_number": 1
}

Respuesta 200: BudgetLine

budgetLines.update: BudgetLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the budget line.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
budget_idstring (uuid)SíIdentifier of the budget.
cost_center_idstring (uuid) | nullSíIdentifier of the cost center.
uridUridAtAnyGrainSíURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
xyzXyzSíXYZ schema-family tag (Section 3.6): X Resource, Y Process, Z Timeline.Restricciones: pattern ^[XYZ]$
xyz_basisstringSíBasis for the XYZ tag.Restricciones: length 1 to 300
line_typeLineTypeSíBudget line type from the budget template specification (Bible tab 34). Fee and Contingency are line types, not accounts.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
grade_codestring | nullSíPrice band grade of the catalog element.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
element_idItemIdSíCatalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
descriptionstringSíLine description.Restricciones: length 1 to 300
quantitynumberSíQuantity; defaults to 1.
unit_basisUnitCodeSíUnit basis from the controlled unit list in `xpms.dim_unit_alias`.Restricciones: pattern ^[a-z][a-z0-9_-]*$
unit_price_minorinteger (int64) | nullSíUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_total_minorinteger (int64) | nullSíLine total, generated from quantity and unit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerSíLine number within the budget.Restricciones: range 1 to any
phase_codePhaseCode | nullSí
tier_codeTierCode | nullSí
actual_minorinteger (int64) | nullSíApproved and paid expenses posted to the line (app.budget_line_facts); null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
account_codeGlAccountCode | nullSí
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "budget_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01",
  "xyz": "X",
  "xyz_basis": "Rented inventory",
  "line_type": "Contingency",
  "grade_code": "base",
  "element_id": "4000.01.01-XPMS-001",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_basis": "each",
  "unit_price_minor": 4500,
  "line_total_minor": 108000,
  "line_number": 1,
  "phase_code": "SCP",
  "tier_code": "04",
  "actual_minor": 480000,
  "account_code": "5400"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/budget-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","xyz_basis":"Rented inventory","grade_code":"base","description":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1}'
const { data, etag } = await xos.budgetLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "xyz_basis": "Rented inventory",
    "grade_code": "base",
    "description": "Stage deck rental",
    "quantity": 24,
    "unit_price_minor": 4500,
    "line_number": 1
  }, { ifMatch: etag });
response = xos.budget_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "xyz_basis": "Rented inventory", "grade_code": "base", "description": "Stage deck rental", "quantity": 24, "unit_price_minor": 4500, "line_number": 1}, if_match=etag)
xos budget-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"cost_center_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","xyz_basis":"Rented inventory","grade_code":"base","description":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1}' --if-match auto