Invoice class
Invoice Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Invoice({@Default(R5ResourceType.Invoice) @JsonKey(unknownEnumValue: R5ResourceType.Invoice) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, String? cancelledReason, @JsonKey(name: '_cancelledReason') Element? cancelledReasonElement, CodeableConcept? type, Reference? subject, Reference? recipient, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, FhirDateTime? creation, @JsonKey(name: '_creation') Element? creationElement, FhirDate? periodDate, @JsonKey(name: '_periodDate') Element? periodDateElement, Period? periodPeriod, List<InvoiceParticipant> ? participant, Reference? issuer, Reference? account, List<InvoiceLineItem> ? lineItem, List<MonetaryComponent> ? totalPriceComponent, Money? totalNet, Money? totalGross, FhirMarkdown? paymentTerms, @JsonKey(name: '_paymentTerms') Element? paymentTermsElement, List<Annotation> ? note}) -
Invoice Invoice containing collected ChargeItems from an Account with
calculated individual and total price for Billing purpose.
constfactory
-
Invoice.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Invoice.fromJsonString(String source)
-
Acts like a constructor, returns a Invoice, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Invoice.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- account → Reference?
-
account Account which is supposed to be balanced with this Invoice.
no setterinherited
- cancelledReason → String?
-
cancelledReason In case of Invoice cancellation a reason must be
given (entered in error, superseded by corrected invoice etc.).
no setterinherited
- cancelledReasonElement → Element?
-
cancelledReasonElement ("_cancelledReason") Extensions for
cancelledReason
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $InvoiceCopyWith<
Invoice> -
no setterinherited
- creation → FhirDateTime?
-
creation Date/time(s) of when this Invoice was posted.
no setterinherited
- creationElement → Element?
-
creationElement ("_creation") Extensions for creation
no setterinherited
- date → FhirDateTime?
-
date Depricared by the element below.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifier of this Invoice, often used for reference in
correspondence about this invoice or for tracking of payments.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- issuer → Reference?
-
issuer The organizationissuing the Invoice.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
-
lineItem
→ List<
InvoiceLineItem> ? -
lineItem Each line item represents one charge for goods and services
rendered. Details such.ofType(date), code and amount are found in the
referenced ChargeItem resource.
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
-
note
→ List<
Annotation> ? -
note Comments made about the invoice by the issuer, subject, or other
participants.
no setterinherited
-
participant
→ List<
InvoiceParticipant> ? -
participant Indicates who or what performed or participated in the
charged service.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- paymentTerms → FhirMarkdown?
-
paymentTerms Payment details such as banking details, period of
payment, deductibles, methods of payment.
no setterinherited
- paymentTermsElement → Element?
-
paymentTermsElement ("_paymentTerms") Extensions for paymentTerms
no setterinherited
- periodDate → FhirDate?
-
periodDate Date/time(s) range of services included in this invoice.
no setterinherited
- periodDateElement → Element?
-
periodDateElement ("_periodDate") Extensions for periodDate
no setterinherited
- periodPeriod → Period?
-
periodPeriod Date/time(s) range of services included in this invoice.
no setterinherited
- recipient → Reference?
-
recipient The individual or Organization responsible for balancing of
this invoice.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Invoice resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The current state of the Invoice.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subject → Reference?
-
subject The individual or set of individuals receiving the goods and
services billed in this invoice.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- totalGross → Money?
-
totalGross Invoice total, tax included.
no setterinherited
- totalNet → Money?
-
totalNet Invoice total , taxes excluded.
no setterinherited
-
totalPriceComponent
→ List<
MonetaryComponent> ? -
totalPriceComponent The total amount for the Invoice may be
calculated as the sum of the line items with surcharges/deductions
that apply in certain conditions. The priceComponent element can be
used to offer transparency to the recipient of the Invoice of how the
total price was calculated.
no setterinherited
- type → CodeableConcept?
-
type Type of Invoice depending on domain, realm an usage (e.g.
internal/external, dental, preliminary).
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited