purchase_payments library

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

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

Classes

AccountPurchasePayments
The account purchase payments body.
AccountPurchasePaymentsData
One entry of a AccountPurchasePayments's data.
AccountPurchasePaymentsDataAccount
A AccountPurchasePaymentsData's account.
AccountPurchasePaymentsDataCreatedBy
A AccountPurchasePaymentsData's created_by.
AccountPurchasePaymentsDataCreditNoteApplication
One entry of a AccountPurchasePaymentsData's credit_note_applications.
AccountPurchasePaymentsDataCreditNoteApplicationPurchaseCreditNote
A AccountPurchasePaymentsDataCreditNoteApplication's purchase_credit_note.
AccountPurchasePaymentsDataCurrency
A AccountPurchasePaymentsData's currency.
AccountPurchasePaymentsDataLastUpdatedBy
A AccountPurchasePaymentsData's last_updated_by.
AccountPurchasePaymentsDataPaymentMethodApplication
One entry of a AccountPurchasePaymentsData's payment_method_applications.
AccountPurchasePaymentsDataPaymentMethodApplicationPaymentMethod
A AccountPurchasePaymentsDataPaymentMethodApplication's payment_method.
AccountPurchasePaymentsDataPaymentMethodApplicationPaymentProcessor
A AccountPurchasePaymentsDataPaymentMethodApplication's payment_processor.
AccountPurchasePaymentsDataPurchaseInvoiceApplication
One entry of a AccountPurchasePaymentsData's purchase_invoice_applications.
AccountPurchasePaymentsDataPurchaseInvoiceApplicationPurchaseInvoice
A AccountPurchasePaymentsDataPurchaseInvoiceApplication's purchase_invoice.
PurchasePayment
The purchase payment body.
PurchasePaymentAccount
A PurchasePayment's account.
PurchasePaymentCreditNoteApplication
One entry of a PurchasePayment's credit_note_applications.
PurchasePaymentCreditNoteApplicationPurchaseCreditNote
A PurchasePaymentCreditNoteApplication's purchase_credit_note.
PurchasePaymentCurrency
A PurchasePayment's currency.
PurchasePaymentList
A page of PurchasePayment records.
PurchasePaymentNote
The purchase payment note body.
PurchasePaymentNoteAttachment
One entry of a PurchasePaymentNote's attachments.
PurchasePaymentNoteCreatedBy
A PurchasePaymentNote's created_by.
PurchasePaymentNoteFile
What getPurchasePaymentNoteFile answers, under file.
PurchasePaymentNoteFileEntry
One entry of a PurchasePaymentNoteFileList's data.
PurchasePaymentNoteFileList
One page of what getPurchasePaymentNoteFiles lists, under data.
PurchasePaymentNoteList
A page of PurchasePaymentNote records.
PurchasePaymentNotePurchasePayment
A PurchasePaymentNote's purchase_payment.
PurchasePaymentNoteRead
The purchase payment note read body.
PurchasePaymentNotes
The purchase payment notes body.
PurchasePaymentNotesAttachment
One entry of a PurchasePaymentNotes's attachments.
PurchasePaymentNotesCreatedBy
A PurchasePaymentNotes's created_by.
PurchasePaymentNotesPurchasePayment
A PurchasePaymentNotes's purchase_payment.
PurchasePaymentNotesWatcher
One entry of a PurchasePaymentNotes's watchers.
PurchasePaymentNoteUpdated
What updatePurchasePaymentNote answers, under note.
PurchasePaymentNoteUpdatedAttachment
One entry of a PurchasePaymentNoteUpdated's attachments.
PurchasePaymentNoteUpdatedPurchasePayment
A PurchasePaymentNoteUpdated's purchase_payment.
PurchasePaymentNoteUpdatedUser
A PurchasePaymentNoteUpdated's created_by and last_updated_by.
PurchasePaymentNoteView
What getPurchasePaymentNote answers, under note.
PurchasePaymentNoteViewAttachment
One entry of a PurchasePaymentNoteView's attachments.
PurchasePaymentNoteViewCreatedBy
A PurchasePaymentNoteView's created_by.
PurchasePaymentNoteViewPurchasePayment
A PurchasePaymentNoteView's purchase_payment.
PurchasePaymentNoteViewWatcher
One entry of a PurchasePaymentNoteView's watchers.
PurchasePaymentNoteWatcher
One entry of a PurchasePaymentNote's watchers.
PurchasePaymentPaymentMethodApplication
One entry of a PurchasePayment's payment_method_applications.
PurchasePaymentPaymentMethodApplicationPaymentMethod
A PurchasePaymentPaymentMethodApplication's payment_method.
PurchasePaymentPaymentMethodApplicationPaymentProcessor
A PurchasePaymentPaymentMethodApplication's payment_processor.
PurchasePaymentPurchaseInvoiceApplication
One entry of a PurchasePayment's purchase_invoice_applications.
PurchasePaymentPurchaseInvoiceApplicationPurchaseInvoice
A PurchasePaymentPurchaseInvoiceApplication's purchase_invoice.
PurchasePaymentRead
The purchase payment read body.
PurchasePaymentReadAccount
A PurchasePaymentRead's account.
PurchasePaymentReadCreatedBy
A PurchasePaymentRead's created_by.
PurchasePaymentReadCreditNoteApplication
One entry of a PurchasePaymentRead's credit_note_applications.
PurchasePaymentReadCreditNoteApplicationPurchaseCreditNote
A PurchasePaymentReadCreditNoteApplication's purchase_credit_note.
PurchasePaymentReadCurrency
A PurchasePaymentRead's currency.
PurchasePaymentReadLastUpdatedBy
A PurchasePaymentRead's last_updated_by.
PurchasePaymentReadPaymentMethodApplication
One entry of a PurchasePaymentRead's payment_method_applications.
PurchasePaymentReadPaymentMethodApplicationPaymentMethod
A PurchasePaymentReadPaymentMethodApplication's payment_method.
PurchasePaymentReadPaymentMethodApplicationPaymentProcessor
A PurchasePaymentReadPaymentMethodApplication's payment_processor.
PurchasePaymentReadPurchaseInvoiceApplication
One entry of a PurchasePaymentRead's purchase_invoice_applications.
PurchasePaymentReadPurchaseInvoiceApplicationPurchaseInvoice
A PurchasePaymentReadPurchaseInvoiceApplication's purchase_invoice.
PurchasePayments
The purchase payments body.
PurchasePaymentsAccount
A PurchasePayments's account.
PurchasePaymentsActivityLog
One entry of a PurchasePayments's activity_logs.
PurchasePaymentsCreatedBy
A PurchasePayments's created_by.
PurchasePaymentsCreditNoteApplication
One entry of a PurchasePayments's credit_note_applications.
PurchasePaymentsCreditNoteApplicationPurchaseCreditNote
A PurchasePaymentsCreditNoteApplication's purchase_credit_note.
PurchasePaymentsCurrency
A PurchasePayments's currency.
PurchasePaymentsPaymentMethodApplication
One entry of a PurchasePayments's payment_method_applications.
PurchasePaymentsPaymentMethodApplicationPaymentMethod
A PurchasePaymentsPaymentMethodApplication's payment_method.
PurchasePaymentsPaymentMethodApplicationPaymentProcessor
A PurchasePaymentsPaymentMethodApplication's payment_processor.
PurchasePaymentsPurchaseInvoiceApplication
One entry of a PurchasePayments's purchase_invoice_applications.
PurchasePaymentsPurchaseInvoiceApplicationPurchaseInvoice
A PurchasePaymentsPurchaseInvoiceApplication's purchase_invoice.
PurchasePaymentsResource
The purchase payments endpoints with client already applied.
PurchasePaymentsUrls
PurchasePaymentUpdated
The purchase payment updated body.
PurchasePaymentUpdatedAccount
A PurchasePaymentUpdated's account.
PurchasePaymentUpdatedCreatedBy
A PurchasePaymentUpdated's created_by.
PurchasePaymentUpdatedCurrency
A PurchasePaymentUpdated's currency.
PurchasePaymentUpdatedLastUpdatedBy
A PurchasePaymentUpdated's last_updated_by.
PurchasePaymentUpdatedPaymentMethodApplication
One entry of a PurchasePaymentUpdated's payment_method_applications.
PurchasePaymentUpdatedPaymentMethodApplicationPaymentMethod
A PurchasePaymentUpdatedPaymentMethodApplication's payment_method.
PurchasePaymentUpdatedPaymentMethodApplicationPaymentProcessor
A PurchasePaymentUpdatedPaymentMethodApplication's payment_processor.
PurchasePaymentUpdatedPurchaseInvoiceApplication
One entry of a PurchasePaymentUpdated's purchase_invoice_applications.
PurchasePaymentUpdatedPurchaseInvoiceApplicationPurchaseInvoice
A PurchasePaymentUpdatedPurchaseInvoiceApplication's purchase_invoice.

