Create & Send

POST

invoices

text2pay

Create & Send

curl --request POST \
  --url https://services.leadconnectorhq.com/invoices/text2pay \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "currency": "USD",
  "items": [
    {
      "name": "ABC Product",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "taxes": [
        {
          "_id": "<string>",
          "name": "<string>",
          "rate": 123,
          "calculation": "exclusive",
          "description": "<string>",
          "taxId": "<string>"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "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>"
    ]
  },
  "issueDate": "2023-01-01",
  "sentTo": {
    "email": [
      "alex@example.com"
    ],
    "emailCc": [
      "alex@example.com"
    ],
    "emailBcc": [
      "alex@example.com"
    ],
    "phoneNo": [
      "+1-214-559-6993"
    ]
  },
  "liveMode": true,
  "action": "draft",
  "userId": "<string>",
  "termsNotes": "<p>This is a default terms.</p>",
  "title": "INVOICE",
  "invoiceNumber": "1001",
  "dueDate": "2023-01-14",
  "automaticTaxesEnabled": true,
  "invoiceNumberPrefix": "INV-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ],
  "id": "<string>",
  "includeTermsNote": 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>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Version: '<version>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    altId: '6578278e879ad2646715ba9c',
    altType: 'location',
    name: 'New Invoice',
    currency: 'USD',
    items: [
      {
        name: 'ABC Product',
        currency: 'USD',
        amount: 999,
        qty: 1,
        description: 'ABC Corp.',
        productId: '6578278e879ad2646715ba9c',
        priceId: '6578278e879ad2646715ba9c',
        taxes: [
          {
            _id: '<string>',
            name: '<string>',
            rate: 123,
            calculation: 'exclusive',
            description: '<string>',
            taxId: '<string>'
          }
        ],
        automaticTaxCategoryId: '6578278e879ad2646715ba9c',
        isSetupFeeItem: true,
        type: 'one_time',
        taxInclusive: true
      }
    ],
    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>']
    },
    issueDate: '2023-01-01',
    sentTo: {
      email: ['alex@example.com'],
      emailCc: ['alex@example.com'],
      emailBcc: ['alex@example.com'],
      phoneNo: ['+1-214-559-6993']
    },
    liveMode: true,
    action: 'draft',
    userId: '<string>',
    termsNotes: '<p>This is a default terms.</p>',
    title: 'INVOICE',
    invoiceNumber: '1001',
    dueDate: '2023-01-14',
    automaticTaxesEnabled: true,
    invoiceNumberPrefix: 'INV-',
    attachments: [
      {
        id: '6241712be68f7a98102ba272',
        name: 'Electronics.pdf',
        url: 'https://example.com/digital-delivery',
        type: '<string>',
        size: 10000
      }
    ],
    id: '<string>',
    includeTermsNote: 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>']
    }
  })
};

