Documentación
superleads.mx
Documentación › Referencia de la API › Invoices

Invoices

Referencia de la API · ☕ 45 min de lectura
Actualizado el 19 Jun 2026

Invoice API

Documentación de la API de invoice

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

Endpoints

POST /invoices/template

Crear plantilla API to create a template

Scopes requeridos: invoices/template.write, invoices/template.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - internal — boolean - name (requerido) — string — Name of the template - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string - items (requerido) — array - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Invoice - discount — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string - title — string — Template title - tipsConfiguration — — Configuration for tips on invoices - lateFeesConfiguration — — Late fees configuration for the invoices - invoiceNumberPrefix — string — prefix for invoice number - paymentMethods — — Payment Methods for Invoices - attachments — array — attachments for the invoice - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/template

Listar plantillas API to get list of templates

Scopes requeridos: invoices/template.readonly, invoices/template.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType) - status (query, string) — status to be filtered - startAt (query, string) — startAt in YYYY-MM-DD format - endAt (query, string) — endAt in YYYY-MM-DD format - search (query, string) — To search for an invoice by id / name / email / phoneNo - paymentMode (query, string) — payment mode - limit (query, string) (requerido) — Límite de elementos a devolver - offset (query, string) (requerido) — Número de elementos a omitir

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/template/{templateId}

Obtener an template API to get an template by template id

Scopes requeridos: invoices/template.readonly, invoices/template.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - templateId (path, string) (requerido) — Id de plantilla - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /invoices/template/{templateId}

Actualizar plantilla API to update an template by template id

Scopes requeridos: invoices/template.write, invoices/template.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - internal — boolean - name (requerido) — string — Name of the template - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string - items (requerido) — array - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - discount — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string - title — string — Template title - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /invoices/template/{templateId}

Eliminar plantilla API to update an template by template id

Scopes requeridos: invoices/template.write, invoices/template.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - templateId (path, string) (requerido) — Id de plantilla - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /invoices/template/{templateId}/late-fees-configuration

Actualizar template late fees configuration API to update template late fees configuration by template id

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - lateFeesConfiguration (requerido) — — late fees configuration

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /invoices/template/{templateId}/payment-methods-configuration

Actualizar template late fees configuration API to update template late fees configuration by template id

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - paymentMethods — — Payment Methods for Invoices

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/schedule

Crear Invoice Schedule API to create an invoice Schedule

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - name (requerido) — string - contactDetails (requerido) — - id (requerido) — string — Contact Id - name (requerido) — string — Contact Name - phoneNo (requerido) — string — Contact Phone Number - email (requerido) — string — Contact Email - additionalEmails — array — Secondary email addresses for the contact to be saved - email (requerido) — string - companyName — string — Contact Company Name - address — - addressLine1 — string — Address Line 1 - addressLine2 — string — Address Line 2 - city — string — City - state — string — State - countryCode — string — Country Code - postalCode — string — Postal Code - customFields — array — Custom Values - schedule (requerido) — - executeAt — string - rrule — - intervalType (requerido) — string - interval (requerido) — number - startDate (requerido) — string — Start date in YYYY-MM-DD format - startTime — string — Start time in HH:mm:ss format - endDate — string — End date in YYYY-MM-DD format - endTime — string — End time in HH:mm:ss format - dayOfMonth — number — -1, 1, 2, 3, ..., 27, 28 - dayOfWeek — string - numOfWeek — number — -1, 1, 2, 3, 4 - monthOfYear — string - count — number — Max number of task executions - daysBefore — number — Execute task number of days before - useStartAsPrimaryUserAccepted — boolean — Start as primary user accepted date - endType — string — End type like after, by, count - liveMode (requerido) — boolean - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string - items (requerido) — array - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Invoice - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string - title — string - tipsConfiguration — — Configuration for tips on invoices - lateFeesConfiguration — — Late fees configuration for the invoices - invoiceNumberPrefix — string — prefix for invoice number - paymentMethods — — Payment Methods for Invoices - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/schedule

Listar horarios API to get list of schedules

