API Docs / Operations / Invoices / PurchaseInvoice monthly analysis

PurchaseInvoice monthly analysis

GET /tenants/{tenant}/purchase-invoices/monthly-analysis

Invoice counts and totals per month for the months ending in the given year and month (months = 12 for a year of chart data), by the date field, for every contact or one contact.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

contact query string
dateField* query enum

Date DueDate PaidDate PaidTaxMonthEnding

Date DueDate PaidDate PaidTaxMonthEnding

month* query integer (int32)
months* query integer (int32)
year* query integer (int32)

Responses

200 OK
400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json