GET
List related parties (organization)
Organization space Accounting module For: Accountant · Permission: related_parties.list Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • auxiliary_type, when sent, must be customer or vendor.
  • relation, when sent, must be parent, subsidiary, sister or other.
  • Sorted by name, ascending, unless sort_by (name or created_at) and sort_order are sent; per_page is 1 to 100, default 25.
Part of Declare transfer pricing.

Authorizations

Authorization
string
header
required

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

Path Parameters

book
string
required

Identifier of the accounting book (27-character KSUID string) whose records are worked on.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
name,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
auxiliary_type
enum<string> | null

Keeps only related parties that are customers (customer) or vendors (vendor).

Available options:
customer,
vendor
relation
enum<string> | null

Keeps only related parties with this relation: parent, subsidiary, sister or other.

Available options:
parent,
subsidiary,
sister,
other
response
enum<string>
default:resource

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

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, auxiliary_type, auxiliary_id, counterparty_owner_type, counterparty_owner_id, name, country_code, relation, transfer_pricing_method, loan_account_id, loan_interest_bearing, loan_interest_rate, created_by, created_by_type, created_at, updated_at, is_internal, is_declarable.

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: .

Response

Resource.

data
RelatedPartyResource · object[]
required

Items of this page.

meta
object
required

Pagination details.