List Adjustment Types

Beta
GET/v1/finance/adjustment-types

This endpoint is idempotent. Learn more

Returns a paginated list of adjustment types.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:owner

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of adjustment_type

Resources in this page.

idstring

Adjustment type ID.

objectstringenumValues:adjustment_type

Resource type identifier.

namestring

Human-readable name of the adjustment type (e.g. "Discount").

codestringenumValues:discountshipping_discrepancyshort_payment

Machine-readable code identifying what kind of adjustment this is.

  • discount: a price reduction.
  • shipping_discrepancy: corrects a difference between quoted and actual freight.
  • short_payment: reconciles an invoice paid for less than the amount due.
  • write_off: cancels an uncollectible balance.
  • fee: an additional charge.
  • refund: returns money to the customer.
ownerownerExpandablenullable

Provenance of this adjustment type.

System-owned types are platform-provided defaults shared across all accounts; account-owned types are custom to one account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Adjustment Types