Skip to main content
API to update scheduled recurring invoice 
POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/updateAndSchedule

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
scheduleId
string
default:"6578278e879ad2646715ba9c"
required
Schedule Id

​
Respuestas

​
_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
​
altType
string
required
Posibles valores: ‘account’
​
name
string
default:"New Invoice"
required
Name of the invoice
​
schedule
object
​
invoices
object[]
required
List of invoices
​
businessDetails
object
required
Business Details
​
currency
string
default:"USD"
required
Currency
​
contactDetails
object
required
Contact Details
​
discount
object
Discount
​
items
string[]
required
Invoice Items
​
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
}

{}

{}

{}

​
Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/updateAndSchedule');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);