Record a payment against an invoice

POST

/api/v1/invoices/{id}/payments

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/invoices/example/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amount": 1, "payment_method": "cash", "transaction_id": "example", "payment_date": "2026-04-15T12:00:00Z", "notes": "example" }'

Updates the paid amount and moves the invoice to partial or paid.

Authorizations

• bearerJwt
• personalAccessToken
  write:invoices
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

amount

required

number

> 0

payment_method

required

string

Allowed values: cash bank_transfer cheque credit_card online stripe razorpay other

transaction_id

string

<= 500 characters

payment_date

string format: date-time

notes

Any of:

string

string

<= 2000 characters

null

null

Responses

201

The updated invoice

Media typeapplication/json

object

invoice

required

object

_id

required

string

invoice_number

required

string

status

required

string

lead_id

required

string

lead_name

required

string | null

total

required

number

amount_paid

required

number

balance_due

required

number

key

additional properties

any

Example^generated

{
  "invoice": {
    "_id": "example",
    "invoice_number": "example",
    "status": "example",
    "lead_id": "example",
    "lead_name": "example",
    "total": 1,
    "amount_paid": 1,
    "balance_due": 1
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}