Create Invoice Schedule

API to create an invoice Schedule

POST https://services.leadconnectorhq.com/invoices/schedule

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"6578278e879ad2646715ba9c"

required

account Id / company Id based on altType

string

default:"account"

required

Alt Type Posibles valores: ‘account’

string

required

object

required

Show propiedades

string

default:"6578278e879ad2646715ba9c"

required

Contact ID

string

default:"Alex"

required

Contact Name

string

default:"+1234567890"

required

Contact Phone Number

string

default:"alex@example.com"

required

Contact Email

object[]

Secondary email addresses for the contact to be saved

Show cada item

string

default:"alex@example.com"

required

string

default:"ABC Corp."

Contact Company Name

object

Show propiedades

string

default:"9931 Beechwood"

Address Line 1

string

default:"Beechwood"

Address Line 2

string

default:"St. Houston"

City

string

default:"TX"

State

string

default:"US"

Country Code

string

default:"559-6993"

Postal Code

string[]

Custom Values

object

required

Show propiedades

string

object

Show propiedades

string

default:"monthly"

required

Posibles valores: ‘yearly’, ‘monthly’, ‘weekly’, ‘daily’, ‘hourly’, ‘minutely’, ‘secondly’

number

default:"2"

required

string

default:"2023-01-01"

required

Start date in YYYY-MM-DD format

string

default:"20:45:00"

Start time in HH:mm:ss format

string

default:"2029-11-01"

End date in YYYY-MM-DD format

string

default:"18:45:00"

End time in HH:mm:ss format

number

default:"15"

-1, 1, 2, 3, …, 27, 28

string

default:"mo"

Posibles valores: ‘mo’, ‘tu’, ‘we’, ‘th’, ‘fr’, ‘sa’, ‘su’

number

default:"-1"

-1, 1, 2, 3, 4

string

default:"jan"

Posibles valores: ‘jan’, ‘feb’, ‘mar’, ‘apr’, ‘may’, ‘jun’, ‘jul’, ‘aug’, ‘sep’, ‘oct’, ‘nov’, ‘dec’

number

default:"10"

Max number of task executions

number

default:"5"

Execute task number of days before

boolean

default:"True"

Start as primary user accepted date

string

default:"by"

End type like after, by, count

boolean

required

object

required

Show propiedades

string

default:"https://example.com/logo.png"

Business Logo URL

string

default:"ABC Corp."

Business Name

string

default:"+1-214-559-6993"

Business Phone Number

object

default:"9931 Beechwood, TX"

Business Address

string

default:"wwww.example.com"

Business Website Link

string[]

Custom Values

string

required

object[]

required

Show cada item

string

default:"ABC Product"

required

Invoice Item Name

string

default:"ABC Corp."

Invoice descriptions

string

default:"6578278e879ad2646715ba9c"

Product Id

string

default:"6578278e879ad2646715ba9c"

Price Id

string

default:"USD"

required

Currency

number

default:"999"

required

Product amount

number

default:"1"

required

Product Quantity

object[]

Tax

Show cada item

string

required

string

required

number

required

string

Posibles valores: ‘exclusive’

string

default:"6578278e879ad2646715ba9c"

Tax category id for calculating automatic tax

boolean

Setupfee item, only created when 1st invoice of recurring schedule is generated

string

default:"one_time"

Price type of the item Posibles valores: ‘one_time’, ‘recurring’

boolean

default:"True"

true if item amount is tax inclusive

boolean

default:"True"

Automatic taxes enabled for the Invoice

object

required

Show propiedades

number

default:"10"

Discount Value

string

default:"percentage"

required

Discount type Posibles valores: ‘percentage’, ‘fixed’

string[]

default:"[ '6579751d56f60276e5bd4154' ]"

Product Ids on which discount is applicable

string

object

Configuration for tips on invoices

object

Late fees configuration for the invoices

string

default:"INV-"

prefix for invoice number

object

Payment Methods for Invoices

object[]

attachments for the invoice

Show cada item

string

default:"6241712be68f7a98102ba272"

required

Id of the file selected

string

default:"Electronics.pdf"

required

