purchase_credit_notes library

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

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

Classes

PurchaseCreditNote
The purchase credit note body.
PurchaseCreditNoteAccount
A PurchaseCreditNote's account.
PurchaseCreditNoteCreated
What createPurchaseCreditNote answers, under purchase_credit_note: a shorter body than the reads, and status an object where they send a string.
PurchaseCreditNoteCreatedStatus
A PurchaseCreditNoteCreated's status.
PurchaseCreditNoteCurrency
A PurchaseCreditNote's currency.
PurchaseCreditNoteList
A page of PurchaseCreditNote records.
PurchaseCreditNotePurchaseCreditNoteRow
One entry of a PurchaseCreditNote's purchase_credit_note_rows.
PurchaseCreditNotePurchaseCreditNoteRowPaymentMethod
A PurchaseCreditNotePurchaseCreditNoteRow's payment_method.
PurchaseCreditNotePurchaseCreditNoteRowPaymentProcessor
A PurchaseCreditNotePurchaseCreditNoteRow's payment_processor.
PurchaseCreditNotePurchasePayment
A PurchaseCreditNote's purchase_payment.
PurchaseCreditNoteRead
The purchase credit note read body.
PurchaseCreditNoteReadAccount
A PurchaseCreditNoteRead's account.
PurchaseCreditNoteReadCreatedBy
A PurchaseCreditNoteRead's created_by.
PurchaseCreditNoteReadCurrency
A PurchaseCreditNoteRead's currency.
PurchaseCreditNoteReadLastUpdatedBy
A PurchaseCreditNoteRead's last_updated_by.
PurchaseCreditNoteReadPurchaseCreditNoteRow
One entry of a PurchaseCreditNoteRead's purchase_credit_note_rows.
PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentMethod
A PurchaseCreditNoteReadPurchaseCreditNoteRow's payment_method.
PurchaseCreditNoteReadPurchaseCreditNoteRowPaymentProcessor
A PurchaseCreditNoteReadPurchaseCreditNoteRow's payment_processor.
PurchaseCreditNoteReadPurchasePayment
A PurchaseCreditNoteRead's purchase_payment.
PurchaseCreditNotesResource
The purchase credit notes endpoints with client already applied.
PurchaseCreditNotesUrls
PurchaseCreditNoteUpdated
What updatePurchaseCreditNote answers, under purchase_credit_note.
PurchaseCreditNoteUpdatedStatus
A PurchaseCreditNoteUpdated's status.

Functions

applyPurchaseCreditNote(ExsitedClient client, Object purchaseCreditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteCreated>>
POST /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}/apply
createPurchaseCreditNote(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteCreated>>
POST /api/{api_version}/purchase_credit_notes
createPurchaseCreditNoteNote(ExsitedClient client, Object purchaseCreditNoteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
POST /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}/notes
deletePurchaseCreditNote(ExsitedClient client, Object purchaseCreditNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}
deletePurchaseCreditNoteNote(ExsitedClient client, Object purchaseCreditNoteId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}/notes/{note_id}
getPurchaseCreditNote(ExsitedClient client, Object purchaseCreditNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteRead>>
GET /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}
getPurchaseCreditNotes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteList>>
GET /api/{api_version}/purchase_credit_notes
updatePurchaseCreditNote(ExsitedClient client, Object purchaseCreditNoteId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteUpdated>>
PATCH /api/{api_version}/purchase_credit_notes/{purchase_credit_note_id}