API Reference
  1. Company
  2. Allocations

Create allocations

post
https://{hostname}/api/v1/allocations

Create one or more allocations in a single request. Each entry must
include either sourceId or id. For sub-class entries
(subClass: true), also provide parentRef.value or parentId.
Requires Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
allocations
array of objects
required
length ≥ 1
allocations*

Allocation payload used by both create and update. Provide either
sourceId or id. When subClass is true, also provide
parentRef.value or parentId.

string
required

The allocation type (e.g. ClassRef, DepartmentRef).

string

The allocation's display name.

string

The fully qualified name, including any parent hierarchy.

boolean

Whether this is a sub-class of a parent allocation. When true, parentRef.value or parentId must be provided.

parentRef
object | null

A reference to the parent allocation by external identifier.

string

The parent allocation's unique identifier.

string

The allocation's identifier in your source system (e.g. QuickBooks). One of sourceId or id is required.

string

The allocation's unique identifier in Outpave. One of sourceId or id is required.

boolean

Whether the allocation is active.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?