Received invoices

[Internal] Update invoice details

patch/api/received-invoices/{aggregate_id}/details

Request

  • Base URL: https://api.typless.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.typless.com/api/received-invoices/{aggregate_id}/details
  • Auth: none declared

Path parameters

aggregate_idstring uuid required

Request body

notesstring nullable

Response

Successful Response

aggregate_idstring uuid required
created_atstring date-time required
updated_atstring date-time required
filestring uri required
adjusted_filestring uri nullable required
status'CREATED' | 'EXTRACTION_IN_PROGRESS' | 'EXTRACTION_FINISHED' | 'EXTRACTION_FAILED' | 'WAITING_REVIEW' | 'IN_REVIEW' | 'CONFIRMED' | 'WAITING_EXPORT' | 'IN_EXPORT' | 'REJECTED' | 'EXPORTED' | 'EXPORT_ERROR' | 'MERGED' required
approval_status'NOT_REQUIRED' | 'PENDING_EVALUATION' | 'WAITING_APPROVAL' | 'APPROVED' | 'REJECTED'

The approval axis, orthogonal to DocumentStatus.

business_unit_idstring uuid required
modified_bystring nullable required
recognition_typestring nullable required
is_proformaboolean nullable required
document_type_namestring nullable required
extraction_failedboolean nullable required
processed_bystring nullable required
document_type_idstring uuid nullable required
file_namestring required
notesstring nullable required
ever_confirmedboolean required
locked_bystring uuid nullable required
locked_untilstring date-time nullable required
payment_status'NOT_APPLICABLE' | 'UNPAID' | 'SCHEDULED' | 'PARTIALLY_PAID' | 'PAID' | 'OVERPAID'
file_sizeinteger nullable
page_countinteger nullable
original_file_sizeinteger nullable
original_file_typestring nullable
checksumstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.