Proposals

Query Proposal Templates

Returns a list of proposal templates of your organization.

GET https://api.arcsite.com/v1/proposal_templates

cURL

curl "https://api.arcsite.com/v1/proposal_templates" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/proposal_templates", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/proposal_templates",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

[
  {
    "id": "36029621652695041",
    "name": "Proposal Template 1"
  }
]

Query Parameters

Parameter	Default	In	Description
page	1	query	Request a specific page
per_page	10	query	Page size

Query Proposals

Returns a list of proposals of your organization. You can filter by project and paginate; proposals are sorted by most recent activity first. For a change order chain, only the latest version is returned; see Change Orders.

GET https://api.arcsite.com/v1/proposals

cURL

curl "https://api.arcsite.com/v1/proposals" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/proposals", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/proposals",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

[
  {
    "proposal_id": "123",
    "project_id": "456",
    "name": "Main Building Proposal",
    "status": "APPROVED",
    "sales_representative": "John Doe",
    "contact_email": "john@example.com",
    "customer_name": "Jane Smith",
    "customer_email": "jane@example.com",
    "document_number": "PROP-2024-001",
    "template_id": "36029621652695041",
    "total": 15000.0,
    "pdf_url": "https://d1umxpetlubu85.cloudfront.net/36029346774973628/36029621653386370/36029621653386685/c6f62f3d-db06-42df-8138-91d80e792e5d/Drawing_1_Pre-Survey_Proposal_-281-29-page_03_test-page_02_test.pdf",
    "approved_option": {
      "id": "789",
      "drawing_id": "abc123def456",
      "drawing_version_id": "441f328-1a1b-4882-bd26-c86ee5a7bb0f"
    },
    "initial_proposal_id": "111"
  }
]

Query Parameters

Parameter	Default	In	Description
project_id	-	query	(optional) Project ID to filter proposals.
page	1	query	(optional) Request a specific page.
per_page	10	query	(optional) Page size.

Proposal

Each item in the response array is a Proposal object with the following fields. Some fields are returned only for specific statuses.

Parameter	Type	Description
proposal_id	String	Proposal ID
project_id	String	Project ID the proposal belongs to
name	String	Proposal name
status	String	Proposal status. See the status values below.
sales_representative	String	Name of the sales representative
contact_email	String	Email of the sales representative
customer_name	String	Customer name
customer_email	String	Customer email
document_number	String	Proposal document number
template_id	String	Proposal template ID
close_note	String	(optional) Reason for closing the proposal. Present when status is VOID or LOST.
total	Number	(optional) Total amount of the proposal. Present once the proposal is approved: status is APPROVED, PARTIALLY_PAID, PAID or OVER_PAID. For a change order, this is the full revised amount; see Change Orders.
pdf_url	String	(optional) URL of the proposal PDF file. Present once the proposal is approved.
approved_option	ApprovedOption	(optional) Approved option information. Present once the proposal is approved.
initial_proposal_id	String	(optional) ID of the initial proposal. Only present for change order proposals.

ApprovedOption

Parameter	Type	Description
id	String	(optional) ID of the approved option, only for online approvals.
drawing_id	String	ID of the associated drawing resource.
drawing_version_id	String	(optional) ID of the approved drawing version, only for online approvals.

Note

The status field is an enum with the following values:

• DRAFT: When a new proposal is created
• PENDING: When a proposal is sent to the customer
• ESIGNED_BY_CLIENT: When the customer has e-signed the proposal and it is waiting for the sales representative to counter-sign
• APPROVED: When a proposal is approved or e-signed
• PARTIALLY_PAID: When an approved proposal has received part of its payment
• PAID: When an approved proposal has been paid in full
• OVER_PAID: When the payments received exceed the proposal total
• VOID: When a proposal is marked as void
• LOST: When a proposal is marked as lost
• EXPIRED: When a sent proposal passes its expiration date without being approved

Note

The pdf_url field is typically a time-limited URL for 24 hours. You should download the PDF soon after retrieving it.

Get Proposal by ID

Returns one proposal by proposal ID. The response uses the same base Proposal fields as Query Proposals. For online proposals, the response also includes proposal_options, which can be used to link unsold proposals to the drawing versions they were generated from.

GET https://api.arcsite.com/v1/proposals/<proposal_id>

cURL

