Remittance Invoices: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Show a merchant their remittance history

A merchant wants to review how much of their sales has gone towards repaying their cash advance, day by day, and how much of each remittance was applied to the advanced amount rather than to the fee.

To show a merchant their remittance history:

1. Call Query Remittance Invoices with a filter on the merchant's cashAdvanceAgreementId, sorted by salesDay in descending order. For example:

   Copy

2. Display each returned invoice's salesDay, amount, and salesAmount.

3. Split each amount into cashAdvanceAmountPortion and cashAdvanceFeePortion, so the merchant can see how much of each remittance was applied to the principal and how much to the fee.

4. Retrieve the rest of the history by passing pagingMetadata.cursors.next from the response as query.cursorPaging.cursor in the next request.

Reconcile a collection with the remittances it covers

A merchant sees a single collection on their statement and wants to know which sales days it accounts for. A financial operation can cover several remittance invoices, so reconciling means retrieving every invoice linked to it.

To reconcile a collection with the remittances it covers:

1. Call Get Remittance Invoice for an invoice you already know is part of the collection, and read its financialOperationId. An invoice with no financialOperationId hasn't been collected yet.

2. Call Query Remittance Invoices filtered by that financialOperationId. For example:

   Copy

3. Display each returned invoice's salesDay and amount. Together they account for the full amount collected.

4. Retrieve any remaining invoices by passing pagingMetadata.cursors.next from the response as query.cursorPaging.cursor in the next request.