Deregister a person from an EMS by external id and owner id

POST

/dr/v1/expense/person/deregister

curl --request POST \
  --url https://sender.sandbox-api.kivra.com/dr/v1/expense/person/deregister \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "0123456789abcdef0123456789abcdef01234567890", "owner_id": "191039d537408dbaa8a22a0097a7f962301b36b360fe" }'

• Test environment (uses test data)
• Production environment

Access scope

• EMS

Request Body^required

Takes in a deregister person for ems object with required information to deregister a person from an EMS

Media typeapplication/json

DeregisterPersonForEMS

object

external_id

External ID of the expense management system that identifies it in foreign system

string

owner_id

The id of the person registering for expense management system

string

>= 1 characters

Example

{
  "external_id": "0123456789abcdef0123456789abcdef01234567890",
  "owner_id": "191039d537408dbaa8a22a0097a7f962301b36b360fe"
}

Responses

204

Implicit person successfully deregistered from an EMS

400

Bad request

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

Exampleunauthorized

{
  "error_code": "40000",
  "short_message": "bad request",
  "long_message": "body s missing required fields or has invalid fields"
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

Exampleunauthorized

{
  "error_code": "40100",
  "short_message": "unauthorized",
  "long_message": "permission denied"
}

404

Not found

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

Exampleresource_not_found

{
  "error_code": "40400",
  "short_message": "not found",
  "long_message": "the requested resource could not be found"
}

500

Internal server error

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Example

{
  "error_code": "50000",
  "short_message": "internal server error",
  "long_message": "unknown error ocurred"
}