API Reference

Gets invoice references

get
https://api.farpay.io/v2/invoices

Gets a collection of InvoiceReferences. Optional criteria for filtering are from and to date.
The Dateformat is yyyy-MM-dd (e.g. "2017-05-31") for the 31th of May 2017.
Payment status will be

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

optional invoicenumber to find a specific invoice

string

optional filter for getting all invoices for a specific customer

int32

optional delivery id, that filters all invoices, that have been created
based on that specific deliveryId - There can be one or many invoices.

string

optional from date with format: yyyy-MM-dd

string

optional to date with format: yyyy-MM-dd

string
enum

optional filter on payment the paymentstate.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Date must be formatted correct, see body for details

401

apiKey is unauthorized

Updated about 1 year ago

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

Updated about 1 year ago

Did this page help you?