No document is coming: the booking stands as it is, and the reason says why
POST
/v1/entities/{entity_id}/entries/{entry_id}/awaiting-document/withdraw
const url = 'https://example.com/v1/entities/example/entries/example/awaiting-document/withdraw';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"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/withdraw \ --header 'Content-Type: application/json' \ --data '{ "reason": "example" }'Close an expectation because no document is coming; the booking stands as it is.
This is kept separate from a document arriving. A simplified receipt the supplier will never reissue settles the question, but not the way an invoice would, and the record keeps the two apart so the reason each item left the provisional list stays true.
Parameters
Section titled “Parameters”Path Parameters
Section titled “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 Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
WithdrawalSubmission
No document is coming. The booking stands as it is, and the reason says why it is no longer provisional.
This is deliberately a different act from the document arriving. A receipt that will never be reissued is a different fact about the books from an invoice that turned up, and the record keeps them apart.
object
reason
required
Reason
Why no document is expected any more
string
Example generated
{ "reason": "example"}Responses
Section titled “Responses”Successful Response
Media typeapplication/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
id
required
Id
string
entry_id
required
Entry Id
string
state
required
State
Awaiting | met | withdrawn
string
awaiting
required
Awaiting
string
reason
required
Reason
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>
Expectationobject
id
required
Id
string
entry_id
required
Entry Id
string
state
required
State
Awaiting | met | withdrawn
string
awaiting
required
Awaiting
string
reason
required
Reason
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" }}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}