Skip to main content
POST
Create distributions

Authorizations

Authorization
string
header
required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

X-Organization-Id
string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Required string length: 32
Pattern: ^org_[A-Za-z0-9]+$
Example:

"org_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Idempotency-Key
string

Only applies to POST, PUT, PATCH, and DELETE; ignored on reads.

Type: IdempotencyKey A unique key that makes a mutating request safely retryable, kept for 24 hours

Body

application/json
Required array length: 1 element
name
string
required
Minimum string length: 1
Example:

"November 9th Distribution from XYZ Sale"

vehicle
string
required

ID of the vehicle this distribution pays from

Required string length: 32
Pattern: ^veh_[A-Za-z0-9]+$
Example:

"veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w"

distribution_date
string<date-time>
required
ZonedDateTime

The date this distribution pays out, in distribution_timezone.

NOTE: An offset that does not match the zone on this date is rejected

Type: ZonedDateTime ISO 8601 Date and time in the record's TimeZone

Example:

"2026-09-09T09:00"

payments
object[]
required

List of payments

Minimum array length: 1
external_reference
string | null

Your own identifier for this distribution

Example:

"distribution-123"

distribution_timezone
string | null
default:UTC
TimeZone

The timezone distribution_date and every payments[].distribution_date_override are interpreted in, and rendered with in responses.

Type: TimeZone IANA timezone name

Example:

"America/Los_Angeles"

Response

Distribution created

Type: List A page of results

object
enum<string>
required

Object type identifier.

Available options:
list
Example:

"list"

data
object[]
required

The page of items.

next_page_url
string | null
required

URL for the next page of the list, or null when there are no more pages.

Example:

"/v1/distributions?page=page_5dr8SFDbv7rZ2aj4&limit=10"

previous_page_url
string | null
required

URL for the previous page of the list, or null when there are none.

Example:

"/v1/distributions?page_before=page_8VtqLBv3xJpY7mk2&limit=10"

has_more
boolean
required
deprecated

Whether there are more items available after this page. Deprecated: next_page_url is non-null exactly when more pages exist.

url
string
required
deprecated

Path identifying this list. Deprecated: on lists embedded in another object, or returned by a create, it may not be a GET endpoint you can call. Follow next_page_url / previous_page_url to paginate.

Example:

"/v1/distributions"