CreditNotesResource class

The credit notes endpoints with client already applied.

Constructors

CreditNotesResource(ExsitedClient client)

Bind the resource to a client; normally reached via client.creditNotes.

const

Properties

client → ExsitedClient

The client every call below is made through.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

applyCreditNote(Object creditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/credit_notes/{credit_note_id}/apply

createCreditNote(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/credit_notes

createCreditNoteNote(Object creditNoteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/credit_notes/{credit_note_id}/notes

deleteCreditNote(Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/credit_notes/{credit_note_id}

deleteCreditNoteNote(Object creditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}

getCreditNote(Object creditNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteRead>>

GET /api/{api_version}/credit_notes/{credit_note_id}

getCreditNoteCreditNoteApplications(Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteApplications>>

GET /api/{api_version}/credit_notes/{credit_note_id}/credit_note_applications

getCreditNoteItems(Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteItems>>

GET /api/{api_version}/credit_notes/{credit_note_id}/items

getCreditNoteNote(Object creditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteNote>>

GET /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}

getCreditNoteNoteFile(Object creditNoteId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}/files/{file_id}

getCreditNoteNoteFiles(Object creditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}/files

getCreditNoteNotes(Object creditNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteNoteList>>

GET /api/{api_version}/credit_notes/{credit_note_id}/notes

getCreditNotes({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteList>>

GET /api/{api_version}/credit_notes

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateCreditNote(Object creditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteUpdated>>

PATCH /api/{api_version}/credit_notes/{credit_note_id}

Operators

operator ==(Object other) → bool

The equality operator.

inherited