payments library

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

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

Classes

AccountPayments: The account payments body.
AccountPaymentsData: One entry of a AccountPayments's data.
AccountPaymentsDataAccount: A AccountPaymentsData's account.
AccountPaymentsDataCreatedBy: A AccountPaymentsData's created_by.
AccountPaymentsDataCreditApplied: One entry of a AccountPaymentsData's credit_applied.
AccountPaymentsDataGiftCertificateApplied: One entry of a AccountPaymentsData's gift_certificate_applied.
AccountPaymentsDataInvoice: One entry of a AccountPaymentsData's invoices.
AccountPaymentsDataPaymentApplied: One entry of a AccountPaymentsData's payment_applied.
Payment: The payment body.
PaymentAccount: A Payment's account.
PaymentCreatedBy: A Payment's created_by.
PaymentCreditApplied: One entry of a Payment's credit_applied.
PaymentGiftCertificateApplied: One entry of a Payment's gift_certificate_applied.
PaymentInvoice: One entry of a Payment's invoices.
PaymentLastUpdatedBy: A Payment's last_updated_by.
PaymentList: A page of Payment records.
PaymentNote: The payment note body.
PaymentNoteAttachment: One entry of a PaymentNote's attachments.
PaymentNoteCreatedBy: A PaymentNote's created_by.
PaymentNoteFile: What getPaymentNoteFile answers, under file.
PaymentNoteList: A page of PaymentNote records.
PaymentNotePayment: A PaymentNote's payment.
PaymentNoteRead: The payment note read body.
PaymentNoteReadAttachment: One entry of a PaymentNoteRead's attachments.
PaymentNoteReadCreatedBy: A PaymentNoteRead's created_by.
PaymentNoteReadPayment: A PaymentNoteRead's payment.
PaymentNoteReadWatcher: One entry of a PaymentNoteRead's watchers.
PaymentNoteWatcher: One entry of a PaymentNote's watchers.
PaymentPaymentApplied: One entry of a Payment's payment_applied.
PaymentRead: The payment read body.
PaymentReadAccount: A PaymentRead's account.
PaymentReadCreatedBy: A PaymentRead's created_by.
PaymentReadCreditApplied: One entry of a PaymentRead's credit_applied.
PaymentReadCustomAttribute: One entry of a PaymentRead's custom_attributes.
PaymentReadGiftCertificateApplied: One entry of a PaymentRead's gift_certificate_applied.
PaymentReadInvoice: One entry of a PaymentRead's invoices.
PaymentReadLastUpdatedBy: A PaymentRead's last_updated_by.
PaymentReadPaymentApplied: One entry of a PaymentRead's payment_applied.
PaymentsNote: The payments note body.
PaymentsNoteAttachment: One entry of a PaymentsNote's attachments.
PaymentsNoteCreatedBy: A PaymentsNote's created_by.
PaymentsNoteList: A page of PaymentsNote records.
PaymentsNoteWatcher: One entry of a PaymentsNote's watchers.
PaymentsResource: The payments endpoints with client already applied.
PaymentsUrls

Functions

createPayment(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>: POST /api/{api_version}/payments
createPaymentNote(ExsitedClient client, Object paymentId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteRead>>: POST /api/{api_version}/payments/{payment_id}/notes
deletePayment(ExsitedClient client, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/payments/{payment_id}
deletePaymentNote(ExsitedClient client, Object paymentId, Object paymentNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}
getInvoicePayment(ExsitedClient client, Object invoiceId, Object paymentId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>: GET /api/{api_version}/invoices/{invoice_id}/payments/{payment_id}
getInvoicePayments(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>: GET /api/{api_version}/invoices/{invoice_id}/payments
getOrderPayments(ExsitedClient client, Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>: GET /api/{api_version}/orders/{order_id}/payments
getPayment(ExsitedClient client, Object paymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>: GET /api/{api_version}/payments/{payment_id}
getPaymentNote(ExsitedClient client, Object paymentId, Object paymentNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteRead>>: GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}
getPaymentNoteFile(ExsitedClient client, Object paymentId, Object paymentNoteId, Object paymentFileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteFile>>: GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}/files/{payment_file_id}
getPaymentNoteFiles(ExsitedClient client, Object paymentId, Object paymentNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteFileList>>: GET /api/{api_version}/payments/{payment_id}/notes/{payment_note_id}/files
getPaymentNotes(ExsitedClient client, Object paymentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentNoteList>>: GET /api/{api_version}/payments/{payment_id}/notes
getPayments(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentList>>: GET /api/{api_version}/payments
getPaymentsNotes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentsNoteList>>: GET /api/{api_version}/payments/notes
updatePayment(ExsitedClient client, Object paymentId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PaymentRead>>: PATCH /api/{api_version}/payments/{payment_id}

payments library

Classes

Functions

exsited package

payments library