v2023-09-01
Search...
/
Support
Partner Portal
Home
Guides
API Reference
Home
Guides
API Reference
API Concepts
Overview
Environments and URLs
Authentication
API versioning
Rate limiting
HTTP headers
Pagination, sorting, and filtering
General
Access tokens
Partner settings
Webhook subscriptions
Webhook deliveries
Events
Common
Entities
Entity bank accounts
Entity persons
Entity VAT IDs
Roles
Entity users
Counterparts
Counterpart addresses
GET
Get a counterpart's addresses
POST
Create a counterpart address
GET
Get a counterpart's address
DEL
Delete a counterpart's address
PATCH
Update a counterpart's address
POST
Set a counterpart's default address
Counterpart bank accounts
Counterpart contacts
Counterpart VAT IDs
Payment records
Projects
Tags
Accounts payable
Approval policies
Approval requests
Comments
Payable line items
Payables
Purchase orders
Accounts receivable
Measure units
Overdue reminders
Payment reminders
Payment terms
Products
Receivables
Recurrences
VAT rates
Payments
Batch payments
Entity bank account verifications
Entity onboarding data
Onboarding documents
Onboarding links
Onboarding requirements
Payment intents
Payment links
Payment methods
Accounting integration
Accounting connections
Accounting data pull
Accounting synchronized records
Accounting tax rates
Ledger accounts
Utilities
Audit logs
Data export
Data export - extra data
Files
Mail templates
Mailbox domains
Mailboxes
PDF templates
Text templates
Support
Partner Portal
Common
Counterpart addresses
Create a counterpart address
POST
https://
api.sandbox.monite.com/v1
/
counterparts
/
:counterpart_id
/
addresses
Path parameters
counterpart_id
string
Required
Headers
Auth
Authorization
string
Required
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-version
string
Required
x-monite-entity-id
string
Required
The ID of the entity that owns the requested resource.
Request
This endpoint expects an object.
city
string
Required
City name.
country
enum
Required
Two-letter ISO country code (
ISO 3166-1 alpha-2
).
Show 252 enum values
line1
string
Required
Street address.
postal_code
string
Required
ZIP or postal code.
line2
string
Optional
Additional address information (if any).
state
string
Optional
State, region, province, or county.
Response
This endpoint returns an object.
id
string
Unique ID of the address in the system
city
string
City name.
counterpart_id
string
ID of the counterpart that owns the address.
country
enum
Two-letter ISO country code (
ISO 3166-1 alpha-2
).
Show 252 enum values
is_default
boolean
True if address is the default address of the counterpart.
line1
string
Street address.
postal_code
string
ZIP or postal code.
line2
string
Optional
Additional address information (if any).
state
string
Optional
State, region, province, or county.
Errors
404
Not Found
422
Unprocessable Entity
500
Internal Server Error