Scopes requeridos: invoices/schedule.readonly, invoices/schedule.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType) - status (query, string) — status to be filtered - startAt (query, string) — startAt in YYYY-MM-DD format - endAt (query, string) — endAt in YYYY-MM-DD format - search (query, string) — To search for an invoice by id / name / email / phoneNo - paymentMode (query, string) — payment mode - limit (query, string) (requerido) — Límite de elementos a devolver - offset (query, string) (requerido) — Número de elementos a omitir

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/schedule/{scheduleId}

Obtener an schedule API to get an schedule by schedule id

Scopes requeridos: invoices/schedule.readonly, invoices/schedule.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - scheduleId (path, string) (requerido) — Id de horario - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /invoices/schedule/{scheduleId}

Actualizar horario API to update an schedule by schedule id

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - name (requerido) — string - contactDetails (requerido) — - id (requerido) — string — Contact Id - name (requerido) — string — Contact Name - phoneNo (requerido) — string — Contact Phone Number - email (requerido) — string — Contact Email - additionalEmails — array — Secondary email addresses for the contact to be saved - email (requerido) — string - companyName — string — Contact Company Name - address — - addressLine1 — string — Address Line 1 - addressLine2 — string — Address Line 2 - city — string — City - state — string — State - countryCode — string — Country Code - postalCode — string — Postal Code - customFields — array — Custom Values - schedule (requerido) — - executeAt — string - rrule — - intervalType (requerido) — string - interval (requerido) — number - startDate (requerido) — string — Start date in YYYY-MM-DD format - startTime — string — Start time in HH:mm:ss format - endDate — string — End date in YYYY-MM-DD format - endTime — string — End time in HH:mm:ss format - dayOfMonth — number — -1, 1, 2, 3, ..., 27, 28 - dayOfWeek — string - numOfWeek — number — -1, 1, 2, 3, 4 - monthOfYear — string - count — number — Max number of task executions - daysBefore — number — Execute task number of days before - useStartAsPrimaryUserAccepted — boolean — Start as primary user accepted date - endType — string — End type like after, by, count - liveMode (requerido) — boolean - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string - items (requerido) — array - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string - title — string - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /invoices/schedule/{scheduleId}

Eliminar horario API to delete an schedule by schedule id

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - scheduleId (path, string) (requerido) — Id de horario - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/schedule/{scheduleId}/updateAndSchedule

Actualizar scheduled recurring invoice API to update scheduled recurring invoice

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/schedule/{scheduleId}/schedule

Schedule an schedule invoice API to schedule an schedule invoice to start sending to the customer

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - liveMode (requerido) — boolean - autoPayment — — auto-payment configuration

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/schedule/{scheduleId}/auto-payment

Manage Auto payment for an schedule invoice API to manage auto payment for a schedule

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - id (requerido) — string - autoPayment (requerido) — — auto-payment configuration

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/schedule/{scheduleId}/cancel

Cancelar an scheduled invoice API to cancel a scheduled invoice by schedule id

Scopes requeridos: invoices/schedule.write, invoices/schedule.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/text2pay

Crear & Send API to create or update a text2pay invoice

Scopes requeridos: invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - name (requerido) — string — Invoice Name - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the invoice. - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the invoice - contactDetails (requerido) — — Contact information to send the invoice to - invoiceNumber — string — Invoice Number - issueDate (requerido) — string — Issue date in YYYY-MM-DD format - dueDate — string — Due date in YYYY-MM-DD format - sentTo (requerido) — - email (requerido) — array — Email Address - emailCc — array — cc to be kept in any sent out emails - emailBcc — array — bcc to be kept in any sent out emails - phoneNo — array — Contact Phone Number - liveMode (requerido) — boolean - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Invoice - paymentSchedule — — split invoice into payment schedule summing up to full invoice amount - lateFeesConfiguration — — late fees configuration - tipsConfiguration — — tips configuration for the invoice - invoiceNumberPrefix — string — prefix for invoice number - paymentMethods — — Payment Methods for Invoices - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the invoice - id — string — id of invoice to update. If skipped, a new invoice will be created - includeTermsNote — boolean — include terms & notes with receipts - action (requerido) — string — create invoice in draft mode or send mode - userId (requerido) — string — id of user generating invoice - discount — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - businessDetails — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/generate-invoice-number

Generar Invoice Number Get the next invoice number for the given location

