ScheduleVersion: v3
Schedule an schedule invoice
POST/invoices/schedule/{scheduleId}/schedule
API to schedule an schedule invoice to start sending to the customer
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
invoices/Auth methods:
OAuthPrivate IntegrationToken types:
Sub-Account TokenAgency TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
scheduleIdstringrequired
Schedule Id
Example:
6578278e879ad2646715ba9cBody
altIdstringrequired
location Id / company Id based on altType
Example:
6578278e879ad2646715ba9caltTypestringrequired
Alt Type
Available options
locationExample:
locationliveModebooleanrequired
autoPaymentobject
auto-payment configuration
Response
Successful response
_idstringrequired
Schedule Id
Example:
6578278e879ad2646715ba9cstatusobjectrequired
Schedule Status
Example:
draftliveModebooleanrequired
Live Mode
Example:
falsealtIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
locationnamestringrequired
Name of the invoice
Example:
New Invoicescheduleobject
invoicesobject[]required
List of invoices
businessDetailsobjectrequired
Business Details
currencystringrequired
Currency
Example:
USDcontactDetailsobjectrequired
Contact Details
discountobject
Discount
itemsstring[]required
Invoice Items
totalnumberrequired
Total Amount
Example:
999titlestringrequired
Title
Example:
INVOICEtermsNotesstringrequired
Terms notes
Example:
ConfidentialcompiledTermsNotesstringrequired
Compiled terms notes
Example:
ConfidentialcreatedAtstringrequired
created at
Example:
2023-12-12T09:27:42.355ZupdatedAtstringrequired
updated at
Example:
2023-12-12T09:27:42.355Z