Struct DocumentHeader 

pub struct DocumentHeader {

    pub document_id: String,
    pub document_type: DocumentType,
    pub company_code: String,
    pub fiscal_year: u16,
    pub fiscal_period: u8,
    pub document_date: NaiveDate,
    pub posting_date: Option<NaiveDate>,
    pub entry_date: NaiveDate,
    pub entry_timestamp: NaiveDateTime,
    pub status: DocumentStatus,
    pub created_by: String,
    pub changed_by: Option<String>,
    pub changed_at: Option<NaiveDateTime>,
    pub currency: String,
    pub reference: Option<String>,
    pub header_text: Option<String>,
    pub journal_entry_id: Option<String>,
    pub document_references: Vec<DocumentReference>,
}

Common document header fields.

Fields

document_id: String

Unique document ID

document_type: DocumentType

Document type

company_code: String

Company code

fiscal_year: u16

Fiscal year

fiscal_period: u8

Fiscal period

document_date: NaiveDate

Document date

posting_date: Option<NaiveDate>

Posting date (if applicable)

entry_date: NaiveDate

Entry date (when document was created)

entry_timestamp: NaiveDateTime

Entry timestamp

status: DocumentStatus

Document status

created_by: String

Created by user

changed_by: Option<String>

Last changed by user

changed_at: Option<NaiveDateTime>

Last change timestamp

currency: String

Currency

reference: Option<String>

Reference number (external)

header_text: Option<String>

Header text

journal_entry_id: Option<String>

Related journal entry ID (if posted to GL)

document_references: Vec<DocumentReference>

References to other documents

Implementations

impl DocumentHeader

pub fn new( document_id: impl Into<String>, document_type: DocumentType, company_code: impl Into<String>, fiscal_year: u16, fiscal_period: u8, document_date: NaiveDate, created_by: impl Into<String>, ) -> Self

Create a new document header.

pub fn with_posting_date(self, date: NaiveDate) -> Self

Set posting date.

pub fn with_currency(self, currency: impl Into<String>) -> Self

Set currency.

pub fn with_reference(self, reference: impl Into<String>) -> Self

Set reference.

pub fn with_header_text(self, text: impl Into<String>) -> Self

Set header text.

pub fn add_reference(&mut self, reference: DocumentReference)

Add a document reference.

pub fn update_status( &mut self, new_status: DocumentStatus, user: impl Into<String>, )

Update status and record change.

pub fn generate_id( doc_type: DocumentType, company_code: &str, sequence: u64, ) -> String

Generate a deterministic document ID.

Trait Implementations

impl Clone for DocumentHeader

fn clone(&self) -> DocumentHeader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.