Create a Settlement

This endpoint will create a settlement in the system that is ready to accept commissions and deductions.

For a detailed visual of the settlement creation process please view the provided PDF: Settlement Creation Process

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The data representing the settlement to be created.

uuid
date-time

The Date funds should be disbursed to the contractors

int32

The Invoice of the processed settlement

string

The primary key/identifier for YOUR data

int32
enum
Allowed:
date-time

The start date of the settlement period

date-time

The end date of the settlement period

string

Our internal reference to the file imported

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

422

Bad Request. Errors will be returned in the payload.

500

Internal Server Error

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