Create a Counterparty - Bookeeping.ai Docs

POST

counterparties

Create a Counterparty

curl --request POST \
  --url https://api.bookeeping.ai/public-api/v1/counterparties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountName": "<string>",
  "accountNumber": "<string>",
  "type": "customer",
  "email": "jsmith@example.com",
  "otherEmails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "address": {},
  "taxId": "<string>"
}
'

{
  "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.

Body

application/json

accountName

string

required

The account name of the counterparty

accountNumber

string

required

The account number of the counterparty

type

enum<string>

required

The type of the counterparty

Available options:

customer,

vendor,

both

string<email> | null

otherEmails

string<email>[] | null

phone

string | null

address

object

The address of the counterparty

taxId

string | null

Response

Create a Counterparty executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

Show child attributes

data._id

string

required

The id of the counterparty

data.projectId

string

required

The project id of the counterparty

data.createdAt

string<date-time>

required

The created at of the counterparty

data.updatedAt

string<date-time>

required

The updated at of the counterparty

data.accountName

string | null

data.accountNumber

string | null

data.email

string<email> | null

data.phone

string | null

data.otherEmails

string<email>[] | null

data.type

enum<string> | null

Available options:

customer,

vendor,

both

data.taxId

string | null

data.address

object

The address of the counterparty

Get a Counterparty by IDGet a Counterparty by ID

⌘I

Create a Counterparty

curl --request POST \
  --url https://api.bookeeping.ai/public-api/v1/counterparties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountName": "<string>",
  "accountNumber": "<string>",
  "type": "customer",
  "email": "jsmith@example.com",
  "otherEmails": [
    "jsmith@example.com"
  ],
  "phone": "<string>",
  "address": {},
  "taxId": "<string>"
}
'

{
  "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": {}
  }
}

Routes

Authorizations

Body

Response