Proposals

Documents and Contracts API

Documentación de la API de Documents and Contracts

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /proposals/document — Listar documentos
• POST /proposals/document/send — Enviar documento
• GET /proposals/templates — Listar plantillas
• POST /proposals/templates/send — Enviar plantilla

GET /proposals/document

Listar documentos List documents for a location

Parametros: - locationId (query, string) (requerido) — Id de sede - status (query, string) — Document status, pass as comma separated values - paymentStatus (query, string) — Payment status, pass as comma separated values - limit (query, number) — Limit to fetch number of records - skip (query, number) — Skip number of records - query (query, string) — Search string - dateFrom (query, string) — Date start from (ISO 8601), dateFrom & DateTo must be provided together - dateTo (query, string) — Date to (ISO 8601), dateFrom & DateTo must be provided together - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Document fetched successfully - 400 — Entidad no procesable

POST /proposals/document/send

Enviar documento Send document to a client

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id - documentId (requerido) — string — Document Id - documentName — string — Document Name - medium — string — Medium to be used for sending the document - ccRecipients — array — CC Recipient - email (requerido) — string — Email - id (requerido) — string — Contact Id - imageUrl (requerido) — string — Contact Image URL - contactName (requerido) — string — Contact Name - firstName (requerido) — string — First Name - lastName (requerido) — string — Last Name - notificationSettings — - sentBy (requerido) — string — Sent ByUser Id

Respuestas: - 200 — Document sent successfully - 400 — Entidad no procesable

GET /proposals/templates

Listar plantillas List document contract templates for a location

Parametros: - locationId (query, string) (requerido) — Id de sede - dateFrom (query, string) — Date start from (ISO 8601) - dateTo (query, string) — Date to (ISO 8601) - type (query, string) — Comma-separated template types. Valid values: proposal, estimate, contentLibrary - name (query, string) — Template Name - isPublicDocument (query, boolean) — If the docForm is a DocForm - userId (query, string) — User Id, required when isPublicDocument is true - limit (query, string) — Limit - skip (query, string) — Skip - Versión (header, string) (requerido) — Versión de la API

Respuestas: - 200 — Templates fetched successfully - 400 — Entidad no procesable

POST /proposals/templates/send

Enviar plantilla Send template to a client

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - templateId (requerido) — string — Template Id - userId (requerido) — string — User Id - sendDocument — boolean — Send Document - locationId (requerido) — string — Location Id - contactId (requerido) — string — Contact Id - opportunityId — string — Opportunity Id

Respuestas: - 200 — Document sent successfully - 400 — Entidad no procesable