Export Invoice AR Aging Report

Changed on

Synchronously renders and returns an AR aging report file — no job queue/polling, the file comes back directly in the response body. Accepts the same module/filter params as Get Invoice AR Aging Detail, plus type and render_engine.

get/invoice/account_receivable/export

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoice/account_receivable/export
  • Auth
    API key in header x-api-key

Query parameters

module'INVOICE' | 'CUSTOMER' | 'ORGANIZATION'
type'PDF' | 'XLSX' | 'PRINT' required
render_engine'PUPPETEER' | 'PHANTOM'

Applies to PDF/PRINT only.

filter.keywordstring
filter.aging_periodstring
filter.customerstring
filter.due_date_fromstring
filter.due_date_tostring

Response

200 — raw binary file, not a JSON envelope. XLSX returns Content-Type application/vnd.openxmlformats-officedocument.spreadsheetml.sheet with a Content-Disposition attachment header; PDF/PRINT returns Content-Type application/pdf.

Changes