NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Better Proposals

better_proposals

Better Proposals is a web-based proposal creation tool that enables users to send professionally designed proposals.

Proposal & Invoice ManagementWeb del proveedor
Acciones
22
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (22)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Get All Document TypesBETTER_PROPOSALS_BETTER_PROPOSALS_GET_ALL_DOCUMENT_TYPESAcción

Tool to retrieve a paginated list of all document types. use when you need to display or select a document type id.

Parámetros de entrada

  • pageinteger

    Page number to retrieve

  • per_pageinteger

    Number of document types per page

Parámetros de salida

  • dataobject[]Obligatorio

    List of document types returned for the requested page

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message returned by the API if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CompanyBETTER_PROPOSALS_CREATE_COMPANYAcción

Tool to create a new company. use after confirming the company does not already exist.

Parámetros de entrada

  • CompanyNamestringObligatorio

    Company name.

Parámetros de salida

  • dataobjectObligatorio

    The newly created company data.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error.

  • messagestring

    Error message if status is error.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Document TypeBETTER_PROPOSALS_CREATE_DOCUMENT_TYPEAcción

Tool to create a new document type. use after confirming the desired type name does not already exist.

Parámetros de entrada

  • TypeNamestringObligatorio

    Document type name

  • TypeColourstring

    Hex colour for your new document type. Default is '#01A3EF'.

Parámetros de salida

  • dataobjectObligatorio

    The newly created document type.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Proposal CoverBETTER_PROPOSALS_CREATE_PROPOSAL_COVERAcción

Tool 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.

Parámetros de entrada

  • BrandIDinteger

    ID of the brand to use; if omitted, default brand settings are applied

  • BGColourstring

    Background colour as 6-digit hex code, e.g. 'ffffff'

  • Headlinestring

    Main headline text on the cover

  • CoverNamestring

    Name for the cover; default is 'Untitled'

  • Subheaderstring

    Subheader text on the cover

  • TextAlignstringenum

    Text alignment on the cover; one of 'left', 'center', or 'right'

    leftcenterright
  • ButtonTextstring

    Label text for the start button

  • TextColourstring

    Text colour as 6-digit hex code, e.g. 'ffffff'

  • ButtonStylestringenum

    Style of the start button; 'round' or 'square'

    roundsquare

Parámetros de salida

  • dataobjectObligatorio

    Details of the created cover

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API response status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All CompaniesBETTER_PROPOSALS_GET_ALL_COMPANIESAcción

Tool to retrieve a paginated list of all companies. use when listing available companies for display or selection.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (minimum 1)

  • per_pageinteger

    Number of companies per page (minimum 1)

Parámetros de salida

  • dataobject[]Obligatorio

    List of companies for the requested page

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All CurrenciesBETTER_PROPOSALS_GET_ALL_CURRENCIESAcción

Tool to retrieve a paginated list of all currencies. use when listing available currency options before selection.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (minimum 1)

  • per_pageinteger

    Number of currencies per page (minimum 1)

Parámetros de salida

  • dataobject[]Obligatorio

    List of currencies for the requested page

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Document TypesBETTER_PROPOSALS_GET_ALL_DOCUMENT_TYPESAcción

Tool to retrieve a paginated list of all document types. use when you need to display or select a document type id.

Parámetros de entrada

  • pageinteger

    Page number to retrieve

  • per_pageinteger

    Number of document types per page

Parámetros de salida

  • dataobject[]Obligatorio

    List of document types for the requested page

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All ProposalsBETTER_PROPOSALS_GET_ALL_PROPOSALSAcción

Tool to retrieve a paginated list of all proposals. use when you need to fetch proposals list after validating credentials.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    Document Type ID to filter proposals

  • per_pageinteger

    Number of proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All QuotesBETTER_PROPOSALS_GET_ALL_QUOTESAcción

Tool to retrieve a paginated list of all quotes. use after setting pagination parameters.

