Deduction Put

put

https://api.oforce.com/partners/clients/{clientId}/settlements/{settlementId}/deductions/{deductionId}

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

uuid

required

settlementId

uuid

required

deductionId

uuid

required

Body Params

id

uuid

contractor_id

uuid

The primary key/identifier for the Contractor receiving Deduction

custom_date_field1

date-time

Any Date can be used in this field

custom_date_field2

date-time

Any Date can be used in this field

custom_date_field3

date-time

Any Date can be used in this field

custom_date_field4

date-time

Any Date can be used in this field

custom_date_field5

date-time

Any Date can be used in this field

deduction_type_id

int32

The primary key/identifier for the Deduction for the Contractor

amount

double

The Amount to be deducted from the Contractor

external_id

string

The primary key/identifier for YOUR data

custom_string_field1

string

Any String can be used in this field

custom_string_field2

string

Any String can be used in this field

custom_string_field3

string

Any String can be used in this field

custom_string_field4

string

Any String can be used in this field

custom_string_field5

string

Any String can be used in this field

stm_client_id

int32

Our internal reference to the Client

custom_string_field6

string

Any String can be used in this field

custom_string_field7

string

Any String can be used in this field

custom_string_field8

string

Any String can be used in this field

custom_string_field9

string

Any String can be used in this field

custom_string_field10

string

Any String can be used in this field

custom_string_field11

string

Any String can be used in this field

custom_string_field12

string

Any String can be used in this field

contractor_external_id

string

Any String value for the Contractor External Id

use_contractor_external_id

boolean

Any bool value to implement and use the provided ContractorExternalId for contractor lookup

Responses

201

Returns the updated Deduction

401

Unauthorized

403

Forbidden

404

Not Found

422

Entity Validation has failed

500

Server Error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json