credit_notes library

The v4 credit notes family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/credit_notes.dart' as credit_notes;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

CreditNote: The credit note body.
CreditNoteAccount: A CreditNote's account.
CreditNoteApplications: A credit note's applications, under credit_note.
CreditNoteCurrency: A CreditNote's currency.
CreditNoteCustomAttribute: One entry of a CreditNote's custom_attributes.
CreditNoteInvoice: One entry of a CreditNote's invoices.
CreditNoteItem: One entry of a CreditNoteItems's items: what was credited and refunded, by source, each amount a string.
CreditNoteItems: A credit note's balance rows, under credit_note.
CreditNoteLastUpdatedBy: A CreditNote's last_updated_by.
CreditNoteList: A page of CreditNote records.
CreditNoteNote: One note on a credit note, under note.
CreditNoteNoteCreatedBy: A CreditNoteNote's created_by.
CreditNoteNoteDetail: A CreditNoteNote's credit_note.
CreditNoteNoteList: One page of CreditNoteNote records, under data.
CreditNotePayment: A CreditNote's payment.
CreditNoteRead: The credit note read body.
CreditNoteReadAccount: A CreditNoteRead's account.
CreditNoteReadCreatedBy: A CreditNoteRead's created_by.
CreditNoteReadCurrency: A CreditNoteRead's currency.
CreditNoteReadCustomAttribute: One entry of a CreditNoteRead's custom_attributes.
CreditNoteReadInvoice: One entry of a CreditNoteRead's invoices.
CreditNoteReadLastUpdatedBy: A CreditNoteRead's last_updated_by.
CreditNoteReadPayment: A CreditNoteRead's payment.
CreditNotesResource: The credit notes endpoints with client already applied.
CreditNotesUrls
CreditNoteUpdated: What updateCreditNote answers, under credit_note.

Functions

applyCreditNote(ExsitedClient client, Object creditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/credit_notes/{credit_note_id}/apply
createCreditNote(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/credit_notes
createCreditNoteNote(ExsitedClient client, 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(ExsitedClient client, Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/credit_notes/{credit_note_id}
deleteCreditNoteNote(ExsitedClient client, Object creditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}
getCreditNote(ExsitedClient client, Object creditNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteRead>>: GET /api/{api_version}/credit_notes/{credit_note_id}
getCreditNoteCreditNoteApplications(ExsitedClient client, Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteApplications>>: GET /api/{api_version}/credit_notes/{credit_note_id}/credit_note_applications
getCreditNoteItems(ExsitedClient client, Object creditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteItems>>: GET /api/{api_version}/credit_notes/{credit_note_id}/items
getCreditNoteNote(ExsitedClient client, Object creditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteNote>>: GET /api/{api_version}/credit_notes/{credit_note_id}/notes/{note_id}
getCreditNoteNoteFile(ExsitedClient client, 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(ExsitedClient client, 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(ExsitedClient client, Object creditNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteNoteList>>: GET /api/{api_version}/credit_notes/{credit_note_id}/notes
getCreditNotes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteList>>: GET /api/{api_version}/credit_notes
updateCreditNote(ExsitedClient client, Object creditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteUpdated>>: PATCH /api/{api_version}/credit_notes/{credit_note_id}

credit_notes library

Classes

Functions

exsited package

credit_notes library