List Invoices
Uri: https://test-api.finerworks.com/v3/list_invoices
Method: POST

Retrieves a list of invoices by month.


Body

Invoice list request to be submitted via JSON

NameDescriptionTypeAdditional 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 sample_method 'https://test-api.finerworks.comsample_endpoint' \
--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"
}'
                            
                        


require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://test-api.finerworks.comsample_endpoint');
$request->setMethod(HTTP_Request2::METHOD_sample_method);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'web_api_key' => 'my-web-api-key-goes-here',
'app_key' => 'my-app-key-goes-here'
));
$request->setBody('{
  'per_page': 1,
  'page_number': 2,
  'account_key': 'sample string 3'
}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}

                        


var client = new RestClient("https://test-api.finerworks.comsample_endpoint");
client.Timeout = -1;
var request = new RestRequest(Method.sample_method);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("web_api_key", "my-web-api-key-goes-here");
request.AddHeader("app_key", "my-app-key-goes-here");
request.AddParameter("application/json", "{
  'per_page': 1,
  'page_number': 2,
  'account_key': 'sample string 3'
},  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

                        


var settings = {
"url": "https://test-api.finerworks.comsample_endpoint",
"method": "sample_method",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"web_api_key": "my-web-api-key-goes-here",
"app_key": "my-app-key-goes-here"
},
"data": JSON.stringify({
  'per_page': 1,
  'page_number': 2,
  'account_key': 'sample string 3'
}),
};

$.ajax(settings).done(function (response) {
console.log(response);
});

                        

                        
var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
'method': 'sample_method',
'hostname': 'v2.api.finerworks.com',
'path': 'sample_endpoint',
'headers': {
'Content-Type': 'application/json',
'web_api_key': 'my-web-api-key-goes-here',
'app_key': 'my-app-key-goes-here'
},
'maxRedirects': 20
};

var req = https.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});

res.on("error", function (error) {
console.error(error);
});
});

var postData = JSON.stringify({
  "per_page": 1,
  "page_number": 2,
  "account_key": "sample string 3"
});

req.write(postData);

req.end();
                            
                        

                        
    require "uri"
    require "net/http"

    url = URI("https://test-api.finerworks.comsample_endpoint")

    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true

    request = Net::HTTP::sample_method.new(url)
    request["Content-Type"] = "application/json"
    request["web_api_key"] = "my-web-api-key-goes-here"
    request["app_key"] = "my-app-key-goes-here"
    request.body = "{
  'per_page': 1,
  'page_number': 2,
  'account_key': 'sample string 3'
}"

    response = https.request(request)
    puts response.read_body


                        

NameDescriptionTypeAdditional information
status

response_status

None.

invoices

array (invoice)

None.

total_count

number

None.

Example JSON Response

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {},
    "reference_id": "sample string 4",
    "domain": "sample string 5"
  },
  "invoices": [
    {
      "invoice_id": "sample string 1",
      "amount_due": 2.0,
      "invoice_month": "2026-02-28T18:11:17.9111259-06:00",
      "invoice_date": "2026-02-28T18:11:17.9121259-06:00",
      "first_day_of_month": "2026-02-28T18:11:17.9121259-06:00",
      "last_day_of_month": "2026-02-28T18:11:17.9121259-06:00",
      "due_date": "2026-02-28T18:11:17.9121259-06:00"
    },
    {
      "invoice_id": "sample string 1",
      "amount_due": 2.0,
      "invoice_month": "2026-02-28T18:11:17.9111259-06:00",
      "invoice_date": "2026-02-28T18:11:17.9121259-06:00",
      "first_day_of_month": "2026-02-28T18:11:17.9121259-06:00",
      "last_day_of_month": "2026-02-28T18:11:17.9121259-06:00",
      "due_date": "2026-02-28T18:11:17.9121259-06:00"
    }
  ],
  "total_count": 1
}