quickbooks-api
Version:
A modular TypeScript SDK for seamless integration with Intuit QuickBooks APIs. Provides robust authentication handling and future-ready foundation for accounting, payments, and commerce operations.
210 lines (209 loc) • 6.92 kB
JavaScript
// Import the Types
import { ApiClient } from '../../packages/api/api-client.js';
import { QuickbooksError } from '../types.js';
/**
* Payment
*
* @description
* The Payment Object
*
* @see {@link https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment}
*/
export class Payment {
/**
* @description The API client used to make requests to the API to manage the Payment object
*/
apiClient;
// Setup the Readonly Properties
/**
* @description Unique identifier for this object
* @readonly @systemDefined
* @filterable
* @sortable
* @requiredForUpdate
*/
Id;
/**
* @description Version number for update tracking
* @readonly @systemDefined
* @requiredForUpdate
*/
SyncToken;
/**
* @description System-defined metadata. Read-only
*/
MetaData;
/**
* @description Total amount (read-only, system calculated)
* @readonly
* @filterable
* @sortable
*/
TotalAmt;
/**
* @description Unapplied amount (read-only)
* @readonly
*/
UnappliedAmt;
// Setup the Required Properties
/**
* @description Customer reference (required)
* @filterable
*/
CustomerRef;
/**
* @description Deposit to account reference (required)
*/
DepositToAccountRef;
/**
* @description Transaction line items (required)
* @required
*/
Line;
// Setup the Optional Properties
/**
* @description Transaction date (yyyy-MM-dd)
* @filterable
* @sortable
*/
TxnDate;
/**
* @description Process payment immediately
*/
ProcessPayment;
/**
* @description Project reference
* @filterable
*/
ProjectRef;
/**
* @description Domain of the data source
*/
domain;
/**
* @description Sparse update flag
*/
sparse;
/**
* @description Constructor for Payment
* @param apiClient - The API client
* @param paymentCreationData - The data for the payment
*/
constructor(apiClient, paymentCreationData) {
// Set the API Client
this.apiClient = apiClient;
// Initialize the System Defined Properties
this.Id = null;
this.SyncToken = null;
// Build the Required Properties
this.CustomerRef = paymentCreationData?.CustomerRef ?? null;
this.DepositToAccountRef = paymentCreationData?.DepositToAccountRef ?? null;
this.Line = paymentCreationData?.Line ?? [];
}
/**
* @description Set the API Client
* @param apiClient - The API client
*/
setApiClient(apiClient) {
this.apiClient = apiClient;
}
/**
* @description Reload the Payment Data
* @throws {QuickbooksError} If the Payment was not found
*/
async reload() {
// Get the Payment by ID
const result = await this.apiClient.payments.getPaymentById(this.Id);
// Check if the Payment was not Found
if (!result.payment)
throw new QuickbooksError('Payment not found', await ApiClient.getIntuitErrorDetails(null));
// Assign the Properties
Object.assign(this, result.payment);
}
/**
* @description Custom JSON serialization to exclude private properties
*/
toJSON() {
// Setup the Excluded Properties
const excludedProperties = ['apiClient'];
// Setup the JSON Object
const jsonData = { ...Object.fromEntries(Object.entries(this).filter(([key]) => !excludedProperties.includes(key))) };
// Return the JSON Object
return jsonData;
}
/**
* @description Updates or creates (if the Id is not set) the Payment
*/
async save() {
// Get the Payment URL
const url = await this.apiClient.payments.getUrl();
// Setup the Request Data
const requestData = {
method: 'POST',
body: JSON.stringify({ ...this.toJSON(), sparse: true }),
};
// Update the Payment
const { responseData } = await this.apiClient.runRequest(url.href, requestData);
// Extract the Payment from the response (QuickBooks returns { Payment: {...} } or wrapped format)
const paymentData = responseData?.Payment?.[0] || responseData?.Payment || responseData;
// Assign the Properties
Object.assign(this, paymentData);
}
/**
* @description Downloads the Payment as a PDF
* @returns {Promise<Blob>} The PDF file as a Blob
* @throws {QuickbooksError} If the Payment ID is not set or the download fails
*/
async downloadPDF() {
// Check if the Payment has an ID
if (!this.Id)
throw new QuickbooksError('Payment must be saved before downloading PDF', await ApiClient.getIntuitErrorDetails(null));
// Get the Payment URL and append /pdf
const url = await this.apiClient.payments.getUrl();
url.pathname = `${url.pathname}/${this.Id}/pdf`;
// Get the Token
const token = await this.apiClient.authProvider.getToken();
// Setup the Request Data for PDF
const requestData = {
method: 'GET',
headers: {
Accept: 'application/pdf',
Authorization: `Bearer ${token.accessToken}`,
},
};
// Download the PDF
const response = await fetch(url.href, requestData);
// Check if the Response has failed
if (!response.ok) {
const errorDetails = await ApiClient.getIntuitErrorDetails(response);
throw new QuickbooksError('Failed to download PDF', errorDetails);
}
// Return the PDF as a Blob
return await response.blob();
}
/**
* @description Voids the Payment
* @throws {QuickbooksError} If the Payment ID is not set or the void fails
*/
async void() {
// Check if the Payment has an ID
if (!this.Id)
throw new QuickbooksError('Payment must be saved before voiding', await ApiClient.getIntuitErrorDetails(null));
// Get the Payment URL and append operation=void
const url = await this.apiClient.payments.getUrl();
url.pathname = `${url.pathname}/${this.Id}`;
url.searchParams.set('operation', 'void');
// Setup the Request Data
const requestData = {
method: 'POST',
body: JSON.stringify({ ...this.toJSON(), sparse: true }),
};
// Void the Payment
const { responseData } = await this.apiClient.runRequest(url.href, requestData);
// Extract the Payment from the response
const paymentData = responseData?.Payment?.[0] || responseData?.Payment || responseData;
// Assign the Properties
if (paymentData)
Object.assign(this, paymentData);
}
}