InvoiceDto class

Constructors

InvoiceDto({required String id, String? rev, int? created, int? modified, String? author, String? responsible, String? medicalLocationId, Set<CodeStubDto> tags = const {}, Set<CodeStubDto> codes = const {}, int? endOfLife, int? deletionDate, int? invoiceDate, int? sentDate, int? printedDate, List<InvoicingCodeDto> invoicingCodes = const [], Map<String, String> receipts = const {}, String? recipientType, String? recipientId, String? invoiceReference, String? thirdPartyReference, String? thirdPartyPaymentJustification, String? thirdPartyPaymentReason, String? reason, InvoiceDtoInvoiceTypeEnum? invoiceType, InvoiceDtoSentMediumTypeEnum? sentMediumType, InvoiceDtoInterventionTypeEnum? interventionType, String? groupId, InvoiceDtoPaymentTypeEnum? paymentType, double? paid, List<PaymentDto> payments = const [], String? gnotionNihii, String? gnotionSsin, String? gnotionLastName, String? gnotionFirstName, String? gnotionCdHcParty, int? invoicePeriod, String? careProviderType, String? internshipNihii, String? internshipSsin, String? internshipLastName, String? internshipFirstName, String? internshipCdHcParty, String? internshipCbe, String? supervisorNihii, String? supervisorSsin, String? supervisorLastName, String? supervisorFirstName, String? supervisorCdHcParty, String? supervisorCbe, String? error, String? encounterLocationName, String? encounterLocationNihii, int? encounterLocationNorm, int? longDelayJustification, String? correctiveInvoiceId, String? correctedInvoiceId, bool? creditNote, String? creditNoteRelatedInvoiceId, IdentityDocumentReaderDto? idDocument, String? cancelReason, int? cancelDate, Map<String, String> options = const {}, Set<String> secretForeignKeys = const {}, Map<String, Set<DelegationDto>> cryptedForeignKeys = const {}, Map<String, Set<DelegationDto>> delegations = const {}, Map<String, Set<DelegationDto>> encryptionKeys = const {}, String? encryptedSelf})

Returns a new InvoiceDto instance.

Properties

author ↔ String?

The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

cancelDate ↔ int?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

cancelReason ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

careProviderType ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

codes ↔ Set<CodeStubDto>

A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes

getter/setter pair

correctedInvoiceId ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

correctiveInvoiceId ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

created ↔ int?

The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

creditNote ↔ bool?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

creditNoteRelatedInvoiceId ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

cryptedForeignKeys ↔ Map<String, Set<DelegationDto>>

The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.

getter/setter pair

delegations ↔ Map<String, Set<DelegationDto>>

When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well

getter/setter pair

deletionDate ↔ int?

hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.

getter/setter pair

encounterLocationName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

encounterLocationNihii ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

encounterLocationNorm ↔ int?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

encryptedSelf ↔ String?

The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.

getter/setter pair

encryptionKeys ↔ Map<String, Set<DelegationDto>>

When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation

getter/setter pair

endOfLife ↔ int?

Soft delete (unix epoch in ms) timestamp of the object.

getter/setter pair

error ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

gnotionCdHcParty ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

gnotionFirstName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

gnotionLastName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

gnotionNihii ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

gnotionSsin ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

groupId ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

id ↔ String

The Id of the Invoice. We encourage using either a v4 UUID or a HL7 Id.

getter/setter pair

idDocument ↔ IdentityDocumentReaderDto?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipCbe ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipCdHcParty ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipFirstName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipLastName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipNihii ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

internshipSsin ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

interventionType ↔ InvoiceDtoInterventionTypeEnum?

getter/setter pair

invoiceDate ↔ int?

The timestamp (unix epoch in ms) when the invoice was drafted, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

invoicePeriod ↔ int?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

invoiceReference ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

invoiceType ↔ InvoiceDtoInvoiceTypeEnum?

The format the invoice should follow based on the recipient which could be a patient, mutual fund or paying agency such as the CPAS

getter/setter pair

invoicingCodes ↔ List<InvoicingCodeDto>

getter/setter pair

longDelayJustification ↔ int?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

medicalLocationId ↔ String?

The id of the medical location where this entity was created.

getter/setter pair

modified ↔ int?

The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

options ↔ Map<String, String>

getter/setter pair

paid ↔ double?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

payments ↔ List<PaymentDto>

getter/setter pair

paymentType ↔ InvoiceDtoPaymentTypeEnum?

Type of payment, ex: cash, wired, insurance, debit card, etc.

getter/setter pair

printedDate ↔ int?

The timestamp (unix epoch in ms) when the invoice is printed, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

reason ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

receipts ↔ Map<String, String>

getter/setter pair

recipientId ↔ String?

Id of the recipient of the invoice. For healthcare party and insurance, patient link happens through secretForeignKeys

getter/setter pair

recipientType ↔ String?

The type of user that receives the invoice, a patient or a healthcare party

getter/setter pair

responsible ↔ String?

The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

rev ↔ String?

The revision of the invoice in the database, used for conflict management / optimistic locking.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secretForeignKeys ↔ Set<String>

The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.

getter/setter pair

sentDate ↔ int?

The timestamp (unix epoch in ms) when the invoice was sent, will be filled automatically if missing. Not enforced by the application server.

getter/setter pair

sentMediumType ↔ InvoiceDtoSentMediumTypeEnum?

Medium of the invoice: CD ROM, Email, paper, etc.

getter/setter pair

supervisorCbe ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

supervisorCdHcParty ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

supervisorFirstName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

supervisorLastName ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

supervisorNihii ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

supervisorSsin ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

tags ↔ Set<CodeStubDto>

A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.

getter/setter pair

thirdPartyPaymentJustification ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

thirdPartyPaymentReason ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

thirdPartyReference ↔ String?

Please note: This property should have been non-nullable! Since the specification file does not include a default value (using the "default:" property), however, the generated source code must fall back to having a nullable type. Consider adding a "default:" property in the specification file to hide this note.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → InvoiceDto?

Returns a new InvoiceDto instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<InvoiceDto>?

mapFromJson(dynamic json) → Map<String, InvoiceDto>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<InvoiceDto>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.