Better Proposals
App · Documents · 5 actions
Track the proposals on your Better Proposals account: list them by stage, read one back, and look up your templates and client companies.
Actions
| Action | What it does |
|---|---|
| Count proposals | Get the total number of proposals on your account, without fetching them all. |
| Get a proposal | Fetch the full details of one proposal by its ID. |
| List companies | List the client companies on your account, which proposals are addressed to. |
| List proposals | List the proposals on your Better Proposals account, optionally narrowed to a single stage such as signed or paid. |
| List templates | List the proposal templates on your account. |
Count proposals
Get the total number of proposals on your account, without fetching them all.
Inputs
None.
Outputs
countnumber- How many proposals the account has
Example output
{
"count": 245
}Get a proposal
Fetch the full details of one proposal by its ID.
Inputs
- Proposal ID
proposal_idtextRequired - The ID of the proposal, as returned by List proposals.
Outputs
amounttext- The proposal's total amount, as a decimal string
archivedtrue/false- Whether the proposal has been archived
company_idtext- ID of the company the proposal is addressed to
company_nametext- Name of the company the proposal is addressed to
contactslist- The people the proposal was sent to
currency_codetext- 3-letter currency code, for example 'USD'
date_createdtext- When the proposal was created
date_senttext- When the proposal was sent, or empty if it hasn't been
deletedtrue/false- Whether the proposal has been deleted
descriptiontext- The proposal's internal description
paidtrue/false- Whether the proposal has been paid
personal_messagetext- The personal message shown to the client
preview_urltext- Link to preview the proposal without tracking a view
proposal_idtext- Proposal ID. Use with Get a proposal.
proposal_view_urltext- Link to the proposal as the client sees it
signedtrue/false- Whether the client has signed the proposal
signed_nametext- The name typed or signed by the client, or empty if unsigned
subject_linetext- The proposal's subject line
tax_amounttext- The tax amount, as a decimal string
tax_labeltext- Label shown for the tax line, for example 'VAT'
Example output
{
"amount": "7000.75",
"archived": false,
"company_id": "111111",
"company_name": "Testing Company",
"contacts": [
{
"email": "name@email.com",
"first_name": "John",
"surname": "Smith"
}
],
"currency_code": "USD",
"date_created": "2022-06-13 07:40:08",
"date_sent": "2022-06-13 11:02:30",
"deleted": false,
"description": "",
"paid": false,
"personal_message": "API testing",
"preview_url": "https://betterproposals.io/proposal/index?ProposalID=gNWJcnvJ8aFmMYnIFIw5940XU&debug=yes",
"proposal_id": "219014",
"proposal_view_url": "https://betterproposals.io/2/proposals/view?id=98765",
"signed": false,
"signed_name": "",
"subject_line": "Proposal from Testing Company",
"tax_amount": "10.00",
"tax_label": "VAT"
}List companies
List the client companies on your account, which proposals are addressed to.
Inputs
None.
Outputs
companieslist- The account's client companies
Example output
{
"companies": [
{
"company_id": "2",
"date_created": "2022-01-04 10:12:00",
"name": "JB & Co Ltd"
}
]
}List proposals
List the proposals on your Better Proposals account, optionally narrowed to a single stage such as signed or paid.
Inputs
- Stage
statustext - Which proposals to return. Defaults to all proposals.One of:
all(All proposals),new,sent,opened,signed,paid. Default:all.
Outputs
proposalslist- The matching proposals
Example output
{
"proposals": [
{
"amount": "7000.75",
"company_name": "Testing Company",
"currency_code": "USD",
"date_created": "2022-06-13 07:40:08",
"date_sent": "2022-06-13 11:02:30",
"paid": false,
"preview_url": "https://betterproposals.io/proposal/index?ProposalID=gNWJcnvJ8aFmMYnIFIw5940XU&debug=yes",
"proposal_id": "219014",
"proposal_view_url": "https://betterproposals.io/2/proposals/view?id=98765",
"signed": false,
"subject_line": "Proposal from Testing Company"
}
]
}List templates
List the proposal templates on your account.
Inputs
None.
Outputs
templateslist- The account's templates
Example output
{
"templates": [
{
"date_created": "2014-09-19 17:33:38",
"description": "",
"is_default": true,
"name": "Default Template",
"template_id": "3"
}
]
}