Skip to main content
API to get invoice by invoice id 
GET https://services.leadconnectorhq.com/invoices/{invoiceId}

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
invoiceId
string
default:"6578278e879ad2646715ba9c"
required
Invoice Id

​
Query parameters

​
altId
string
default:"6578278e879ad2646715ba9c"
required
account Id / company Id based on altType
​
altType
string
default:"account"
required
Alt Type

​
Respuestas

​
_id
string
default:"6578278e879ad2646715ba9c"
required
Invoice Id
​
status
string
default:"draft"
required
Invoice Status Posibles valores: ‘draft’, ‘sent’, ‘payment_processing’, ‘paid’, ‘void’, ‘partially_paid’
​
liveMode
boolean
default:"False"
required
Live Mode
​
amountPaid
number
default:"0"
required
Amount Paid
​
altId
string
default:"6578278e879ad2646715ba9c"
required
Account Id or Agency Id
​
altType
string
required
Posibles valores: ‘account’
​
name
string
default:"New Invoice"
required
Name of the invoice
​
businessDetails
object
required
Business Details
​
invoiceNumber
number
default:"19"
required
Invoice Number
​
currency
string
default:"USD"
required
Currency
​
contactDetails
object
required
Contact Details
​
issueDate
string
default:"2023-01-01"
required
Issue date in YYYY-MM-DD format
​
dueDate
string
default:"2023-01-01"
required
Due date in YYYY-MM-DD format
​
discount
object
Discount
​
invoiceItems
string[]
required
Invoice Items
​
total
number
default:"999"
required
Total Amount
​
title
string
default:"INVOICE"
required
Title
​
amountDue
number
default:"999"
required
Total Amount Due
​
createdAt
string
default:"2023-12-12T09:27:42.355Z"
required
created at
​
updatedAt
string
default:"2023-12-12T09:27:42.355Z"
required
updated at
​
automaticTaxesEnabled
boolean
default:"True"
Automatic taxes enabled for the Invoice
​
automaticTaxesCalculated
boolean
default:"True"
Is Automatic taxes calculated for the Invoice items
​
paymentSchedule
object
split invoice into payment schedule summing up to full invoice amount
​
totalSummary
object
required
​
remindersConfiguration
object
Reminders Configuration
{
  "_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
  },
  "invoiceItems": [
  // truncado: 25 lineas mas
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/invoices/YOUR_invoiceId',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/YOUR_invoiceId');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);