CreditNote class

Describes the parameters that are part of a standard response

Available extensions

Constructors

CreditNote({String? entityUuid, EmployeeMetadata? metadata, ApprovalMetadata? approvalMetadata, STANDARD_LIFECYCLE_STATUS? status, Iterable<LogbookLogConciseSLC>? logs, Int64? completedOn, Int64? vaultFolderId, String? referenceId, String? finalRefNumber, CREDIT_NOTE_REF_FROM? refFrom, Int64? refId, Int64? currencyId, Int64? bankAccountId, Int64? miscellaneousCost, Int64? overallDiscount, Int64? roundOff, double? totalValue, Iterable<CreditNoteItem>? list, Iterable<FormFieldDatum>? formData})
factory
CreditNote.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
CreditNote.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

approvalMetadata ↔ ApprovalMetadata
Stores the approval metadata
getter/setter pair
bankAccountId ↔ Int64
The associated ID of the bank account
getter/setter pair
completedOn ↔ Int64
The timestamp of when this credit note was marked as completed
getter/setter pair
currencyId ↔ Int64
The associated ID of the currency
getter/setter pair
entityUuid ↔ String
Stores a globally unique entity UUID. This will be set at the organization level
getter/setter pair
finalRefNumber ↔ String
The unique reference number that has been automatically generated
getter/setter pair
formData → PbList<FormFieldDatum>
The list of dynamic forms
no setter
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
list → PbList<CreditNoteItem>
The list of associated credit note items
no setter
logs → PbList<LogbookLogConciseSLC>
Stores the logs of every operation performed on this credit note
no setter
metadata ↔ EmployeeMetadata
Stores the metadata of this credit note
getter/setter pair
miscellaneousCost ↔ Int64
Any miscellaneous cost
getter/setter pair
overallDiscount ↔ Int64
The optional discount amount
getter/setter pair
referenceId ↔ String
The reference ID of the credit note
getter/setter pair
refFrom ↔ CREDIT_NOTE_REF_FROM
The associated reference
getter/setter pair
refId ↔ Int64
The associated ID of the reference
getter/setter pair
roundOff ↔ Int64
The applicable round off amount (optional, and can be positive or negative)
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ STANDARD_LIFECYCLE_STATUS
The status of this credit note
getter/setter pair
totalValue ↔ double
Stores the total value of the credit note (as a double, which requires no adjustments)
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vaultFolderId ↔ Int64
The associated vault folder ID
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearApprovalMetadata() → void
clearBankAccountId() → void
clearCompletedOn() → void
clearCurrencyId() → void
clearEntityUuid() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearFinalRefNumber() → void
clearMetadata() → void
clearMiscellaneousCost() → void
clearOverallDiscount() → void
clearReferenceId() → void
clearRefFrom() → void
clearRefId() → void
clearRoundOff() → void
clearStatus() → void
clearTotalValue() → void
clearVaultFolderId() → void
clone() → CreditNote
Creates a deep copy of the fields in this message.
copyWith(void updates(CreditNote)) → CreditNote
Apply updates to a copy of this message.
createEmptyInstance() → CreditNote
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureApprovalMetadata() → ApprovalMetadata
ensureMetadata() → EmployeeMetadata
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasApprovalMetadata() → bool
hasBankAccountId() → bool
hasCompletedOn() → bool
hasCurrencyId() → bool
hasEntityUuid() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasFinalRefNumber() → bool
hasMetadata() → bool
hasMiscellaneousCost() → bool
hasOverallDiscount() → bool
hasReferenceId() → bool
hasRefFrom() → bool
hasRefId() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRoundOff() → bool
hasStatus() → bool
hasTotalValue() → bool
hasVaultFolderId() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → CreditNote
getDefault() → CreditNote