List invoices

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

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
contactId
string

Contact ID for the invoice

Examples:
AmuzcoPBpgKeccNsFlib
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
sortField
string

The field on which sorting should be applied

Allowed value:
issueDate
Examples:
issueDate
sortOrder
string

The order of sort which should be applied for the sortField

Allowed values:
ascenddescend
Examples:
descend
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

invoices
array[object]
required
_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

totalSummary
object
required
subTotal
number
required

subTotal

Example:
999
discount
number
required

discount

Example:
0
tax
number
required

tax

Example:
0
remindersConfiguration
object

Reminders Configuration

reminderExecutionDetailsList
object
required

List of reminders

reminderSettings
object
required

Reminder settings

defaultEmailTemplateId
string
required

default template Id of reminder

Example:
dhwjqi2899012990w2u
reminders
array[object]
required

List of reminders

enabled
boolean
required

Flag indicating if the reminder is enabled or not

Example:
true
emailTemplate
string
required

Email template to be used for sending reminders

Example:
default
smsTemplate
string
required

SMS template to be used for sending reminders

Example:
default
emailSubject
string
required

Subject of the reminder

Example:
Reminder
reminderId
string
required

Unique identifier for the reminder

Example:
9333e45f-a27d-4659-90e5-76c5ef06d094
reminderName
string
required

Name of the reminder

Example:
Special Reminder
reminderTime
string
required

Time condition for the reminder

Allowed values:
beforeafter
Example:
before
intervalType
string
required

Interval type for the reminder

Allowed values:
yearlymonthlyweeklydailyhourlyminutelysecondly
Example:
daily
maxReminders
number
required

Maximum number of reminders that can be sent

Example:
3
reminderInvoiceCondition
string
required

Condition for sending the reminder

Allowed values:
invoice_sentinvoice_overdue
Example:
invoice_sent
reminderNumber
number
required

frequency gap of the reminder to exeucte

Example:
10
startTime
string

Business Hour Start Time

Example:
9:00 AM
endTime
string

Business Hour End Time

Example:
5:00 PM
timezone
string

Timezone at which reminder will be sent

Example:
businessTZ
total
number
required

Total number of invoices

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