PUT
Set line cost allocations (organization)
Organization space Accounting module For: Accountant · Permission: analytic_sections.update Conditions
  • The accounting module must be included in the plan of the organization.
  • The caller must have been granted access to the book named in the path.
  • The caller also needs journal_entries.retrieve on the journal entry that holds the line.
  • The journal line must belong to the book.
  • The allocations array must be present; an empty array removes every allocation of the line.
  • Each allocation needs analytic_axis_id (an active axis of the book), analytic_section_id and amount (integer of at least 1, in minor units).
  • Each section must exist in the book, be active, belong to the axis named in the same row, be postable and have no child sections; it is also refused when its axis is not active.
  • The same axis and section pair cannot appear twice in the request.
  • The line’s account must be of an allocable class (6, 7 or 8 by default).
  • Lines of the fiscal-year closing entry cannot be allocated.
  • The line’s entry must be posted and must not be a reversal; a reversed or refunded entry and its reversal keep the split they had.
  • The fiscal year of the line’s entry must not have filed statements. A closed period does not block allocation.
  • For every axis present in the request, the amounts must add up exactly to the line amount. An axis not present is left unallocated.
What else happens
  • Deletes the previous allocations of the line (all axes, including those created by rules or explicit targets at posting) and inserts the new ones with source manual, created by the current actor.
  • Nothing else changes: allocating does not alter the journal entry, balances or the books.
  • The reports of the analytic section (balance, income statement, section lines, unallocated worklist) reflect the new split immediately.
Part of Allocate lines and read analytic reports.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

journalLine
string
required

Identifier of the book (27-character KSUID string): the organization itself or one of its companies. The generated name is misleading; this segment is the book, not the line or section.

journal_line
string
required

Identifier of the journal line (27-character KSUID string) whose allocations are read or replaced.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, journal_line_id, analytic_axis_id, analytic_section_id, amount, source, created_by, created_by_type, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: axis, section, section.axis, section.parent.

Response

Resource (only with response=resource).

data
AnalyticAllocationResource · object[]
required

Items of this page.