Name of the file

string

default:"https://example.com/digital-delivery"

required

URL of the file

string

required

Type of the file

number

default:"10000"

required

Size of the file

object

miscellaneous charges for the invoice

Respuestas

200 - Successful response

string

default:"6578278e879ad2646715ba9c"

required

Schedule Id

object

default:"draft"

required

Schedule Status

boolean

default:"False"

required

Live Mode

string

default:"6578278e879ad2646715ba9c"

required

Account Id or Agency Id

string

required

Posibles valores: ‘account’

string

default:"New Invoice"

required

Name of the invoice

object

Show propiedades

string

object

Show propiedades

string

default:"monthly"

required

Posibles valores: ‘yearly’, ‘monthly’, ‘weekly’, ‘daily’, ‘hourly’, ‘minutely’, ‘secondly’

number

default:"2"

required

string

default:"2023-01-01"

required

Start date in YYYY-MM-DD format

string

default:"20:45:00"

Start time in HH:mm:ss format

string

default:"2029-11-01"

End date in YYYY-MM-DD format

string

default:"18:45:00"

End time in HH:mm:ss format

number

default:"15"

-1, 1, 2, 3, …, 27, 28

string

default:"mo"

Posibles valores: ‘mo’, ‘tu’, ‘we’, ‘th’, ‘fr’, ‘sa’, ‘su’

number

default:"-1"

-1, 1, 2, 3, 4

string

default:"jan"

Posibles valores: ‘jan’, ‘feb’, ‘mar’, ‘apr’, ‘may’, ‘jun’, ‘jul’, ‘aug’, ‘sep’, ‘oct’, ‘nov’, ‘dec’

number

default:"10"

Max number of task executions

number

default:"5"

Execute task number of days before

boolean

default:"True"

Start as primary user accepted date

string

default:"by"

End type like after, by, count

object[]

required

List of invoices

Show cada item

string

default:"6578278e879ad2646715ba9c"

required

Invoice Id

string

default:"draft"

required

Invoice Status Posibles valores: ‘draft’, ‘sent’, ‘payment_processing’, ‘paid’, ‘void’, ‘partially_paid’

boolean

default:"False"

required

Live Mode

number

default:"0"

required

Amount Paid

string

default:"6578278e879ad2646715ba9c"

required

Account Id or Agency Id

string

required

Posibles valores: ‘account’

string

default:"New Invoice"

required

Name of the invoice

object

required

Business Details

number

default:"19"

required

Invoice Number

string

default:"USD"

required

Currency

object

required

Contact Details

string

default:"2023-01-01"

required

Issue date in YYYY-MM-DD format

string

default:"2023-01-01"

required

Due date in YYYY-MM-DD format

object

Discount

string[]

required

Invoice Items

number

default:"999"

required

Total Amount

string

default:"INVOICE"

required

Title

number

default:"999"

required

Total Amount Due

string

default:"2023-12-12T09:27:42.355Z"

required

created at

string

default:"2023-12-12T09:27:42.355Z"

required

updated at

boolean

default:"True"

Automatic taxes enabled for the Invoice

boolean

default:"True"

Is Automatic taxes calculated for the Invoice items

object

split invoice into payment schedule summing up to full invoice amount

object

required

Business Details

string

default:"USD"

required

Currency

object

required

Contact Details

object

Discount

string[]

required

Invoice Items

number

default:"999"

required

Total Amount

string

default:"INVOICE"

required

Title

string

default:"Confidential"

required

Terms notes

string

default:"Confidential"

required

Compiled terms notes

string

default:"2023-12-12T09:27:42.355Z"

required