Scopes requeridos: invoices.readonly, invoices.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de sede - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/settings

Obtener Invoice Settings Get the invoice settings for the given location

Scopes requeridos: invoices.readonly, invoices.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/{invoiceId}

Obtener factura API to get invoice by invoice id

Scopes requeridos: invoices.readonly, invoices.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - invoiceId (path, string) (requerido) — Id de factura - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /invoices/{invoiceId}

Actualizar factura API to update invoice by invoice id

Scopes requeridos: invoices.write, invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - name (requerido) — string — Name to be updated - title — string — Title for the invoice - currency (requerido) — string — Currency - description — string — Description - businessDetails — — Business details which need to be updated - invoiceNumber — string — Invoice Number - contactId — string — Id of the contact which you need to send the invoice - contactDetails — - id (requerido) — string — Contact Id - name (requerido) — string — Contact Name - phoneNo (requerido) — string — Contact Phone Number - email (requerido) — string — Contact Email - additionalEmails — array — Secondary email addresses for the contact to be saved - email (requerido) — string - companyName — string — Contact Company Name - address — - addressLine1 — string — Address Line 1 - addressLine2 — string — Address Line 2 - city — string — City - state — string — State - countryCode — string — Country Code - postalCode — string — Postal Code - customFields — array — Custom Values - termsNotes — string — Terms notes, Also supports HTML markups - discount — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - invoiceItems (requerido) — array - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Invoice - liveMode — boolean — Payment mode - issueDate (requerido) — string — Issue date in YYYY-MM-DD format - dueDate (requerido) — string — Due date in YYYY-MM-DD format - paymentSchedule — — split invoice into payment schedule summing up to full invoice amount - tipsConfiguration — — tips configuration for the invoice - xeroDetails — object - invoiceNumberPrefix — string — prefix for invoice number - paymentMethods — — Payment Methods for Invoices - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /invoices/{invoiceId}

Eliminar factura API to delete invoice by invoice id

Scopes requeridos: invoices.write, invoices.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - invoiceId (path, string) (requerido) — Id de factura - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /invoices/{invoiceId}/late-fees-configuration

Actualizar invoice late fees configuration API to update invoice late fees configuration by invoice id

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - lateFeesConfiguration (requerido) — — late fees configuration

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/{invoiceId}/void

Void invoice API to delete invoice by invoice id

Scopes requeridos: invoices.write, invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/{invoiceId}/send

Enviar factura API to send invoice by invoice id

Scopes requeridos: invoices.write, invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - userId (requerido) — string — Please ensure that the UserId corresponds to an authorized personnel, either by an employee Id or agency Id, to access this location. This account will serve as the primary channel for all future communications and updates. - action (requerido) — string - liveMode (requerido) — boolean - sentFrom — — sender details for invoice, valid only if invoice is not sent manually - autoPayment — — auto-payment configuration

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/{invoiceId}/record-payment

Record a manual payment for an invoice API to record manual payment for an invoice by invoice id

Scopes requeridos: invoices.write, invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - mode (requerido) — string — manual payment method - card (requerido) — - brand (requerido) — string - last4 (requerido) — string - cheque (requerido) — - number (requerido) — string — check number - notes (requerido) — string — Any note to be recorded with the transaction - amount — number — Amount to be paid against the invoice. - meta — object - paymentScheduleIds — array — Payment Schedule Ids to be recorded against the invoice. - fulfilledAt — string — Updated At to be recorded against the invoice.

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /invoices/stats/last-visited-at

Actualizar invoice last visited at API to update invoice last visited at by invoice id

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

Cuerpo de la peticion (application/json): - invoiceId (requerido) — string — Invoice Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado

POST /invoices/estimate

Crear New Estimate Create a new estimate with the provided details

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Estimate Name - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the estimate. - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - attachments — array — Attachments for the line item - liveMode — boolean — livemode for estimate - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the estimate - contactDetails (requerido) — — Contact information to send the estimate to - estimateNumber — number — Estimate Number, if not specified will take in the next valid estimate number - issueDate — string — issue date estimate - expiryDate — string — expiry date estimate - sentTo — — Email and sent to details for the estimate - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Estimate - meta — object — Meta data for the estimate - sendEstimateDetails — — When sending estimate directly while saving - frequencySettings (requerido) — — frequency settings for the estimate - estimateNumberPrefix — string — Prefix for the estimate number - userId — string — User Id - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - autoInvoice — — Auto invoice for the estimate - miscellaneousCharges — — miscellaneous charges for the estimate - paymentScheduleConfig — — Payment Schedule Config for the estimate

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /invoices/estimate/{estimateId}

