Remittance Invoice Object


A remittance invoice is the daily record of how much of a merchant's sales goes towards repaying a cash advance agreement. One invoice is calculated at the beginning of each day, covering the previous day's sales in the agreement's timezone.

A remittance invoice records an amount that's due to be collected, not money that has already moved. When the funds are collected, the invoice is linked to a financial operation and financialOperationId is populated.

Properties
accountIdstringimmutableformat GUID

Wix Payments account ID.


amountMoneyimmutable

Amount due to be collected as a remittance for the sales day.

Never negative. Equal to the sum of cashAdvanceAmountPortion and cashAdvanceFeePortion.


cashAdvanceAgreementIdstringimmutableformat GUID

ID of the cash advance agreement the remittance invoice belongs to.


cashAdvanceAmountPortionMoneyimmutable

Portion of amount applied to the principal advanced under the agreement.

For example, a 100 USD remittance may cover 80 USD of the advanced amount and 20 USD of the fee.


cashAdvanceFeePortionMoneyimmutable

Portion of amount applied to the agreement's fee.


createdDatestringRead-onlyimmutableformat date-time

Date and time the remittance invoice was created.


financialOperationIdstringformat GUID

ID of the financial operation that collected the remittance.

Populated when the remittance is collected. A remittance invoice with no financialOperationId has been calculated but not yet collected.


idstringformat GUIDimmutable

Remittance invoice ID.


lastbooleanimmutable

Whether this is the last remittance invoice for the cash advance agreement.

This indicates that no further invoices are issued for the agreement. It doesn't indicate whether the remittance has been collected.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the remittance invoice is updated.


salesAmountMoneyimmutable

Total sales for the sales day that the remittance was calculated from.


salesCountintegerformat int32

Number of sales included in the remittance.


salesDaystringimmutableformat LOCAL_DATE

Sales day the remittance covers, in the cash advance agreement's timezone.

Date in YYYY-MM-DD format.


salesEndDatestringimmutableformat date-time

Date and time the sales day ended.


salesStartDatestringimmutableformat date-time

Date and time the sales day started.


sandboxbooleanRead-onlyimmutable

Whether the remittance invoice was created in a test environment.


siteIdstringimmutableformat GUID

ID of the site the cash advance agreement belongs to.


tenantIdstringRead-onlyimmutableformat GUID

Internal identifier. Not required for third-party integrations.


updatedDatestringRead-onlyformat date-time

Date and time the remittance invoice was updated.

Did this help?