InternalInternal use only. Please use the Mozaic object to utilize this object.
The starting date of the accounting period of the payment cycle
The ending date of the accounting period of the payment cycle
ReadonlyamountThe total amount of money that will be paid out by the payment cycle.
A fee direction indicating who will pay the fees on a transaction.
default = Use the setting defined in the paying user's account settings
payer = The paying user also pays the fees
payee = The receiving user pays the fees
split = The payer and the receiver will split the fees equally
ReadonlyfeesThe total amount of fees that will be paid on the payment cycle.
The ID of the invoice. This will only be present after the payment cycle has been finalized.
The payer can specify a free-text string to help describe the reason for the payment
The name of the payment cycle
ReadonlypaymentThe number of payment cycle entries attached to the payment cycle.
ReadonlypaymentThe long ID of the payment cycle. This can be used to retrieve a payment cycle.
The underlying raw object returned from the API
ReadonlyshortThe short ID of the payment cycle. Use this for a human readable version of the Payment Cycle ID. This can also be used to retrieve a payment cycle.
ReadonlystatusThe current status of the payment cycle.
Adds a payment cycle entry to the current payment cycle. The payment cycle entry pays the given user the specified amount.
The first and last name of the user to pay.
The email address of the user to pay. If the user has not already joined Mozaic, they will be sent an email invite to join.
The amount of money to be paid to the user.
The currency that the amount will be paid in. Foreign exchange rates may apply to cross-boarder payments.
ProtectedexecuteCompletes the payment cycle by withdrawing money from your specified wallet item and then distributing it to recipients on the payment cycle.
The source of funding for the payment cycle. This must be a Payment wallet item and not a Payout wallet item.
Retrieves an invoice for this payment cycle. Note that an invoice is not generated for a payment cycle until it has been finalized.
an ArrayBuffer containing the bytes of an Invoice PDF. It can be saved using:
fs.writeFileSync(fileName, Buffer.from(arrayBuffer));
Gets payment cycle entries for the payment cycle. Use limit and page to page through the results for large data sets.
The number of records in a page from 1 - 100
The number of the page, starts at 1
ProtectedthrowProtectedthrowA helper function that will either return the variable's value or throw an exception if the value is null or undefined. Unit testing is simplified by avoiding ??
The name of the variable being checked
The value of the variable being checked
The value of the variable if it is available, otherwise an exception is thrown.
A payment cycle