DocumentationChangelog
Documentation
Login

Summarise invoices

get
https://public-api.spendesk.com/v2/companies//invoices/summary

Allowed Scopes: experimental:invoice:read

Returns aggregate figures (count + amount totals by currency) over all invoices matching the filters. With no type filter, only invoices are included — credit notes are neither counted nor netted off. The createdAfter, createdBefore, updatedAfter and updatedBefore filters use only the UTC date of the value: After includes that day, Before excludes it.
Invoice summary data is cached for up to 20 minutes. Changes, including those made through the API, can take up to 20 minutes to appear.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID.

Query Params
string

Filter by the supplier's invoice number (case-insensitive exact match). Ignored with type=creditNote; use search to find a credit note by its number.

supplierId
array of strings
length ≤ 50
supplierId
buyerId
array of strings
length ≤ 50
buyerId
purchaseOrderId
array of strings
length ≤ 50
purchaseOrderId
costCenterId
array of strings
length ≤ 50
costCenterId
expenseCategoryId
array of strings
length ≤ 50

Filter by expense category, matching the ids in the invoice expenseCategories. A split invoice matches if any of its categories does.

expenseCategoryId
string
enum

Kind of document the record represents.

TypeDescription
invoiceA supplier invoice: an amount the company owes the supplier for goods or services. Amounts are positive.
creditNoteA supplier credit note: a document from the same supplier that reduces an amount owed (a refund, cancellation, or correction of a prior invoice). Amounts are negative.
Allowed:
stage
array of objects

Filter by stage; any of the listed values matches. When omitted, every stage except cancelled is returned; pass cancelled to get cancelled invoices. Draft and incomplete invoices are never listed here, not even under pendingApproval; fetch one by ID instead, which fails while it still lacks a supplier, issue date or currency.

stage
Allowed:
paymentStatus
array of objects
paymentStatus
Allowed:
paymentSource
array of objects
paymentSource
Allowed:
paymentMethod
array of objects
paymentMethod
exportStatus
array of objects
exportStatus
Allowed:
documentaryEvidenceStatus
array of objects
documentaryEvidenceStatus
Allowed:
boolean
string
^[A-Z]{3}$

If the payment was made in a foreign currency, this amount will be the one in the payment currency. Three-letter ISO currency codes.

integer
integer
date

String containing a date expressed in ISO 8601 format like 2023-05-12.

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?