PUT
Edit a related party (client account)
Client space Accounting module For: Accountant · Permission: related_parties.update Conditions
  • The accounting module must be part of the organization’s plan.
  • Only name, country_code, relation, transfer_pricing_method and the loan fields (loan_account_id, loan_interest_bearing, loan_interest_rate) can be changed. The third party and the counterparty book never change: declare another related party instead.
  • Fields left out keep their value. A null for name, country_code or relation keeps the stored value; a null for transfer_pricing_method or for a loan field clears it.
  • The values follow the same rules as when the party is declared; the loan account may be the one the party already names, but not one another party names.
What else happens
  • A transfer-pricing draft built before the change becomes stale when the party is declared (established outside Benin), before or after the change, and must be regenerated before it is filed.
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

Identifier of the related party (27-character KSUID string), one of the book.

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, 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 (only with response=resource).

id

Identifier of the related party (27-character KSUID string).

owner_type

Kind of book that holds the related party: organization, company or client account.

auxiliary_type

Whether the related party is a customer or a vendor of the book.

auxiliary_id

Identifier of the customer or vendor declared as related party (27-character KSUID string).

counterparty_owner_type

Kind of that other book (organization or company); null when the party is outside Exowpee.

counterparty_owner_id

Identifier of the other book of the organization that the party stands for (27-character KSUID string); null when the party is outside Exowpee.

name

Name of the related party.

country_code

Country where the party is established (ISO 3166-1 alpha-2, capitals).

relation

Relation to the entity: parent, subsidiary, sister, or other (a party in a privileged tax territory without such a link).

transfer_pricing_method

Method that justifies the prices with the party: cup, mpr, mprm, mtmn, mpb or autres; null when none was entered.

loan_account_id

Identifier of the account of the book that carries the loan with the party (27-character KSUID string); null when there is no loan.

loan_interest_bearing
boolean | null

Whether the loan bears interest; null when not answered.

loan_interest_rate

Interest rate of the loan as entered, free text such as a rate plus a reference; null when not entered.

is_internal
boolean

Whether the party is another book of the same organization (a counterparty book is named) rather than an entity outside Exowpee.

is_declarable
boolean

Whether the transfer-pricing declaration covers the party: true unless it is established in Benin (BJ).

created_by

Identifier of the member or agent account who declared it; null when the actor could not be resolved.

created_by_type

Kind of actor in created_by (member or agent account); null when none could be resolved.

created_at

When the related party was declared, ISO 8601.

updated_at

When the related party was last changed, ISO 8601.