Parámetros de entrada

  • pageinteger

    Page number to fetch, default is 1

  • per_pageinteger

    Number of quotes per page, default is 10

Parámetros de salida

  • dataobject[]Obligatorio

    List of quote items

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status, either 'success' or 'error'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All TemplatesBETTER_PROPOSALS_GET_ALL_TEMPLATESAcción

Tool to retrieve a paginated list of all templates. use when you need to list available templates for selection.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (minimum 1)

  • per_pageinteger

    Number of templates per page (minimum 1)

Parámetros de salida

  • dataobject[]Obligatorio

    List of templates returned

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: 'success' or 'error'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Brand SettingsBETTER_PROPOSALS_GET_BRAND_SETTINGSAcción

Tool to retrieve settings for the default brand. use when you need default-brand configuration (colors, tax, name, etc.) before creating or customizing documents.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Default brand settings object

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CompanyBETTER_PROPOSALS_GET_COMPANYAcción

Tool to retrieve details of a specific company. use when you need company metadata by id.

Parámetros de entrada

  • company_idstringObligatorio

    The unique identifier of the company to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Detailed company data

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CurrencyBETTER_PROPOSALS_GET_CURRENCYAcción

Tool to retrieve details of a specific currency. use when you need currency metadata by id.

Parámetros de entrada

  • currency_idstringObligatorio

    The unique identifier of the currency to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Detailed currency information

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get New ProposalsBETTER_PROPOSALS_GET_NEW_PROPOSALSAcción

Tool to retrieve all new proposals. use after validating credentials when you need only newly created proposals.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    Document Type ID to filter proposals

  • per_pageinteger

    Number of proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of new proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Opened ProposalsBETTER_PROPOSALS_GET_OPENED_PROPOSALSAcción

Tool to retrieve all opened proposals. use when you need proposals that recipients have opened.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    DocumentTypeID to filter proposals

  • per_pageinteger

    Number of proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of opened proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Paid ProposalsBETTER_PROPOSALS_GET_PAID_PROPOSALSAcción

Tool to retrieve all paid proposals. use when you need to list proposals that have been paid.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    Document Type ID to filter paid proposals

  • per_pageinteger

    Number of paid proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of paid proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Proposal CountBETTER_PROPOSALS_GET_PROPOSAL_COUNTAcción

Tool to retrieve the total count of proposals. use when you need to know how many proposals exist.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get QuoteBETTER_PROPOSALS_GET_QUOTEAcción

Tool to retrieve details of a specific quote. use when you need full quote data by id.

Parámetros de entrada

  • quote_idstringObligatorio

    The unique identifier of the quote to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Detailed quote data

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status, either 'success' or 'error'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Sent ProposalsBETTER_PROPOSALS_GET_SENT_PROPOSALSAcción

Tool to retrieve all sent proposals. use after dispatching proposals to clients to list them.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    Document Type ID to filter proposals

  • per_pageinteger

    Number of proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of sent proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SettingsBETTER_PROPOSALS_GET_SETTINGSAcción

Tool to retrieve current account settings. use when you need default currency, tax, and timezone configuration before creating proposals.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Account settings data object

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: success or error

  • messagestring

    Error message if status is error

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Signed ProposalsBETTER_PROPOSALS_GET_SIGNED_PROPOSALSAcción

Tool to retrieve all signed proposals. use when you need to list proposals clients have signed after confirming credentials.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1

  • typeinteger

    Document Type ID to filter signed proposals

  • per_pageinteger

    Number of signed proposals per page, must be >= 1

Parámetros de salida

  • dataobject[]Obligatorio

    List of signed proposals

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorioenum

    API call status

    successerror
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Template DetailsBETTER_PROPOSALS_GET_TEMPLATEAcción

Tool to retrieve details of a specific template. use after selecting the template id to fetch metadata.

Parámetros de entrada

  • template_idstringObligatorio

    The unique identifier of the template to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Template details returned by the API

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status: 'success' or 'error'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not