Skip to main content
PATCH
/
counterparts
/
{counterpart_id}
Update a counterpart
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/counterparts/{counterpart_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "individual": {
    "email": "asingh@example.net",
    "first_name": "Adnan",
    "is_customer": true,
    "is_vendor": true,
    "last_name": "Singh",
    "phone": "5553211234",
    "tag_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "title": "Mr."
  },
  "default_billing_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_reference": "123456789",
  "language": "ab",
  "reminders_enabled": true,
  "tax_id": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "individual": {
    "first_name": "Adnan",
    "is_customer": true,
    "is_vendor": true,
    "last_name": "Singh",
    "email": "asingh@example.net",
    "phone": "5553211234",
    "tags": [
      {
        "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
        "created_at": "2022-09-07T16:35:18.484507+00:00",
        "updated_at": "2022-09-07T16:35:18.484507+00:00",
        "name": "Marketing",
        "category": "department",
        "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
        "description": "Tag for the Marketing Department"
      }
    ],
    "title": "Mr."
  },
  "type": "individual",
  "created_automatically": false,
  "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_billing_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_reference": "123456789",
  "language": "ab",
  "reminders_enabled": true,
  "tax_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
counterpart_id
string<uuid>
required

Body

application/json

This schema is used to update existing counterparts (organizations or individuals).

​
individual
object
required

Represents counterparts that are individuals (natural persons).

​
default_billing_address_id
string<uuid>

ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If default_billing_address_id is not defined, the default address is instead used as the billing address for ACH payments.

​
default_shipping_address_id
string<uuid>

ID of the shipping address.

​
external_reference
string

A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity.

Required string length: 1 - 255
Example:

"123456789"

​
language
enum<string>

The language used to generate PDF documents for this counterpart.

Available options:
ab,
aa,
af,
ak,
sq,
am,
ar,
an,
hy,
av,
ae,
ay,
az,
bm,
ba,
eu,
be,
bn,
bi,
bs,
br,
bg,
my,
ca,
ch,
ce,
ny,
zh,
cu,
cv,
kw,
co,
cr,
hr,
cs,
da,
dv,
nl,
dz,
en,
eo,
et,
ee,
fo,
fj,
fi,
fr,
fy,
ff,
gd,
gl,
lg,
ka,
de,
el,
kl,
gn,
gu,
ht,
ha,
he,
hz,
hi,
ho,
hu,
io,
ig,
id,
ia,
ie,
iu,
ik,
ga,
it,
ja,
jv,
kn,
kr,
ks,
kk,
km,
ki,
rw,
ky,
kv,
kg,
ko,
kj,
ku,
lo,
la,
lv,
li,
ln,
lt,
lu,
lb,
mk,
mg,
ms,
ml,
mt,
gv,
mi,
mr,
mh,
mn,
na,
nv,
nd,
nr,
ng,
ne,
no,
nb,
nn,
ii,
oc,
oj,
om,
os,
pi,
ps,
fa,
pl,
pt,
pa,
qu,
ro,
rm,
rn,
ru,
se,
sm,
sg,
sa,
sc,
sr,
sn,
sd,
si,
sk,
sl,
so,
st,
es,
su,
sw,
ss,
sv,
tl,
ty,
tg,
ta,
tt,
te,
th,
bo,
ti,
to,
ts,
tn,
tr,
tk,
tw,
ug,
uk,
ur,
uz,
ve,
vi,
vo,
wa,
cy,
wo,
xh,
yi,
yo,
za,
zu
​
reminders_enabled
boolean
​
tax_id
string

The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered.

Maximum string length: 30

Response

Successful Response

A Counterpart object contains information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an SME.

​
id
string<uuid>
required

Unique ID of the counterpart.

​
created_at
string<date-time>
required

Date and time when the counterpart was created. Timestamps follow the ISO 8601 standard.

​
updated_at
string<date-time>
required

Date and time when the counterpart was last updated. Timestamps follow the ISO 8601 standard.

​
individual
object
required

Represents counterparts that are individuals (natural persons).

​
type
enum<string>
required

The counterpart type: organization (juridical person) or individual (natural person).

Available options:
individual,
organization
​
created_automatically
boolean
default:false

true if the counterpart was created automatically by Monite when processing incoming invoices with OCR. false if the counterpart was created by the API client.

​
created_by_entity_user_id
string<uuid>

Entity user ID of counterpart creator.

​
default_billing_address_id
string<uuid>

ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If default_billing_address_id is not defined, the default address is instead used as the billing address for ACH payments.

​
default_shipping_address_id
string<uuid>

ID of the shipping address.

​
external_reference
string

A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity.

Required string length: 1 - 255
Example:

"123456789"

​
language
enum<string>

The language used to generate PDF documents for this counterpart.

Available options:
ab,
aa,
af,
ak,
sq,
am,
ar,
an,
hy,
av,
ae,
ay,
az,
bm,
ba,
eu,
be,
bn,
bi,
bs,
br,
bg,
my,
ca,
ch,
ce,
ny,
zh,
cu,
cv,
kw,
co,
cr,
hr,
cs,
da,
dv,
nl,
dz,
en,
eo,
et,
ee,
fo,
fj,
fi,
fr,
fy,
ff,
gd,
gl,
lg,
ka,
de,
el,
kl,
gn,
gu,
ht,
ha,
he,
hz,
hi,
ho,
hu,
io,
ig,
id,
ia,
ie,
iu,
ik,
ga,
it,
ja,
jv,
kn,
kr,
ks,
kk,
km,
ki,
rw,
ky,
kv,
kg,
ko,
kj,
ku,
lo,
la,
lv,
li,
ln,
lt,
lu,
lb,
mk,
mg,
ms,
ml,
mt,
gv,
mi,
mr,
mh,
mn,
na,
nv,
nd,
nr,
ng,
ne,
no,
nb,
nn,
ii,
oc,
oj,
om,
os,
pi,
ps,
fa,
pl,
pt,
pa,
qu,
ro,
rm,
rn,
ru,
se,
sm,
sg,
sa,
sc,
sr,
sn,
sd,
si,
sk,
sl,
so,
st,
es,
su,
sw,
ss,
sv,
tl,
ty,
tg,
ta,
tt,
te,
th,
bo,
ti,
to,
ts,
tn,
tr,
tk,
tw,
ug,
uk,
ur,
uz,
ve,
vi,
vo,
wa,
cy,
wo,
xh,
yi,
yo,
za,
zu
​
reminders_enabled
boolean
​
tax_id
string

The counterpart's taxpayer identification number or tax ID.

Maximum string length: 30