Skip to main content
POST
/
v1
/
counterparties
Create a new counterparty
curl --request POST \
  --url https://api.nomi.tools/v1/counterparties \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "types": [],
  "externalId": "<string>",
  "notes": "<string>"
}
'
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication. Provide your email as login and PPT token as the password.

Headers

​
Accept
enum<string>
default:application/json
required
Available options:
application/json

Body

application/json
​
name
string
required

Name of the counterparty.

​
types
enum<string>[]

Types associated with the counterparty.

Available options:
client,
supplier,
partner,
contractor,
other
​
externalId
string | null

External identifier for the counterparty.

​
notes
string | null

Additional notes about the counterparty.

Response

Counterparty created successfully

​
id
string