Actualizar Estimate Update an existing estimate with new details

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Estimate Name - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the estimate. - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - attachments — array — Attachments for the line item - liveMode — boolean — livemode for estimate - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the estimate - contactDetails (requerido) — — Contact information to send the estimate to - estimateNumber — number — Estimate Number, if not specified will take in the next valid estimate number - issueDate — string — issue date estimate - expiryDate — string — expiry date estimate - sentTo — — Email and sent to details for the estimate - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Estimate - meta — object — Meta data for the estimate - sendEstimateDetails — — When sending estimate directly while saving - frequencySettings (requerido) — — frequency settings for the estimate - estimateNumberPrefix — string — Prefix for the estimate number - userId — string — User Id - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - autoInvoice — — Auto invoice for the estimate - miscellaneousCharges — — miscellaneous charges for the estimate - paymentScheduleConfig — — Payment Schedule Config for the estimate - estimateStatus — string — Estimate Status

Respuestas: - 200 — Actualizado correctamente - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /invoices/estimate/{estimateId}

Eliminar Estimate Delete an existing estimate

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string

Respuestas: - 200 — Successfully Deleted - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/estimate/number/generate

Generar Estimate Number Get the next estimate number for the given location

Scopes requeridos: invoices/estimate.readonly, invoices/estimate.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) —

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/estimate/{estimateId}/send

Enviar Estimate API to send estimate by estimate id

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - action (requerido) — string - liveMode (requerido) — boolean — livemode for estimate - userId (requerido) — string — Please ensure that the UserId corresponds to an authorized personnel, either by an employee Id or agency Id, to access this location. This account will serve as the primary channel for all future communications and updates. - sentFrom — — sender details for invoice, valid only if invoice is not sent manually - estimateName — string — estimate name

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/estimate/{estimateId}/invoice

Crear Invoice from Estimate Create a new invoice from an existing estimate

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - markAsInvoiced (requerido) — boolean — Mark Estimate as Invoiced - versión — string — Versión of the update request

Respuestas: - 200 — Successfully Created - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/estimate/list

Listar Estimates Get a paginated list of estimates

Scopes requeridos: invoices/estimate.readonly, invoices/estimate.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - startAt (query, string) — startAt in YYYY-MM-DD format - endAt (query, string) — endAt in YYYY-MM-DD format - search (query, string) — search text for estimates name - status (query, string) — estimate status - contactId (query, string) — Contact Id for the estimate - limit (query, string) (requerido) — Límite de elementos a devolver - offset (query, string) (requerido) — Número de elementos a omitir

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /invoices/estimate/stats/last-visited-at

Actualizar estimate last visited at API to update estimate last visited at by estimate id

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

Cuerpo de la peticion (application/json): - estimateId (requerido) — string — Estimate Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado

GET /invoices/estimate/template

Listar Estimate Templates Get a list of estimate templates or a specific template by Id

Scopes requeridos: invoices/estimate.readonly, invoices/estimate.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - search (query, string) — To search for an estimate template by id / name - limit (query, string) (requerido) — Límite de elementos a devolver - offset (query, string) (requerido) — Número de elementos a omitir

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/estimate/template

Crear Estimate Template Create a new estimate template

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Estimate Name - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the estimate. - liveMode — boolean — livemode for estimate - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the estimate - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Estimate - meta — object — Meta data for the estimate - sendEstimateDetails — — When sending estimate directly while saving - estimateNumberPrefix — string — Prefix for the estimate number - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the estimate

Respuestas: - 201 — Successfully created - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /invoices/estimate/template/{templateId}

Actualizar Estimate Template Update an existing estimate template

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string - name (requerido) — string — Estimate Name - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the estimate. - liveMode — boolean — livemode for estimate - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the estimate - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Estimate - meta — object — Meta data for the estimate - sendEstimateDetails — — When sending estimate directly while saving - estimateNumberPrefix — string — Prefix for the estimate number - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the estimate

