Send invoice

API to send invoice by invoice id

POST https://services.leadconnectorhq.com/invoices/{invoiceId}/send

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.

Path parameters

string

default:"6578278e879ad2646715ba9c"

required

Invoice Id

Body

string

default:"6578278e879ad2646715ba9c"

required

account Id / company Id based on altType

string

default:"account"

required

Alt Type Posibles valores: ‘account’

string

default:"6578278e879ad2646715ba9c"

required

Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this account. This account will serve as the primary channel for all future communications and updates.

string

required

Posibles valores: ‘sms_and_email’, ‘send_manually’, ‘email’, ‘sms’

boolean

required

object

sender details for invoice, valid only if invoice is not sent manually

object

auto-payment configuration

Respuestas

200 - Successful response

object

required

Show propiedades

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

object

required

{
  "invoice": {
    "_id": "6578278e879ad2646715ba9c",
    "status": "draft",
    "liveMode": false,
    "amountPaid": 0,
    "altId": "6578278e879ad2646715ba9c",
    "altType": "account",
    "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",
    "discount": {
      "type": "percentage",
      "value": 0
    },
  // truncado: 24 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "userId": "6578278e879ad2646715ba9c",
  "action": "sms_and_email",
  "liveMode": true
}'

const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "userId": "6578278e879ad2646715ba9c", "action": "sms_and_email", "liveMode": true}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "userId": "6578278e879ad2646715ba9c", "action": "sms_and_email", "liveMode": true},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId/send');
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', 'userId': '6578278e879ad2646715ba9c', 'action': 'sms_and_email', 'liveMode': true}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Path parameters

Body

Respuestas

Ejemplo

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo