Record that this booking is provisional, naming the document that would settle it

POST

/v1/entities/{entity_id}/entries/{entry_id}/awaiting-document

const url = 'https://example.com/v1/entities/example/entries/example/awaiting-document';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"awaiting":"example","reason":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/entities/example/entries/example/awaiting-document \
  --header 'Content-Type: application/json' \
  --data '{ "awaiting": "example", "reason": "example" }'

Mark a posted booking as resting on an assumption that an awaited document may overturn.

The booking stands. This is not a draft and not a doubt about the amount: the entry stays posted and counts in every report, because a cost belongs in the month it happened, at the best figure available. Calling this again for the same entry restates the expectation. Filing the awaited document against the entry (POST /entries/{id}/documents) settles it.

Parameters

Path Parameters

entry_id

required

Entry Id

string

entity_id

required

Entity Id

The entity this path is relative to

string

The entity this path is relative to

Request Body^required

application/json

ExpectationSubmission

Record that a booking is provisional: it stands, and a named document is expected that may change it.

awaiting is required because what is expected is the whole content of the state: “this is provisional” without saying what would settle it helps nobody. Submitting again for an entry already awaiting something restates the expectation rather than opening a second one.

object

awaiting

required

Awaiting

The document that would settle this, in a phrase

string

>= 1 characters <= 1024 characters

reason

required

Reason

Why it was booked this way meanwhile; kept in the record

string

>= 1 characters

Example ^generated

{
  "awaiting": "example",
  "reason": "example"
}

Responses

201

Successful Response

application/json

ExpectationResponse

object

entity_id

required

Entity Id

string

legal_name

required

Legal Name

string

base_currency

required

Base Currency

string

snapshot_seq

required

Snapshot Seq

integer

expectation

required

Expectation

object

required

string

entry_id

required

Entry Id

string

state

required

State

Awaiting | met | withdrawn

string

awaiting

required

Awaiting

string

reason

required

Reason

string

evidence_id

Any of:

string
null

string

supersedes_id

required

Any of:

string
null

string

created_at

required

Created At

string

created_by

required

Created By

string

history

required

History

Every record about this entry, oldest first

Array<object>

Expectation

object

required

string

entry_id

required

Entry Id

string

state

required

State

Awaiting | met | withdrawn

string

awaiting

required

Awaiting

string

reason

required

Reason

string

evidence_id

Any of:

string
null

string

supersedes_id

required

Any of:

string
null

string

created_at

required

Created At

string

created_by

required

Created By

string

links

required

Links

object

key

additional properties

string

Example ^generated

{
  "entity_id": "example",
  "legal_name": "example",
  "base_currency": "example",
  "snapshot_seq": 1,
  "expectation": {
    "id": "example",
    "entry_id": "example",
    "state": "example",
    "awaiting": "example",
    "reason": "example",
    "evidence_id": "example",
    "supersedes_id": "example",
    "created_at": "example",
    "created_by": "example"
  },
  "history": [
    {
      "id": "example",
      "entry_id": "example",
      "state": "example",
      "awaiting": "example",
      "reason": "example",
      "evidence_id": "example",
      "supersedes_id": "example",
      "created_at": "example",
      "created_by": "example"
    }
  ],
  "links": {
    "additionalProperty": "example"
  }
}

400

Bad Request

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

401

Unauthorized

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

403

Forbidden

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

404

Not Found

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

409

Conflict

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

412

Precondition Failed

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

422

Unprocessable Content

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

500

Internal Server Error

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

503

Service Unavailable

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

Record that this booking is provisional, naming the document that would settle it

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

201

Example generated

400

Example generated

401

Example generated

403

Example generated

404

Example generated

409

Example generated

412

Example generated

422

Example generated

500

Example generated

503

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated