Get Invoices

Fetch a list of invoice numbers within a specified date range. You can use results from this call to search for specific Invoice details in /Invoice/{InvoiceNumber} API.

Must use bearer token method for authentication.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

FromDate

string

required

Specifies the start date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD

ToDate

string

required

Specifies the end date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD

CustomerKey

string

optional

Your unique FlavorCloud customer key.

InvoiceType

enum<string>

required

Defines the type of invoices to retrieve. Possible values include: STANDARD, RECONCILIATION, SUBSCRIPTION and MANUAL.

Allowed values:

StandardReconciliationSubscriptionManual

Responses

🟢200Success

application/json

Body

array of:

InvoiceURL

string

required

InvoiceURLXLS

string

required

InvoiceNumber

string

required

InvoiceAmount

number

required

InvoiceStatus

string

required

InvoiceType

string

required

InvoiceDate

string

required

Example

[
  {
    "InvoiceURL": "https://cdn.flavorcloud.com/i-FLCL-1i89h2m6ei0o-payment-invoice.pdf",
    "InvoiceURLXLS": "https://cdn.flavorcloud.com/FLCL-1i89h2m6ei0o-payment-invoice-1726896757265.xlsx",
    "InvoiceNumber": "FLCL-1i89h2m6ei0o",
    "InvoiceAmount": 142.12,
    "InvoiceStatus": "PAID",
    "InvoiceType": "Standard",
    "InvoiceDate": "2024-09-21T05:32:37.000Z"
  }
]

Request

Request samples

Responses