Get all counterparts

GET

/counterparts

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

ibanstringOptional<=34 characters

The IBAN of the counterpart’s bank account.

sort_codestringOptional<=100 characters

The bank’s sort code.

account_numberstringOptional<=100 characters

The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.

tax_idstringOptional<=30 characters

The tax ID of the counterpart.

vat_idstringOptional<=30 characters

The VAT ID of the counterpart.

id__instringOptional

A list of counterpart IDs to search through.

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional>=1<=100

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sort"counterpart_name"OptionalDefaults to counterpart_name

Allowed sort fields

type"individual" or "organization"Optional

Allowed values: individualorganization

counterpart_namestringOptional

counterpart_name__iexactstringOptional

counterpart_name__containsstringOptional

counterpart_name__icontainsstringOptional

is_vendorbooleanOptionalDefaults to false

is_customerbooleanOptionalDefaults to false

emailstringOptional

email__containsstringOptional

email__icontainsstringOptional

created_at__gtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__ltdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__gtedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__ltedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

address.countrystringOptional

address.citystringOptional

address.postal_codestringOptional

address.statestringOptional

address.line1stringOptional

address.line2stringOptional

tag_ids__instringOptional

Response

Successful Response

datalist of objects

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

GET

1 curl -G https://api.sandbox.monite.com/v1/counterparts \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>" \
5      -d sort_code=123456

1 {
2   "data": [
3     {
4       "id": "id",
5       "created_at": "2024-01-15T09:30:00Z",
6       "updated_at": "2024-01-15T09:30:00Z",
7       "created_automatically": true,
8       "default_billing_address_id": "default_billing_address_id",
9       "default_shipping_address_id": "default_shipping_address_id",
10       "created_by_entity_user_id": "created_by_entity_user_id",
11       "individual": {
12         "email": "asingh@example.net",
13         "first_name": "Adnan",
14         "is_customer": true,
15         "is_vendor": true,
16         "last_name": "Singh",
17         "phone": "5553211234",
18         "tags": [
19           {
20             "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
21             "created_at": "2022-09-07T16:35:18Z",
22             "updated_at": "2022-09-07T16:35:18Z",
23             "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
24             "description": "Tag for the Marketing Department",
25             "name": "Marketing"
26           }
27         ],
28         "title": "Mr."
29       },
30       "language": "ab",
31       "reminders_enabled": true,
32       "tax_id": "tax_id",
33       "type": "individual"
34     }
35   ],
36   "next_pagination_token": "next_pagination_token",
37   "prev_pagination_token": "prev_pagination_token"
38 }

Create a counterpart

Up Next

1	curl -G https://api.sandbox.monite.com/v1/counterparts \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-d sort_code=123456

1	{
2	"data": [
3	{
4	"id": "id",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"created_automatically": true,
8	"default_billing_address_id": "default_billing_address_id",
9	"default_shipping_address_id": "default_shipping_address_id",
10	"created_by_entity_user_id": "created_by_entity_user_id",
11	"individual": {
12	"email": "asingh@example.net",
13	"first_name": "Adnan",
14	"is_customer": true,
15	"is_vendor": true,
16	"last_name": "Singh",
17	"phone": "5553211234",
18	"tags": [
19	{
20	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
21	"created_at": "2022-09-07T16:35:18Z",
22	"updated_at": "2022-09-07T16:35:18Z",
23	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
24	"description": "Tag for the Marketing Department",
25	"name": "Marketing"
26	}
27	],
28	"title": "Mr."
29	},
30	"language": "ab",
31	"reminders_enabled": true,
32	"tax_id": "tax_id",
33	"type": "individual"
34	}
35	],
36	"next_pagination_token": "next_pagination_token",
37	"prev_pagination_token": "prev_pagination_token"
38	}