NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Better Proposals connects to a Nagent workspace with an API key. Once it is connected, agents can call 23 Better Proposals actions, such as "Create Company", "Create Document Type" and "Create Proposal Cover". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Better Proposals, with input parameters and output schema.
BETTER_PROPOSALS_CREATE_COMPANYTool to create a new company. Use after confirming the company does not already exist.
Input parameters
Company name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_CREATE_DOCUMENT_TYPETool to create a new document type. Use after confirming the desired type name does not already exist.
Input parameters
Document type name
Hex colour for your new document type. Default is '#01A3EF'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_CREATE_PROPOSAL_COVERTool to create a new proposal cover design. Use when you need a custom cover design before sending out a proposal. Use after finalizing cover settings.
Input parameters
ID of the brand to use; if omitted, default brand settings are applied
Background colour as 6-digit hex code, e.g. 'ffffff'
Main headline text on the cover
Name for the cover; default is 'Untitled'
Subheader text on the cover
Text alignment on the cover; one of 'left', 'center', or 'right'
Label text for the start button
Text colour as 6-digit hex code, e.g. 'ffffff'
Style of the start button; 'round' or 'square'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_COMPANIESTool to retrieve a paginated list of all companies. Use when listing available companies for display or selection.
Input parameters
Page number to retrieve (minimum 1)
Number of companies per page (minimum 1)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_CURRENCIESTool to retrieve a paginated list of all currencies. Use when listing available currency options before selection.
Input parameters
Page number to retrieve (minimum 1)
Number of currencies per page (minimum 1)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_DOCUMENT_TYPESTool to retrieve a paginated list of all document types. Use when you need to display or select a document type ID.
Input parameters
Page number to retrieve
Number of document types per page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_PROPOSALSTool to retrieve a paginated list of all proposals. Use when you need to fetch proposals list after validating credentials.
Input parameters
Page number for pagination, must be >= 1
Document Type ID to filter proposals
Number of proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_QUOTESTool to retrieve a paginated list of all quotes. Use after setting pagination parameters.
Input parameters
Page number to fetch, default is 1
Number of quotes per page, default is 10
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_ALL_TEMPLATESTool to retrieve a paginated list of all templates. Use when you need to list available templates for selection.
Input parameters
Page number to retrieve (minimum 1)
Number of templates per page (minimum 1)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_BRAND_SETTINGSTool to retrieve settings for the default brand. Use when you need default-brand configuration (colors, tax, name, etc.) before creating or customizing documents.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_COMPANYTool to retrieve details of a specific company. Use when you need company metadata by ID.
Input parameters
The unique identifier of the company to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_CURRENCYTool to retrieve details of a specific currency. Use when you need currency metadata by ID.
Input parameters
The unique identifier of the currency to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_NEW_PROPOSALSTool to retrieve all new proposals. Use after validating credentials when you need only newly created proposals.
Input parameters
Page number for pagination, must be >= 1
Document Type ID to filter proposals
Number of proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_OPENED_PROPOSALSTool to retrieve all opened proposals. Use when you need proposals that recipients have opened.
Input parameters
Page number for pagination, must be >= 1
DocumentTypeID to filter proposals
Number of proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_PAID_PROPOSALSTool to retrieve all paid proposals. Use when you need to list proposals that have been paid.
Input parameters
Page number for pagination, must be >= 1
Document Type ID to filter paid proposals
Number of paid proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_PROPOSALTool to retrieve details of a specific proposal by ID. Use when you need complete proposal metadata and content.
Input parameters
The unique identifier of the proposal to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_PROPOSAL_COUNTTool to retrieve the total count of proposals. Use when you need to know how many proposals exist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_QUOTETool to retrieve details of a specific quote. Use when you need full quote data by ID.
Input parameters
The unique identifier of the quote to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_SENT_PROPOSALSTool to retrieve all sent proposals. Use after dispatching proposals to clients to list them.
Input parameters
Page number for pagination, must be >= 1
Document Type ID to filter proposals
Number of proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_SETTINGSTool to retrieve current account settings. Use when you need default currency, tax, and timezone configuration before creating proposals.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_SIGNED_PROPOSALSTool to retrieve all signed proposals. Use when you need to list proposals clients have signed after confirming credentials.
Input parameters
Page number for pagination, must be >= 1
Document Type ID to filter signed proposals
Number of signed proposals per page, must be >= 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_GET_TEMPLATETool to retrieve details of a specific template. Use after selecting the template ID to fetch metadata.
Input parameters
The unique identifier of the template to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BETTER_PROPOSALS_LIST_MERGE_TAGSTool to retrieve custom merge tags with pagination support. Use when you need to list available merge tags for templates.
Input parameters
Page number to retrieve (minimum 1). Default: 1
Number of merge tags per page (minimum 1). Default: 10
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 23 Better Proposals actions on Nagent, including "Create Company", "Create Document Type" and "Create Proposal Cover". Create Company: Create a new company. Each action is listed on this page with its input parameters and its output.
Better Proposals connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Company takes 1 required input: CompanyName. It returns data, error and successful.