/recovery_program/{program_id}/mark_settlement_unpaid

Mark settlement as unpaid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
required
length ≥ 1
boolean
required
boolean
required
boolean
required
boolean
required
boolean
required
boolean
required
deprecated
boolean
required
boolean
boolean
required
boolean
Defaults to false
deprecated
boolean
Defaults to false
boolean
Defaults to false
deprecated
boolean
Defaults to true
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
deprecated
boolean
Defaults to false
boolean
Defaults to false
boolean
Defaults to false
deprecated
enum
  • external_vendor - External vendor
string | null
string | null
string | null
string | null
uuid
required
date-time
required
date-time | null
boolean
Defaults to false
string
enum
  • Global - Global
  • Individual - Individual
Allowed:
boolean
string
string
tags
object
string
length ≤ 255
boolean
device_types
array of objects
device_types
integer | null
≥ 1

Expected number of devices in the recovery program. Required when a PartnerCreator creates a recovery program.

boolean
Defaults to false
uuid | null
boolean
Defaults to false
string
Defaults to 14 00:00:00
string
Defaults to 7 00:00:00
string
Defaults to 3 00:00:00
uuid | null
boolean
string
string
string
string
string
string
string
string
boolean
string
enum

Pre-bid code for the recovery program. Writable by SuperUser and PartnerCreator roles and readable by PartnerAdministrator.

  • PBALC - PBALC
  • PBPCS - PBPCS
  • PBLW - PBLW
  • PBTTR - PBTTR
  • PBDA - PBDA
  • PBUSMP - PBUSMP
  • PBSQU - PBSQU
  • PBSPRT - PBSPRT
  • PBAPK - PBAPK

  • PBALC - PBALC
  • PBPCS - PBPCS
  • PBLW - PBLW
  • PBTTR - PBTTR
  • PBDA - PBDA
  • PBUSMP - PBUSMP
  • PBSQU - PBSQU
  • PBSPRT - PBSPRT
  • PBAPK - PBAPK
boolean
Defaults to false
string
Defaults to 14 00:00:00
boolean
Defaults to false

Whether the recovery program is lease-based. Defaults to false when omitted.

enum

Customer category for the recovery program. Writable by SuperUser and PartnerCreator roles and readable by PartnerAdministrator. Required when a PartnerCreator creates a lease-based recovery program.

  • major - Major
  • channel - Channel
  • retail - Retail

  • major - Major
  • channel - Channel
  • retail - Retail
enum

Lease structure for the recovery program. Writable by SuperUser and PartnerCreator roles and readable by PartnerAdministrator. Required when a PartnerCreator creates a lease-based recovery program.

  • capex - CapEx
  • gbo - GBO
  • gbb - GBB
  • fmv - FMV

  • capex - CapEx
  • gbo - GBO
  • gbb - GBB
  • fmv - FMV
enum

Funding source for the recovery program. Writable by SuperUser and PartnerCreator roles and readable by PartnerAdministrator. Required when a PartnerCreator creates a lease-based recovery program.

  • dll - DLL
  • us_bank - US Bank
  • huntington - Huntington
  • key_bank - Key Bank
  • black_winch - Black Winch
  • other - Other

  • dll - DLL
  • us_bank - US Bank
  • huntington - Huntington
  • key_bank - Key Bank
  • black_winch - Black Winch
  • other - Other
unlocking_contacts
array of uuids
unlocking_contacts
Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json