Note API Reference

Save time by creating notes and reusing them on your invoices & estimates.

The Note model

Notes serve as additional information within the context of estimates and invoices. They include a name, type, and the detailed notes themselves. Businesses can leverage notes to provide specific details, instructions, or explanations related to items, services, or transactions. This feature enhances communication and clarity, allowing for a more comprehensive and transparent interaction with customers during the estimation and invoicing processes.

Properties

Name
id
Type
string
Description
Unique identifier for the note.
Name
type
Type
string
Description
Type of the note. Must be one of Invoice or Estimate.
Name
name
Type
string
Description
Name of the note.
Name
notes
Type
string
Description
Description for what you are writing this note for.

GETapi/v2/notes

List all notes

This endpoint allows you to retrieve a list of your notes.

Parameters

Name
limit
Type
integer
Description
A limit on the number of notes to be returned.
Name
page
Type
integer
Description
Page number (for pagination).

Request

GET

api/v2/notes

curl --request GET \
  --get "https://payments.your-domain.com/api/v2/notes" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d"

Response

{
  "data": [
    {
      "id": "9907a673-17a0-4444-9287-96d0609851e4",
      "type": "Estimate",
      "name": "Estimate Issued",
      "notes": "Please review the attached estimate at your earliest convenience. Note that the estimated pricing is subject to change based on market conditions and availability of resources."
    },
    {
      "id": "d8578edf-5d26-4b2b-9a1b-2454c1e5f073",
      "type": "Invoice",
      "name": "Invoice Payment",
      "notes": "The payment for the attached invoice is due within the standard 5-business-day term as per our payment policy. Prompt payment ensures uninterrupted service."
    }
  ]
}

POSTapi/v2/notes

Create a note

This endpoint allows you create a new note.

Parameters

Name
name
Type
string
Description
Name of the note.
Name
type
Type
string
Description
Type of the note. Must be one of Invoice or Estimate.
Name
notes
Type
string
Description
Description for the note.

Request

POST

api/v2/notes

curl --request POST \
  "https://payments.your-domain.com/api/v2/notes" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
  --data "{
    \"name\": \"Invoice note\",
    \"type\": \"Invoice\",
    \"notes\": \"The payment for the attached invoice is due within the standard 5-business-day term as per our payment policy.\"
  }"

Response

{
  "data": {
    "id": "990176fd-4f1f-4102-8cc4-a5f3e678a9a9",
    "type": "Invoice",
    "name": "Invoice note",
    "notes": "The payment for the attached invoice is due within the standard 5-business-day term as per our payment policy."
  }
}

GETapi/v2/notes/{id}

Retrieve a note

This endpoint allows you to retrieve a note object.

Parameters

Name
id
Type
string
Description
ID of the note.

Request

GET

api/v2/notes/{id}

curl --request GET \
  --get "https://payments.your-domain.com/api/v2/notes/990176fd-4f1f-4102-8cc4-a5f3e678a9a9" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d"

Response

{
  "data": {
    "id": "990176fd-4f1f-4102-8cc4-a5f3e678a9a9",
    "type": "Invoice",
    "name": "Invoice note",
    "notes": "The payment for the attached invoice is due within the standard 5-business-day term as per our payment policy."
  }
}

PUTapi/v2/notes/{id}

Update a note

This endpoint allows you to perform an update on a note.

Parameters

Name
id
Type
string
Description
The ID of the note.
Name
name
Type
string
Description
Name of the note.
Name
type
Type
string
Description
Type of the note. Must be one of Invoice or Estimate.
Name
notes
Type
string
Description
Description for what you are writing this note for.

Request

PUT

api/v2/notes/990176fd-4f1f-4102-8cc4-a5f3e678a9a9

curl --request PUT \
  "https://payments.your-domain.com/api/v2/notes/990176fd-4f1f-4102-8cc4-a5f3e678a9a9" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
  --data "{
    \"name\": \"Invoice note\",
    \"type\": \"Invoice\",
    \"notes\": \"The payment for the attached invoice is due within the standard 6-business-day term as per our payment policy.\"
  }"

Response

{
  "data": {
    "id": "990176fd-4f1f-4102-8cc4-a5f3e678a9a9",
    "type": "Invoice",
    "name": "Invoice note",
    "notes": "The payment for the attached invoice is due within the standard 6-business-day term as per our payment policy."
  }
}

DELETEapi/v2/notes/{id}

Delete a note

This endpoint allows you to delete a note.

Request

DELETE

api/v2/notes/{id}

curl --request DELETE \
  "https://payments.your-domain.com/api/v2/notes/990176fd-4f1f-4102-8cc4-a5f3e678a9a9" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d"

Response

{
  "id": "990176fd-4f1f-4102-8cc4-a5f3e678a9a9",
  "object": "Note",
  "deleted": true
}