fetch('https://services.leadconnectorhq.com/invoices/text2pay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/invoices/text2pay"

payload = {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "New Invoice",
    "currency": "USD",
    "items": [
        {
            "name": "ABC Product",
            "currency": "USD",
            "amount": 999,
            "qty": 1,
            "description": "ABC Corp.",
            "productId": "6578278e879ad2646715ba9c",
            "priceId": "6578278e879ad2646715ba9c",
            "taxes": [
                {
                    "_id": "<string>",
                    "name": "<string>",
                    "rate": 123,
                    "calculation": "exclusive",
                    "description": "<string>",
                    "taxId": "<string>"
                }
            ],
            "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
            "isSetupFeeItem": True,
            "type": "one_time",
            "taxInclusive": True
        }
    ],
    "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>"]
    },
    "issueDate": "2023-01-01",
    "sentTo": {
        "email": ["alex@example.com"],
        "emailCc": ["alex@example.com"],
        "emailBcc": ["alex@example.com"],
        "phoneNo": ["+1-214-559-6993"]
    },
    "liveMode": True,
    "action": "draft",
    "userId": "<string>",
    "termsNotes": "<p>This is a default terms.</p>",
    "title": "INVOICE",
    "invoiceNumber": "1001",
    "dueDate": "2023-01-14",
    "automaticTaxesEnabled": True,
    "invoiceNumberPrefix": "INV-",
    "attachments": [
        {
            "id": "6241712be68f7a98102ba272",
            "name": "Electronics.pdf",
            "url": "https://example.com/digital-delivery",
            "type": "<string>",
            "size": 10000
        }
    ],
    "id": "<string>",
    "includeTermsNote": 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>"]
    }
}
headers = {
    "Version": "<version>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "invoice": {
    "_id": "6578278e879ad2646715ba9c",
    "status": "draft",
    "liveMode": false,
    "amountPaid": 0,
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "New Invoice",
    "businessDetails": {
      "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": "19",
    "currency": "USD",
    "contactDetails": {
      "id": "c6tZZU0rJBf30ZXx9Gli",
      "phoneNo": "+1-214-559-6993",
      "email": "alex@example.com",
      "customFields": [],
      "name": "Alex",
      "address": {
        "countryCode": "US"
      }
    },
    "issueDate": "2023-01-01",
    "dueDate": "2023-01-01",
    "invoiceItems": [
      {
        "taxes": [],
        "_id": "c6tZZU0rJBf30ZXx9Gli",
        "productId": "c6tZZU0rJBf30ZXx9Gli",
        "priceId": "c6tZZU0rJBf30ZXx9Gli",
        "currency": "USD",
        "name": "Macbook Pro",
        "qty": 1,
        "amount": 999
      }
    ],
    "total": 999,
    "title": "INVOICE",
    "amountDue": 999,
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z",
    "discount": {
      "type": "percentage",
      "value": 0
    },
    "automaticTaxesEnabled": true,
    "automaticTaxesCalculated": true,
    "paymentSchedule": {}
  },
  "invoiceUrl": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Headers

Version

enum<string>

required

API Version

Available options:

2021-07-28

Body

application/json

altId

string

required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

altType

enum<string>

required

Alt Type

Available options:

location

Example:

"location"

name

string

required

Invoice Name

Example:

"New Invoice"

currency

string

required

Currency code

Example:

"USD"

items

object[]

required

An array of items for the invoice.

Show child attributes

contactDetails

object

required

Show child attributes

issueDate

string

required

Issue date in YYYY-MM-DD format

Example:

"2023-01-01"

sentTo

object

required

Show child attributes

liveMode

boolean

required

action

enum<string>

required

create invoice in draft mode or send mode

Available options:

draft,

send

Example:

"draft"

userId

string

required

id of user generating invoice

termsNotes

string

Terms notes, Also supports HTML markups

Example:

"<p>This is a default terms.</p>"

title

string

Title for the invoice

Example:

"INVOICE"

invoiceNumber

string

Invoice Number

Example:

"1001"

dueDate

string

Due date in YYYY-MM-DD format

Example:

"2023-01-14"

automaticTaxesEnabled

boolean

Automatic taxes enabled for the Invoice

Example:

true

paymentSchedule

object

Show child attributes

lateFeesConfiguration

object

Show child attributes

tipsConfiguration

object

Show child attributes

invoiceNumberPrefix

string

prefix for invoice number

Example:

"INV-"

paymentMethods

object

Show child attributes

attachments

object[]

attachments for the invoice

Show child attributes

miscellaneousCharges

object

Show child attributes

string

id of invoice to update. If skipped, a new invoice will be created

includeTermsNote

boolean

include terms & notes with receipts

Example:

true

discount

object

Show child attributes

businessDetails

object

Show child attributes

Response

Successful response

invoice

object

required

Show child attributes

invoiceUrl

string

required

preview url of generated invoice

Last modified on March 8, 2026

Record a manual payment for an invoice

List invoices

Create & Send

curl --request POST \
  --url https://services.leadconnectorhq.com/invoices/text2pay \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "currency": "USD",
  "items": [
    {
      "name": "ABC Product",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "taxes": [
        {
          "_id": "<string>",
          "name": "<string>",
          "rate": 123,
          "calculation": "exclusive",
          "description": "<string>",
          "taxId": "<string>"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "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>"
    ]
  },
  "issueDate": "2023-01-01",
  "sentTo": {
    "email": [
      "alex@example.com"
    ],
    "emailCc": [
      "alex@example.com"
    ],
    "emailBcc": [
      "alex@example.com"
    ],
    "phoneNo": [
      "+1-214-559-6993"
    ]
  },
  "liveMode": true,
  "action": "draft",
  "userId": "<string>",
  "termsNotes": "<p>This is a default terms.</p>",
  "title": "INVOICE",
  "invoiceNumber": "1001",
  "dueDate": "2023-01-14",
  "automaticTaxesEnabled": true,
  "invoiceNumberPrefix": "INV-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ],
  "id": "<string>",
  "includeTermsNote": 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>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Version: '<version>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    altId: '6578278e879ad2646715ba9c',
    altType: 'location',
    name: 'New Invoice',
    currency: 'USD',
    items: [
      {
        name: 'ABC Product',
        currency: 'USD',
        amount: 999,
        qty: 1,
        description: 'ABC Corp.',
        productId: '6578278e879ad2646715ba9c',
        priceId: '6578278e879ad2646715ba9c',
        taxes: [
          {
            _id: '<string>',
            name: '<string>',
            rate: 123,
            calculation: 'exclusive',
            description: '<string>',
            taxId: '<string>'
          }
        ],
        automaticTaxCategoryId: '6578278e879ad2646715ba9c',
        isSetupFeeItem: true,
        type: 'one_time',
        taxInclusive: true
      }
    ],
    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>']
    },
    issueDate: '2023-01-01',
    sentTo: {
      email: ['alex@example.com'],
      emailCc: ['alex@example.com'],
      emailBcc: ['alex@example.com'],
      phoneNo: ['+1-214-559-6993']
    },
    liveMode: true,
    action: 'draft',
    userId: '<string>',
    termsNotes: '<p>This is a default terms.</p>',
    title: 'INVOICE',
    invoiceNumber: '1001',
    dueDate: '2023-01-14',
    automaticTaxesEnabled: true,
    invoiceNumberPrefix: 'INV-',
    attachments: [
      {
        id: '6241712be68f7a98102ba272',
        name: 'Electronics.pdf',
        url: 'https://example.com/digital-delivery',
        type: '<string>',
        size: 10000
      }
    ],
    id: '<string>',
    includeTermsNote: 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>']
    }
  })
};

