arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/list_invoices

List Invoices

Retrieves a list of invoices by month.

Body

Invoice list request to be submitted via JSON

Name Description Type Additional information
per_page Default is 10 however you can display up to 25 at a time. number None.
page_number Page number number None.
account_key Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any get orders will be based upon the user's api credentials. Leave as null or ignore if not explicitly required to use this parameter. text None.

Example JSON Body

application/json, text/json

{
  "per_page": 1,
  "page_number": 2,
  "account_key": "sample string 3"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/list_invoices' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "per_page": 1,
  "page_number": 2,
  "account_key": "sample string 3"
}'