Spend Control Delete V1

post

https://processor-api.uat1.pcaasa.com/?call=spend-control-delete-v1

Mark a single or multiple spend control(s) as 'inactive' thus leaving the record(s) searchable to display a spend control's history by spend control uuid.

Body Params

app

string

Defaults to customer-spendcontrol

customer-spendcontrol

object

string

Defaults to spend-control

spend-control

action

string

Defaults to delete

delete

version

int32

Defaults to 1

sessionUuid

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

externalTranUuid

string

Identifier for tracking this API call

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

spendControlUuid

string

Identifier for a specific spend control

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

debug

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

objectUuid

string

Identifier for a specific object (HoldingCompany to plastic)
Conditionally required
If spendControlUuid and objectReferenceNumber have not been provided, objectUuid must be provided

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

objectReferenceNumber

string

ReferenceNumber for the specific object a spend control corresponds to
Conditionally required
If spendControlUuid and objectUuid have not been provided, objectReferenceNumber must be provided

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

objectType

string

enum

Identifier for a specific object
Conditionally required
Allowed and required only when objectUuid and/or objectReferenceNumber is provided

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

Allowed:

spendControlTypeCode

string

enum

Conditionally required
Allowed and required only when objectUuid and/or objectReferenceNumber is provided and deleteAll is set to 0

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

deleteAll

boolean

Defaults to false

Valid values
1
0
Default is set to 0
if spendControlUuid is passed in, deleteAll is not allowed to be '1'
If is set to '1', spendControlTypeCode is not allowed

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

Response

200200