created at

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
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "name": "string",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "name": "Alex",
    "phoneNo": "+1234567890",
    "email": "alex@example.com",
    "additionalEmails": [
      {
        "email": "alex@example.com"
      }
    ],
    "companyName": "ABC Corp.",
    "address": {
      "addressLine1": "9931 Beechwood",
      "addressLine2": "Beechwood",
      "city": "St. Houston",
      "state": "TX",
      "countryCode": "US",
      "postalCode": "559-6993"
    },
    "customFields": [
      "string"
    ]
  },
  "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"
    }
  },
  "liveMode": true,
  "businessDetails": {
    "logoUrl": "https://example.com/logo.png",
    "name": "ABC Corp.",
    "phoneNo": "+1-214-559-6993",
    "address": "9931 Beechwood, TX",
    "website": "wwww.example.com",
    "customValues": [
      "string"
    ]
  },
  "currency": "string",
  "items": [
    {
      "name": "ABC Product",
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "taxes": [
        {}
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "automaticTaxesEnabled": true,
  "discount": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "termsNotes": "string",
  "title": "string",
  "invoiceNumberPrefix": "INV-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "string",
      "size": 10000
    }
  ]
}'

const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "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"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/schedule',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "name": "string", "contactDetails": {"id": "6578278e879ad2646715ba9c", "name": "Alex", "phoneNo": "+1234567890", "email": "alex@example.com", "additionalEmails": [{"email": "alex@example.com"}], "companyName": "ABC Corp.", "address": {"addressLine1": "9931 Beechwood", "addressLine2": "Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "US", "postalCode": "559-6993"}, "customFields": ["string"]}, "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"}}, "liveMode": true, "businessDetails": {"logoUrl": "https://example.com/logo.png", "name": "ABC Corp.", "phoneNo": "+1-214-559-6993", "address": "9931 Beechwood, TX", "website": "wwww.example.com", "customValues": ["string"]}, "currency": "string", "items": [{"name": "ABC Product", "description": "ABC Corp.", "productId": "6578278e879ad2646715ba9c", "priceId": "6578278e879ad2646715ba9c", "currency": "USD", "amount": 999, "qty": 1, "taxes": [{}], "automaticTaxCategoryId": "6578278e879ad2646715ba9c", "isSetupFeeItem": true, "type": "one_time", "taxInclusive": true}], "automaticTaxesEnabled": true, "discount": {"value": 10, "type": "percentage", "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"}, "termsNotes": "string", "title": "string", "invoiceNumberPrefix": "INV-", "attachments": [{"id": "6241712be68f7a98102ba272", "name": "Electronics.pdf", "url": "https://example.com/digital-delivery", "type": "string", "size": 10000}]},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/schedule');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'altId': '6578278e879ad2646715ba9c', 'altType': 'account', 'name': 'string', 'contactDetails': {'id': '6578278e879ad2646715ba9c', 'name': 'Alex', 'phoneNo': '+1234567890', 'email': 'alex@example.com', 'additionalEmails': [{'email': 'alex@example.com'}], 'companyName': 'ABC Corp.', 'address': {'addressLine1': '9931 Beechwood', 'addressLine2': 'Beechwood', 'city': 'St. Houston', 'state': 'TX', 'countryCode': 'US', 'postalCode': '559-6993'}, 'customFields': ['string']}, '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'}}, 'liveMode': true, 'businessDetails': {'logoUrl': 'https://example.com/logo.png', 'name': 'ABC Corp.', 'phoneNo': '+1-214-559-6993', 'address': '9931 Beechwood, TX', 'website': 'wwww.example.com', 'customValues': ['string']}, 'currency': 'string', 'items': [{'name': 'ABC Product', 'description': 'ABC Corp.', 'productId': '6578278e879ad2646715ba9c', 'priceId': '6578278e879ad2646715ba9c', 'currency': 'USD', 'amount': 999, 'qty': 1, 'taxes': [{}], 'automaticTaxCategoryId': '6578278e879ad2646715ba9c', 'isSetupFeeItem': true, 'type': 'one_time', 'taxInclusive': true}], 'automaticTaxesEnabled': true, 'discount': {'value': 10, 'type': 'percentage', 'validOnProductIds': '[ '6579751d56f60276e5bd4154' ]'}, 'termsNotes': 'string', 'title': 'string', 'invoiceNumberPrefix': 'INV-', 'attachments': [{'id': '6241712be68f7a98102ba272', 'name': 'Electronics.pdf', 'url': 'https://example.com/digital-delivery', 'type': 'string', 'size': 10000}]}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Create Invoice Schedule

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo