Estimate Link API Reference

This API reference provides information on how to generate and retrieve link to view estimates.

Estimate Links provide a convenient way to facilitate the approval or rejection of estimates. Generated using the estimate ID, these links enable efficient collaboration between businesses and customers. By sharing the Estimate Link, customers can easily review and take action on the estimate, streamlining the approval process and enhancing communication in the estimation workflow.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the estimate link.

  • Name
    url
    Type
    string
    Description

    The url of the estimate link.

  • Name
    expiry_date
    Type
    string
    Description

    The expiry date of the estimate link.

GETapi/v2/estimates/{estimate_id}/links

This endpoint allows you to retrieve a paginated list of all your estimate links.

Parameters

  • Name
    limit
    Type
    integer
    Description

    A limit on the number of estimate links to be returned on a single page.

  • Name
    page
    Type
    integer
    Description

    Page number (for pagination).

Request

GET
api/v2/estimates/{estimate_id}/links
curl --request GET \
  --get "https://payments.your-domain.com/api/v2/estimates/99745a4e-7a6b-4be4-a87e-2826e457ae06/links" \
  --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": "9994644f-ea38-4fa9-9da0-635839446f40",
      "url": "https://payments.your-domain.com/public/estimates/view/9994644f-ea38-4fa9-9da0-635839446f40?
      signature=e33c035bd56b9951f5191f6803fb5e03d46c1a014134b3a394dd80ca94665e43",
      "expiry_date": "1689565444",
      "estimate_id": "99745a4e-7a6b-4be4-a87e-2826e457ae06",
      "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
    },
    {
      "id": "9990ee27-2ce2-46a4-87b8-545aea88cc55",
      "url": "https://payments.your-domain.com/public/estimates/view/9990ee27-2ce2-46a4-87b8-545aea88cc55?
      signature=e33c035bd56b9951f5191f6803fb5e03d46c1a014134b3a394dd80ca94665e43",
      "expiry_date": "1689565444",
      "estimate_id": "99745a4e-7a6b-4be4-a87e-2826e457ae06",
      "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
    }
  ]
}
POSTapi/v2/estimates/{estimate_id}/links

This endpoint allows you to create a new estimate link.

Parameters

  • Name
    estimate_id
    Type
    string
    Description

    The id of the estimate.

Optional Parameters

  • Name
    expiry_date
    Type
    string
    Description

    The expiry date of the estimate link.

Request

POST
api/v2/estimates/{estimate_id}/links
curl --request POST \
  "https://payments.your-domain.com/api/v2/estimates/99745a4e-7a6b-4be4-a87e-2826e457ae06/links" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
  --data '{"expiry_date": "1689565444"}'

Response

{
  "data": {
    "id": "9994644f-ea38-4fa9-9da0-635839446f40",
    "url": "https://payments.your-domain.com/public/estimates/view/9994644f-ea38-4fa9-9da0-635839446f40?
      signature=e33c035bd56b9951f5191f6803fb5e03d46c1a014134b3a394dd80ca94665e43",
    "expiry_date": "1689565444",
    "estimate_id": "99745a4e-7a6b-4be4-a87e-2826e457ae06",
    "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
  }
}
GETapi/v2/estimates/{estimate_id}/links/{estimate_link_id}

This endpoint allows you to retrieve an estimate link.

Parameters

  • Name
    estimate_id
    Type
    string
    Description

    The id of the estimate.

  • Name
    estimate_link_id
    Type
    string
    Description

    The id of the estimate link.

Request

GET
api/v2/estimates/{estimate_id}/links/{estimate_link_id}
curl --request GET \
  --get "https://payments.your-domain.com/api/v2/estimates/99745a4e-7a6b-4be4-a87e-2826e457ae06/links/9994644f-ea38-4fa9-9da0-635839446f40" \
  --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": "9994644f-ea38-4fa9-9da0-635839446f40",
    "url": "https://payments.your-domain.com/public/estimates/view/9994644f-ea38-4fa9-9da0-635839446f40?
    signature=e33c035bd56b9951f5191f6803fb5e03d46c1a014134b3a394dd80ca94665e43",
    "expiry_date": "1689565444",
    "estimate_id": "99745a4e-7a6b-4be4-a87e-2826e457ae06",
    "business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d"
  }
}
DELETEapi/v2/estimates/{estimate_id}/links/{estimate_link_id}

This endpoint allows you to delete a specific estimate link

Parameters

  • Name
    estimate_id
    Type
    string
    Description

    The id of the estimate.

  • Name
    estimate_link_id
    Type
    string
    Description

    The id of the estimate link.

Request

DELETE
api/v2/estimates/{estimate_id}/links/{estimate_link_id}
curl --request DELETE \
  "https://payments.your-domain.com/api/v2/estimates/99745a4e-7a6b-4be4-a87e-2826e457ae06/links/9994644f-ea38-4fa9-9da0-635839446f40" \
  --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d"

Response

{
  "id": "9994644f-ea38-4fa9-9da0-635839446f40",
  "object": "EstimateLink",
  "deleted": true
}