developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIInvoices

Get invoice list

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Invoices
View .mdOpenAPI

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

  • created (datetime)
  • companyname (string)
  • totalamount (decimal)
  • totalcurrency (string)
  • referencenumber (integer)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required

Query parameters

  • OutletIdstring (uuid)
  • Handledboolean

    True or false.

    For true invoices that are handled are returned.

    For false invoices that are unhandled are returned.

  • Offsetinteger (int32)

    Offset the result, defaults to 0

  • Limitinteger (int32)

    Limits how many items to get, defaults to 100 min 0, max 1000.

  • Orderstring

    Order the result.

  • Searchstring
  • Filtermap<string, array<string>>

    Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00

Filter takes filter[field]=operator:value on 5 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    8 fields in items
    • idstring (uuid)

      Invoice id is the same as order id.

    • referenceNumberinteger (int64)

      Reference number for the invoice / order.

    • createdAtstring (date-time)
    • companyIdstring (uuid)
    • companyNamestring | null
    • totalobject | null

      Total amount of the invoice.

      2 fields in total
      • amountnumber (double)
      • currencystring | null
    • handlingStatusinteger (int32)

      Bitwise status of the invoice. 5 for example means that the invoice and refund is both unhandled. 10 means that both are handled. Allowed values: 1, 2, 4, 8.

    • integrationStatusstring | null

      A text representation of the handling status, will be one of the following values: "Invoice Unhandled" "Refund Unhandled" "Invoice and Refund UnHandled" or null.

  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)