Magidoc

getFinanceCustomerInvoices
Query

Read customer invoices and their existing payment applications, with bounded pagination. Access: finance enabled and visibility of the invoice company. Errors: workspace access denied or an unknown accounting period.

Arguments

#

workspaceId

ID !
Non-null

projectId

clientAccountId

Narrows to one customer — the filter behind pickers that apply a document to an invoice.

customerInvoiceId

openItemsOnly

Narrows to the open receivables — posted, not voided, still carrying a balance. The population the Open accounts receivable queue counts, which no invoice status describes: posted also holds every invoice already paid off.

profitLossAwaitingPosting

Narrows to the invoices the P&L readiness banner counts as awaiting posting — posted, no journal yet, minus those whose import committed that no posting is expected. The filter behind the banner's Review invoices link, so the list reproduces the count that named it.

periodId

includeOtherPeriods

With periodId, keep its company scope but include invoices issued in other periods. Use for payments settling earlier invoices; an invoice issue date is not its payment date.

search

statuses

currency

Narrows to invoices billed in one currency. A retainer drawdown subtracts its amount from the invoice's balance, so it can only settle an invoice held in the retainer's own unit — narrowing here rather than in the caller keeps the page limit and the narrowing on the same side, which a client-side filter over an already-truncated page cannot.

sortBy

sortDirection

limit = 50

skip

Response

#

Returns [CustomerInvoice !]!.

Example

#