curl "https://api.arcsite.com/v1/proposals/<proposal_id>" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/proposals/<proposal_id>", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/proposals/<proposal_id>",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "proposal_id": "123",
  "project_id": "456",
  "name": "Main Building Proposal",
  "status": "PENDING",
  "sales_representative": "John Doe",
  "contact_email": "john@example.com",
  "customer_name": "Jane Smith",
  "customer_email": "jane@example.com",
  "document_number": "PROP-2024-001",
  "template_id": "36029621652695041",
  "proposal_options": [
    {
      "id": "789",
      "name": "Option 1",
      "drawing_id": "abc123def456",
      "drawing_version_id": "441f328-1a1b-4882-bd26-c86ee5a7bb0f",
      "total": 15000.0,
      "pdf_url": "https://d1umxpetlubu85.cloudfront.net/36029346774973628/36029621653386370/36029621653386685/c6f62f3d-db06-42df-8138-91d80e792e5d/Drawing_1_Pre-Survey_Proposal_-281-29-page_03_test-page_02_test.pdf"
    }
  ]
}

Parameters

Parameter	Type	Description
proposal_id	String	(required) Proposal ID

Response Schema

The response is a Proposal object with the fields documented in the Proposal schema. Online proposals also include the following field:

Parameter	Type	Description
proposal_options	List[ProposalOption]	(optional) Full list of proposal options for online proposals, including drawing and PDF details

ProposalOption

Parameter	Type	Description
id	String	ID of this proposal option
name	String	Proposal option name
drawing_id	String	ID of the drawing resource used to generate this option
drawing_version_id	String	ID of the drawing version used to generate this option
total	Number	Total amount for this proposal option
pdf_url	String	Time-limited URL of the proposal option PDF file

Note

For pending or draft online proposals, the top-level approved_option and pdf_url fields are not returned. Use proposal_options to access the drawing IDs and option PDF URLs.

For an approved online proposal, match approved_option.id to proposal_options[].id to identify the approved option. Different options can share a drawing_id, so the drawing ID alone does not identify the approved option.

const approvedOption = data.proposal_options.find(
  (option) => option.id === data.approved_option.id,
);

Export Proposal PDF

Export Proposal PDF by giving the proposal template id.

POST https://api.arcsite.com/v1/export_proposal_pdf

cURL

curl "https://api.arcsite.com/v1/export_proposal_pdf" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/export_proposal_pdf", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/export_proposal_pdf",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "url": "https://d1umxpetlubu85.cloudfront.net/36029346774973628/36029621653386370/36029621653386685/c6f62f3d-db06-42df-8138-91d80e792e5d/Drawing_1_Pre-Survey_Proposal_-281-29-page_03_test-page_02_test.pdf"
}

Parameters

Parameter	Type	Description
template_id	String	(required) Template id from Query proposal templates
drawing_id	String	(required) Drawing id

Note

The returned url will expire in 24 hours.

Get Proposal Payments

Returns a list of payments that have been received for the specified proposal.

GET https://api.arcsite.com/v1/proposals/<proposal_id>/payments

cURL

curl "https://api.arcsite.com/v1/proposals/<proposal_id>/payments" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/proposals/<proposal_id>/payments", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/proposals/<proposal_id>/payments",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

[
  {
    "paid_amount": 2500.0,
    "pay_channel": "arcsite_payment",
    "paid_time": "2025-11-06T10:15:30Z",
    "payment_method": "Credit Card",
    "status": "succeeded",
    "refunded_amount": 500.0
  },
  {
    "paid_amount": 1000.0,
    "pay_channel": "mark_as_paid",
    "paid_date": "2025-11-07",
    "payment_method": "Check",
    "status": "succeeded"
  }
]

Response Schema

The response is an array of Payment objects with the following fields:

Field	Type	Description
paid_amount	Number	The amount paid
pay_channel	String	Channel through which payment was received. Values: arcsite_payment or mark_as_paid
paid_time	String	ISO 8601 datetime when payment was received. Present when pay_channel is arcsite_payment
paid_date	String	Date when payment was recorded (YYYY-MM-DD format). Present when pay_channel is mark_as_paid
payment_method	String	Method of payment (e.g., “Credit Card”, “Check”, “ACH”)
status	String	Payment status. Values: succeeded (payment successful) or returned (ACH Return occurred)
refunded_amount	Number	(optional) Amount refunded. Only included for payments that have at least one refund record. Subtract this from paid_amount to get the net amount received

Change Orders

A change order revises a proposal that has already been approved. ArcSite creates it as a new proposal in the same chain as the original, and it carries initial_proposal_id, the ID of the first proposal in the chain.

• The total of a change order is the full revised contract amount, not the amount added or removed. Use it in place of the earlier version’s total; do not add the two together.
• Each new change order replaces the previous version. Query Proposals returns only the latest version in each chain. Earlier versions are still available from Get Proposal by ID.
• A change order has no total until it is approved. Keep the amount of the last approved version until then.
• Get Proposal Payments for a change order includes the payments received on the earlier versions in its chain.