List schedules

GEThttps://services.leadconnectorhq.com/invoices/schedule
API to get list of schedules
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Query Parameters
endAt
string

endAt in YYYY-MM-DD format

Examples:
2023-01-01
paymentMode
string

payment mode

Allowed values:
defaultlivetest
Examples:
live
search
string

To search for an invoice by id / name / email / phoneNo

Examples:
Alex
startAt
string

startAt in YYYY-MM-DD format

Examples:
2023-01-01
status
string

status to be filtered

altId
string
required

location Id / company Id based on altType

Examples:
6578278e879ad2646715ba9c
altType
string
required

Alt Type

Allowed value:
location
Examples:
location
limit
string
required

Limit the number of items to return

Examples:
10
offset
string
required

Number of items to skip

Examples:
10
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

schedules
array[object]
required
_id
string
required

Schedule Id

Example:
6578278e879ad2646715ba9c
status
object
required

Schedule Status

Example:
draft
liveMode
boolean
required

Live Mode

Example:
false
altId
string
required

Location Id or Agency Id

Example:
6578278e879ad2646715ba9c
altType
string
required
Allowed value:
location
name
string
required

Name of the invoice

Example:
New Invoice
schedule
object
executeAt
string
rrule
object
intervalType
string
required
Allowed values:
yearlymonthlyweeklydailyhourlyminutelysecondly
Example:
monthly
interval
number
required
Example:
2
startDate
string
required

Start date in YYYY-MM-DD format

Example:
2023-01-01
startTime
string

Start time in HH:mm:ss format

Example:
20:45:00
endDate
string

End date in YYYY-MM-DD format

Example:
2029-11-01
endTime
string

End time in HH:mm:ss format

Example:
18:45:00
dayOfMonth
number

-1, 1, 2, 3, ..., 27, 28

Example:
15
dayOfWeek
string
Allowed values:
motuwethfrsasu
Example:
mo
numOfWeek
number

-1, 1, 2, 3, 4

Example:
-1
monthOfYear
string
Allowed values:
janfebmaraprmayjunjulaugsepoctnovdec
Example:
jan
count
number

Max number of task executions

Example:
10
daysBefore
number

Execute task number of days before

Example:
5
useStartAsPrimaryUserAccepted
boolean

Start as primary user accepted date

Example:
true
endType
string

End type like after, by, count

Example:
by
invoices
array[object]
required

List of invoices

_id
string
required

Invoice Id

Example:
6578278e879ad2646715ba9c
status
string
required

Invoice Status

Allowed values:
draftsentpayment_processingpaidvoidpartially_paid
Example:
draft
liveMode
boolean
required

Live Mode

Example:
false
amountPaid
number
required

Amount Paid

Example:
0
altId
string
required

Location Id or Agency Id

Example:
6578278e879ad2646715ba9c
altType
string
required
Allowed value:
location
name
string
required

Name of the invoice

Example:
New Invoice
businessDetails
object
required

Business Details

Example:
{"name":"Alex","address":{"addressLine1":"9931 Beechwood","city":"St. Houston","state":"TX","countryCode":"USA","postalCode":"559-6993"},"phoneNo":"+1-214-559-6993","website":"www.example.com"}
invoiceNumber
number
required

Invoice Number

Example:
19
currency
string
required

Currency

Example:
USD
contactDetails
object
required

Contact Details

Example:
{"id":"c6tZZU0rJBf30ZXx9Gli","phoneNo":"+1-214-559-6993","email":"alex@example.com","customFields":[],"name":"Alex","address":{"countryCode":"US"}}
issueDate
string
required

Issue date in YYYY-MM-DD format

Example:
2023-01-01
dueDate
string
required

Due date in YYYY-MM-DD format

Example:
2023-01-01
discount
object

Discount

Example:
{"type":"percentage","value":0}
invoiceItems
array[string]
required

Invoice Items

Example:
[{"taxes":[],"_id":"c6tZZU0rJBf30ZXx9Gli","productId":"c6tZZU0rJBf30ZXx9Gli","priceId":"c6tZZU0rJBf30ZXx9Gli","currency":"USD","name":"Macbook Pro","qty":1,"amount":999}]
total
number
required

Total Amount

Example:
999
title
string
required

Title

Example:
INVOICE
amountDue
number
required

Total Amount Due

Example:
999
createdAt
string
required

created at

Example:
2023-12-12T09:27:42.355Z
updatedAt
string
required

updated at

Example:
2023-12-12T09:27:42.355Z
automaticTaxesEnabled
boolean

Automatic taxes enabled for the Invoice

Example:
true
automaticTaxesCalculated
boolean

Is Automatic taxes calculated for the Invoice items

Example:
true
paymentSchedule
object

split invoice into payment schedule summing up to full invoice amount

businessDetails
object
required

Business Details

Example:
{"name":"Alex","address":{"addressLine1":"9931 Beechwood","city":"St. Houston","state":"TX","countryCode":"USA","postalCode":"559-6993"},"phoneNo":"+1-214-559-6993","website":"www.example.com"}
logoUrl
string

Business Logo URL

Example:
https://example.com/logo.png
name
string

Business Name

Example:
ABC Corp.
phoneNo
string

Business Phone Number

Example:
+1-214-559-6993
address
object

Business Address

Example:
9931 Beechwood, TX
website
string

Business Website Link

Example:
wwww.example.com
customValues
array[string]

Custom Values

currency
string
required

Currency

Example:
USD
contactDetails
object
required

Contact Details

Example:
{"id":"c6tZZU0rJBf30ZXx9Gli","phoneNo":"+1-214-559-6993","email":"alex@example.com","customFields":[],"name":"Alex","address":{"countryCode":"US"}}
id
string
required

Contact ID

Example:
6578278e879ad2646715ba9c
name
string
required

Contact Name

Example:
Alex
phoneNo
string

Contact Phone Number

Example:
+1234567890
email
string

Contact Email

Example:
alex@example.com
additionalEmails
array[object]

Secondary email addresses for the contact to be saved

email
string
required
Example:
alex@example.com
companyName
string

Contact Company Name

Example:
ABC Corp.
address
object
addressLine1
string

Address Line 1

Example:
9931 Beechwood
addressLine2
string

Address Line 2

Example:
Beechwood
city
string

City

Example:
St. Houston
state
string

State

Example:
TX
countryCode
string

Country Code

Example:
US
postalCode
string

Postal Code

Example:
559-6993
customFields
array[string]

Custom Values

discount
object

Discount

Example:
{"type":"percentage","value":0}
value
number

Discount Value

Default:
0
Example:
10
type
string
required

Discount type

Allowed values:
percentagefixed
Default:
percentage
Example:
percentage
validOnProductIds
array[string]

Product Ids on which discount is applicable

Example:
[ '6579751d56f60276e5bd4154' ]
items
array[string]
required

Invoice Items

Example:
[{"taxes":[],"_id":"c6tZZU0rJBf30ZXx9Gli","productId":"c6tZZU0rJBf30ZXx9Gli","priceId":"c6tZZU0rJBf30ZXx9Gli","currency":"USD","name":"Macbook Pro","qty":1,"amount":999}]
total
number
required

Total Amount

Example:
999
title
string
required

Title

Example:
INVOICE
termsNotes
string
required

Terms notes

Example:
Confidential
compiledTermsNotes
string
required

Compiled terms notes

Example:
Confidential
createdAt
string
required

created at

Example:
2023-12-12T09:27:42.355Z
updatedAt
string
required

updated at

Example:
2023-12-12T09:27:42.355Z
total
number
required

Total number of Schedules

Example:
100

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request