Documentation Index
Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
API to schedule an schedule invoice to start sending to the customer
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/schedule
Autorizacion
Bearer token generado desde el portal Leadway. Ver Autenticacion. Version
string
default:"2021-07-28"
required
Version de la API.
Path parameters
scheduleId
string
default:"6578278e879ad2646715ba9c"
required
Schedule Id
Body
altId
string
default:"6578278e879ad2646715ba9c"
required
account Id / company Id based on altType
altType
string
default:"account"
required
Alt Type Posibles valores: ‘account’
auto-payment configuration
Respuestas
200 - Successful response
_id
string
default:"6578278e879ad2646715ba9c"
required
Schedule Id
status
object
default:"draft"
required
Schedule Status
liveMode
boolean
default:"False"
required
Live Mode
altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
Posibles valores: ‘account’
name
string
default:"New Invoice"
required
Name of the invoice
intervalType
string
default:"monthly"
required
Posibles valores: ‘yearly’, ‘monthly’, ‘weekly’, ‘daily’, ‘hourly’, ‘minutely’, ‘secondly’
interval
number
default:"2"
required
startDate
string
default:"2023-01-01"
required
Start date in YYYY-MM-DD format
Start time in HH:mm:ss format
endDate
string
default:"2029-11-01"
End date in YYYY-MM-DD format
End time in HH:mm:ss format
Posibles valores: ‘mo’, ‘tu’, ‘we’, ‘th’, ‘fr’, ‘sa’, ‘su’
Posibles valores: ‘jan’, ‘feb’, ‘mar’, ‘apr’, ‘may’, ‘jun’, ‘jul’, ‘aug’, ‘sep’, ‘oct’, ‘nov’, ‘dec’
Max number of task executions
Execute task number of days before
useStartAsPrimaryUserAccepted
Start as primary user accepted date
End type like after, by, count
List of invoices
_id
string
default:"6578278e879ad2646715ba9c"
required
Invoice Id
status
string
default:"draft"
required
Invoice Status Posibles valores: ‘draft’, ‘sent’, ‘payment_processing’, ‘paid’, ‘void’, ‘partially_paid’
liveMode
boolean
default:"False"
required
Live Mode
amountPaid
number
default:"0"
required
Amount Paid
altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
Posibles valores: ‘account’
name
string
default:"New Invoice"
required
Name of the invoice
invoiceNumber
number
default:"19"
required
Invoice Number
currency
string
default:"USD"
required
Currency
issueDate
string
default:"2023-01-01"
required
Issue date in YYYY-MM-DD format
dueDate
string
default:"2023-01-01"
required
Due date in YYYY-MM-DD format
total
number
default:"999"
required
Total Amount
title
string
default:"INVOICE"
required
Title
amountDue
number
default:"999"
required
Total Amount Due
createdAt
string
default:"2023-12-12T09:27:42.355Z"
required
created at
updatedAt
string
default:"2023-12-12T09:27:42.355Z"
required
updated at
Automatic taxes enabled for the Invoice
Is Automatic taxes calculated for the Invoice items
split invoice into payment schedule summing up to full invoice amount
currency
string
default:"USD"
required
Currency
total
number
default:"999"
required
Total Amount
title
string
default:"INVOICE"
required
Title
termsNotes
string
default:"Confidential"
required
Terms notes
compiledTermsNotes
string
default:"Confidential"
required
Compiled terms notes
createdAt
string
default:"2023-12-12T09:27:42.355Z"
required
created at
updatedAt
string
default:"2023-12-12T09:27:42.355Z"
required
updated at
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"schedule": {
"executeAt": "string",
"rrule": {
"intervalType": "monthly",
"interval": 2,
"startDate": "2023-01-01",
"startTime": "20:45:00",
"endDate": "2029-11-01",
"endTime": "18:45:00",
"dayOfMonth": 15,
"dayOfWeek": "mo",
"numOfWeek": -1,
"monthOfYear": "jan",
"count": 10,
"daysBefore": 5,
"useStartAsPrimaryUserAccepted": true,
"endType": "by"
}
},
"invoices": [
{
"_id": "6578278e879ad2646715ba9c",
"status": "draft",
"liveMode": false,
"amountPaid": 0,
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"name": "New Invoice",
"businessDetails": {
"name": "Alex",
"address": {
"addressLine1": "9931 Beechwood",
// truncado: 94 lineas mas
}
422 - Unprocessable Entity
Ejemplo
curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/schedule' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28' \
-H 'Content-Type: application/json' \
-d '{
"altId": "6578278e879ad2646715ba9c",
"altType": "account",
"liveMode": true
}'
