Sign in

v1

latestOpenAPI 3.0.02026-07-13314761.7 KB
Document

List all documents

Returns a list of your documents. The documents are returned sorted by creation date, with the most recent documents appearing first.

get/documents

Query parameters

pageinteger
per_pageinteger
block_idinteger

Filter documents by the identifier of your DocumentBlock.

partner_idinteger

Filter documents by the identifier of your Partner.

payment_method'aruhitel' | 'bankcard' | 'barion' | 'barter' | 'cash' | 'cash_on_delivery' | 'coupon' | 'elore_utalas' | 'ep_kartya' | 'kompenzacio' | 'levonas' | 'online_bankcard' | 'payoneer' | 'paypal' | 'paypal_utolag' | 'payu' | 'pick_pack_pont' | 'postai_csekk' | 'postautalvany' | 'skrill' | 'szep_card' | 'transferwise' | 'upwork' | 'utalvany' | 'valto' | 'wire_transfer'

Filter documents by PaymentMethod value.

payment_status'expired' | 'none' | 'outstanding' | 'paid' | 'partially_paid'

Filter documents by PaymentStatus value.

start_datestring date

Filter documents by date.

end_datestring date

Filter documents by date.

start_numberinteger

Starting number of the document, should not contain year or any other formatting. Required if start_year given

end_numberinteger

Ending number of the document, should not contain year or any other formatting. Required if end_year given

start_yearinteger

Year for start_number parameter. Required if start_number given.

end_yearinteger

Year for end_number parameter. Required if end_number given.

Response

Success response

totalinteger
per_pageinteger
current_pageinteger
last_pageinteger
prev_page_urlstring
next_page_urlstring

Example response

{
  "data": [
    {
      "invoice_number": "PREFIX / 2020-000001"
    }
  ]
}