Functions

createPurchaseInvoicePurchasePayment(ExsitedClient client, Object purchaseInvoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePayments>>
POST /api/{api_version}/purchase_invoices/{purchase_invoice_id}/purchase_payments
createPurchasePayment(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePayments>>
POST /api/{api_version}/purchase_payments
createPurchasePaymentNote(ExsitedClient client, Object purchasePaymentId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNotes>>
POST /api/{api_version}/purchase_payments/{purchase_payment_id}/notes
deletePurchasePayment(ExsitedClient client, Object purchasePaymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/purchase_payments/{purchase_payment_id}
deletePurchasePaymentNote(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}
deletePurchasePaymentNoteFile(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}
getPurchasePayment(ExsitedClient client, Object purchasePaymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentRead>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}
getPurchasePaymentNote(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNoteView>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}
getPurchasePaymentNoteFile(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, Object fileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNoteFile>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files/{file_id}
getPurchasePaymentNoteFiles(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNoteFileList>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files
getPurchasePaymentNotes(ExsitedClient client, Object purchasePaymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNoteList>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}/notes
getPurchasePaymentPurchaseCreditNotes(ExsitedClient client, Object purchasePaymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseCreditNoteList>>
GET /api/{api_version}/purchase_payments/{purchase_payment_id}/purchase_credit_notes
getPurchasePayments(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentList>>
GET /api/{api_version}/purchase_payments
updatePurchasePayment(ExsitedClient client, Object purchasePaymentId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentUpdated>>
PATCH /api/{api_version}/purchase_payments/{purchase_payment_id}
updatePurchasePaymentNote(ExsitedClient client, Object purchasePaymentId, Object ppNoteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchasePaymentNoteUpdated>>
PATCH /api/{api_version}/purchase_payments/{purchase_payment_id}/notes/{pp_note_id}