Skip to main content
POST
Cancel an scheduled invoice

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Path Parameters

scheduleId
string
required

Schedule Id

Example:

"6578278e879ad2646715ba9c"

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"

Response

Successful response

_id
string
required

Schedule Id

Example:

"6578278e879ad2646715ba9c"

status
object
required

Schedule Status

Example:

"draft"

liveMode
boolean
required

Live Mode

Example:

false

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
name
string
required

Name of the invoice

Example:

"New Invoice"

invoices
object[]
required

List of invoices

businessDetails
object
required
Example:
currency
string
required

Currency

Example:

"USD"

contactDetails
object
required
Example:
items
string[]
required

Invoice Items

Example:
total
number
required

Total Amount

Example:

999

title
string
required

Title

Example:

"INVOICE"

termsNotes
string
required

Terms notes

Example:

"Confidential"

compiledTermsNotes
string
required

Compiled terms notes

Example:

"Confidential"

createdAt
string
required

created at

Example:

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

updatedAt
string
required

updated at

Example:

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

schedule
object
discount
object
Example:
Last modified on March 8, 2026