Spend Control Create V1

Create a spend control Listed below are the options for spend control types and their corresponding required inputs

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Defaults to customer-spendcontrol

customer-spendcontrol

string
Defaults to spend-control

spend-control

string
Defaults to create

create

int32
Defaults to 1

1

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string
enum

Type code of spend control being created
TRANTOTALFROMTIME (Each time this control is created, the calculated amount will be reset to 0)

Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 50

string
enum

Object type that a spend control is being created for

Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 40

Allowed:
string

Unique identifier of specific object that a spend control is being created for
If objectReferenceNumber has not been provided, objectUuid must be provided

Data type: uuid
Required: no
Letters: yes
Numbers: no
Special: no
Min: 36
Max: 36

string

if objectUuid is not provided, objectReferenceNumber must be provided

Data type: varchar
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 5
Max: 50

int32
Defaults to 0

Valid values
1
0
Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

int32
Defaults to 0

Default is set to 0

Data type: number
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 2

float



Data type: money
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 25

float



Data type: money
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 25

int32



Data type: number
Required: no
Letters: no
Numbers: yes
Special: no
Min: 3
Max: 10

string

Vaild special character: space (' ')

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000

string

Invaild special character: comma (,)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 4
Max: 4000

boolean
Defaults to false

0 = debug off
1 = debug on
Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

Language
LoadingLoading…
Response
Choose an example:
application/json