Manage Auto payment for an schedule invoice

API to manage auto payment for a schedule

POST https://services.leadconnectorhq.com/invoices/schedule/{scheduleId}/auto-payment

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

scheduleId

string

default:"6578278e879ad2646715ba9c"

required

Schedule Id

Body

altId

string

default:"6578278e879ad2646715ba9c"

required

account Id / company Id based on altType

altType

string

default:"account"

required

Alt Type Posibles valores: ‘account’

string

required

autoPayment

object

required

auto-payment configuration

Respuestas

200 - Successful response

_id

string

default:"6578278e879ad2646715ba9c"

required

Schedule Id

status

object

default:"draft"

required

Schedule Status

liveMode

boolean

default:"False"

required

Live Mode

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

schedule

object

Show propiedades

executeAt

string

rrule

object

Show propiedades

intervalType

string

default:"monthly"

required

Posibles valores: ‘yearly’, ‘monthly’, ‘weekly’, ‘daily’, ‘hourly’, ‘minutely’, ‘secondly’

interval

number

default:"2"

required

startDate

string

default:"2023-01-01"

required

Start date in YYYY-MM-DD format

startTime

string

default:"20:45:00"

Start time in HH:mm:ss format

endDate

string

default:"2029-11-01"

End date in YYYY-MM-DD format

endTime

string

default:"18:45:00"

End time in HH:mm:ss format

dayOfMonth

number

default:"15"

-1, 1, 2, 3, …, 27, 28

dayOfWeek

string

default:"mo"

Posibles valores: ‘mo’, ‘tu’, ‘we’, ‘th’, ‘fr’, ‘sa’, ‘su’

numOfWeek

number

default:"-1"

-1, 1, 2, 3, 4

monthOfYear

string

default:"jan"

Posibles valores: ‘jan’, ‘feb’, ‘mar’, ‘apr’, ‘may’, ‘jun’, ‘jul’, ‘aug’, ‘sep’, ‘oct’, ‘nov’, ‘dec’

count

number

default:"10"

Max number of task executions

daysBefore

number

default:"5"

Execute task number of days before

useStartAsPrimaryUserAccepted

boolean

default:"True"

Start as primary user accepted date

endType

string

default:"by"

End type like after, by, count

invoices

object[]

required

List of invoices

Show cada item

_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

businessDetails

object

required

Business Details

currency

string

default:"USD"

required

Currency

contactDetails

object

required

Contact Details

discount

object

Discount

items

string[]

required

Invoice Items

total

number

default:"999"

required

Total Amount

title

string

default:"INVOICE"

required

Title

termsNotes

string

default:"Confidential"

required

Terms notes

compiledTermsNotes

string

default:"Confidential"

required

Compiled terms notes

createdAt

string

default:"2023-12-12T09:27:42.355Z"

required

created at

updatedAt

string

default:"2023-12-12T09:27:42.355Z"

required

updated at

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "draft",
  "liveMode": false,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "name": "New Invoice",
  "schedule": {
    "executeAt": "string",
    "rrule": {
      "intervalType": "monthly",
      "interval": 2,
      "startDate": "2023-01-01",
      "startTime": "20:45:00",
      "endDate": "2029-11-01",
      "endTime": "18:45:00",
      "dayOfMonth": 15,
      "dayOfWeek": "mo",
      "numOfWeek": -1,
      "monthOfYear": "jan",
      "count": 10,
      "daysBefore": 5,
      "useStartAsPrimaryUserAccepted": true,
      "endType": "by"
    }
  },
  "invoices": [
    {
      "_id": "6578278e879ad2646715ba9c",
      "status": "draft",
      "liveMode": false,
      "amountPaid": 0,
      "altId": "6578278e879ad2646715ba9c",
      "altType": "account",
      "name": "New Invoice",
      "businessDetails": {
        "name": "Alex",
        "address": {
          "addressLine1": "9931 Beechwood",
  // truncado: 94 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "account",
  "id": "string"
}'

const response = await fetch('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "6578278e879ad2646715ba9c", "altType": "account", "id": "string"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "6578278e879ad2646715ba9c", "altType": "account", "id": "string"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/invoices/schedule/YOUR_scheduleId/auto-payment');
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', 'id': 'string'}),
]);
$data = json_decode(curl_exec($ch), true);

​Autorización

​Path parameters

​Body

​Respuestas

​Ejemplo

Autorización

Path parameters

Body

Respuestas

Ejemplo