Skip to main content
PATCH
/
v1
/
counterparties
/
{id}
Update a Counterparty
curl --request PATCH \
  --url https://api.bookeeping.ai/public-api/v1/counterparties/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "otherEmails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "address": {},
  "taxId": "<string>",
  "accountName": "<string>",
  "accountNumber": "<string>",
  "type": "customer"
}
'
{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "_id": "<string>",
    "projectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accountName": "<string>",
    "accountNumber": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "otherEmails": [
      "jsmith@example.com"
    ],
    "type": "customer",
    "taxId": "<string>",
    "address": {}
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Path Parameters

​
id
string
required

The id of the counterparty. Expected to be a valid object id like 666666666666666666666666

Body

application/json
​
email
string<email> | null
​
otherEmails
string<email>[] | null
​
phone
string | null
​
address
object

The address of the counterparty

​
taxId
string | null
​
accountName
string

The account name of the counterparty

​
accountNumber
string

The account number of the counterparty

​
type
enum<string>

The type of the counterparty

Available options:
customer,
vendor,
both

Response

Update a Counterparty executed successfully

​
message
string

Success message

​
metaData
object
​
data
object