Respuestas: - 200 — Actualizado correctamente - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /invoices/estimate/template/{templateId}

Eliminar Estimate Template Delete an existing estimate template

Scopes requeridos: invoices/estimate.write, invoices/estimate.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id or Agency Id - altType (requerido) — string

Respuestas: - 200 — Successfully deleted - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/estimate/template/preview

Preview Estimate Template Get a preview of an estimate template

Scopes requeridos: invoices/estimate.readonly, invoices/estimate.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia - altType (query, string) (requerido) — - templateId (query, string) (requerido) — Id de plantilla

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /invoices/

Crear factura API to create an invoice

Scopes requeridos: invoices.write, invoices.write

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

Cuerpo de la peticion (application/json): - altId (requerido) — string — location Id / company Id based on altType - altType (requerido) — string — Alt Type - name (requerido) — string — Invoice Name - businessDetails (requerido) — - logoUrl — string — Business Logo URL - name — string — Business Name - phoneNo — string — Business Phone Number - address — — Business Address - website — string — Business Website Link - customValues — array — Custom Values - currency (requerido) — string — Currency code - items (requerido) — array — An array of items for the invoice. - name (requerido) — string — Invoice Item Name - description — string — Invoice descriptions - productId — string — Product Id - priceId — string — Price Id - currency (requerido) — string — Currency - amount (requerido) — number — Product amount - qty (requerido) — number — Product Quantity - taxes — array — Tax - _id (requerido) — string - name (requerido) — string - rate (requerido) — number - calculation — string - description — string - taxId — string - automaticTaxCategoryId — string — Tax category id for calculating automatic tax - isSetupFeeItem — boolean — Setupfee item, only created when 1st invoice of recurring schedule is generated - type — string — Price type of the item - taxInclusive — boolean — true if item amount is tax inclusive - discount (requerido) — - value — number — Discount Value - type (requerido) — string — Discount type - validOnProductIds — array — Product Ids on which discount is applicable - termsNotes — string — Terms notes, Also supports HTML markups - title — string — Title for the invoice - contactDetails (requerido) — — Contact information to send the invoice to - invoiceNumber — string — Invoice Number - issueDate (requerido) — string — Issue date in YYYY-MM-DD format - dueDate — string — Due date in YYYY-MM-DD format - sentTo (requerido) — - email (requerido) — array — Email Address - emailCc — array — cc to be kept in any sent out emails - emailBcc — array — bcc to be kept in any sent out emails - phoneNo — array — Contact Phone Number - liveMode (requerido) — boolean - automaticTaxesEnabled — boolean — Automatic taxes enabled for the Invoice - paymentSchedule — — split invoice into payment schedule summing up to full invoice amount - lateFeesConfiguration — — late fees configuration - tipsConfiguration — — tips configuration for the invoice - invoiceNumberPrefix — string — prefix for invoice number - paymentMethods — — Payment Methods for Invoices - attachments — array — attachments for the invoice - id (requerido) — string — Id of the file selected - name (requerido) — string — Name of the file - url (requerido) — string — URL of the file - type (requerido) — string — Type of the file - size (requerido) — number — Size of the file - miscellaneousCharges — — miscellaneous charges for the invoice

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /invoices/

Listar facturas API to get list of invoices

Scopes requeridos: invoices.readonly, invoices.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - altId (query, string) (requerido) — Id de la sede o de la agencia, según altType - altType (query, string) (requerido) — Tipo alterno (altType) - status (query, string) — status to be filtered - startAt (query, string) — startAt in YYYY-MM-DD format - endAt (query, string) — endAt in YYYY-MM-DD format - search (query, string) — To search for an invoice by id / name / email / phoneNo - paymentMode (query, string) — payment mode - contactId (query, string) — Contact Id for the invoice - limit (query, string) (requerido) — Límite de elementos a devolver - offset (query, string) (requerido) — Número de elementos a omitir - sortField (query, string) — The field on which sorting should be applied - sortOrder (query, string) — The order of sort which should be applied for the sortField

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar