# Better Proposals

> Track the proposals on your Better Proposals account: list them by stage, read one back, and look up your templates and client companies.

App · Documents · 5 actions. Web page: https://docs.lodol.com/docs/integrations/better-proposals

## Actions

### Count proposals

Get the total number of proposals on your account, without fetching them all.

**Inputs**: None.

**Outputs**

- `count` (number): How many proposals the account has

**Example output**

```json
{
  "count": 245
}
```

### Get a proposal

Fetch the full details of one proposal by its ID.

**Inputs**

- Proposal ID (`proposal_id`, text, required): The ID of the proposal, as returned by List proposals.

**Outputs**

- `amount` (text): The proposal's total amount, as a decimal string
- `archived` (true/false): Whether the proposal has been archived
- `company_id` (text): ID of the company the proposal is addressed to
- `company_name` (text): Name of the company the proposal is addressed to
- `contacts` (list): The people the proposal was sent to
- `currency_code` (text): 3-letter currency code, for example 'USD'
- `date_created` (text): When the proposal was created
- `date_sent` (text): When the proposal was sent, or empty if it hasn't been
- `deleted` (true/false): Whether the proposal has been deleted
- `description` (text): The proposal's internal description
- `paid` (true/false): Whether the proposal has been paid
- `personal_message` (text): The personal message shown to the client
- `preview_url` (text): Link to preview the proposal without tracking a view
- `proposal_id` (text): Proposal ID. Use with Get a proposal.
- `proposal_view_url` (text): Link to the proposal as the client sees it
- `signed` (true/false): Whether the client has signed the proposal
- `signed_name` (text): The name typed or signed by the client, or empty if unsigned
- `subject_line` (text): The proposal's subject line
- `tax_amount` (text): The tax amount, as a decimal string
- `tax_label` (text): Label shown for the tax line, for example 'VAT'

**Example output**

```json
{
  "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**

- `companies` (list): The account's client companies

**Example output**

```json
{
  "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 (`status`, text): Which proposals to return. Defaults to all proposals. One of: `all` (All proposals), `new`, `sent`, `opened`, `signed`, `paid`. Default: `all`.

**Outputs**

- `proposals` (list): The matching proposals

**Example output**

```json
{
  "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**

- `templates` (list): The account's templates

**Example output**

```json
{
  "templates": [
    {
      "date_created": "2014-09-19 17:33:38",
      "description": "",
      "is_default": true,
      "name": "Default Template",
      "template_id": "3"
    }
  ]
}
```