fetch('https://services.leadconnectorhq.com/invoices/text2pay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/invoices/text2pay"

payload = {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "New Invoice",
    "currency": "USD",
    "items": [
        {
            "name": "ABC Product",
            "currency": "USD",
            "amount": 999,
            "qty": 1,
            "description": "ABC Corp.",
            "productId": "6578278e879ad2646715ba9c",
            "priceId": "6578278e879ad2646715ba9c",
            "taxes": [
                {
                    "_id": "<string>",
                    "name": "<string>",
                    "rate": 123,
                    "calculation": "exclusive",
                    "description": "<string>",
                    "taxId": "<string>"
                }
            ],
            "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
            "isSetupFeeItem": True,
            "type": "one_time",
            "taxInclusive": True
        }
    ],
    "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>"]
    },
    "issueDate": "2023-01-01",
    "sentTo": {
        "email": ["alex@example.com"],
        "emailCc": ["alex@example.com"],
        "emailBcc": ["alex@example.com"],
        "phoneNo": ["+1-214-559-6993"]
    },
    "liveMode": True,
    "action": "draft",
    "userId": "<string>",
    "termsNotes": "<p>This is a default terms.</p>",
    "title": "INVOICE",
    "invoiceNumber": "1001",
    "dueDate": "2023-01-14",
    "automaticTaxesEnabled": True,
    "invoiceNumberPrefix": "INV-",
    "attachments": [
        {
            "id": "6241712be68f7a98102ba272",
            "name": "Electronics.pdf",
            "url": "https://example.com/digital-delivery",
            "type": "<string>",
            "size": 10000
        }
    ],
    "id": "<string>",
    "includeTermsNote": 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>"]
    }
}
headers = {
    "Version": "<version>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "invoice": {
    "_id": "6578278e879ad2646715ba9c",
    "status": "draft",
    "liveMode": false,
    "amountPaid": 0,
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "name": "New Invoice",
    "businessDetails": {
      "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": "19",
    "currency": "USD",
    "contactDetails": {
      "id": "c6tZZU0rJBf30ZXx9Gli",
      "phoneNo": "+1-214-559-6993",
      "email": "alex@example.com",
      "customFields": [],
      "name": "Alex",
      "address": {
        "countryCode": "US"
      }
    },
    "issueDate": "2023-01-01",
    "dueDate": "2023-01-01",
    "invoiceItems": [
      {
        "taxes": [],
        "_id": "c6tZZU0rJBf30ZXx9Gli",
        "productId": "c6tZZU0rJBf30ZXx9Gli",
        "priceId": "c6tZZU0rJBf30ZXx9Gli",
        "currency": "USD",
        "name": "Macbook Pro",
        "qty": 1,
        "amount": 999
      }
    ],
    "total": 999,
    "title": "INVOICE",
    "amountDue": 999,
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z",
    "discount": {
      "type": "percentage",
      "value": 0
    },
    "automaticTaxesEnabled": true,
    "automaticTaxesCalculated": true,
    "paymentSchedule": {}
  },
  "invoiceUrl": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Invoices

Payments

Products

Store

Documents & Contracts

Headers

Body

Response