Pobierz listę faktur zaliczkowych marża

Zakres: api:invoices:read.

GET

https://api.sandbox-infakt.pl/v3/margin_advance_invoices.json

Autoryzacja

ApiKey
opcjonalne
API key in header

Token
opcjonalne
API key in header

Query parameters

page
opcjonalne
integer
Numer strony liczony od 1; ignorowany, gdy wysłany jest offset.

format: int32 · default: 1
per_page
opcjonalne
integer
Liczba wyników na stronę przy page. Serwer jej nie ogranicza.

format: int32 · default: 10
offset
opcjonalne
integer
Indeks pierwszego wyniku (liczba pomijanych encji).

format: int32
limit
opcjonalne
integer
Liczba wyników na stronę przy offset; domyślnie 10, ignorowana bez offset. Większość list bez błędu obniża wartości powyżej 100 do 100.

format: int32
pagination_without_total
opcjonalne
boolean
Pomiń liczenie; metainfo.total_count przyjmuje wartość null.
fields
opcjonalne
string
Zawężenie pól: nazwy pól API rozdzielone przecinkami, np. id,company_name; id jest zwykle dodawane. Odpowiedź zawiera wtedy tylko te pola, więc nie odpowiada pełnemu schematowi. Pola wyliczane, a nie zapisywane, mogą kończyć się błędem 500; operacja je wymienia.
order
opcjonalne
string
Sortowanie: <pole>, <pole> asc albo <pole> desc z nazwą pola API, np. name desc. Pole, po którym nie da się sortować, jest ignorowane bez błędu.
q[number_eq]
opcjonalne
string
q[clean_client_nip_eq]
opcjonalne
string
NIP klienta, same cyfry.
q[invoice_date_gteq]
opcjonalne
string
format: date
q[invoice_date_lteq]
opcjonalne
string
format: date
q[status_eq]
opcjonalne
draft
or
sent
or
printed
or
unpaid
or
paid
or
scheduled
q[kind_eq]
opcjonalne
vat
or
proforma
or
margin
or
advance
or
correction
or
margin_correction
+5 more
q[paid_date_null]
opcjonalne
boolean

Odpowiedzi

200

Sukces

JSON

metainfo
object
wymagane
- count
  integer
  wymagane
  Liczba encji na tej stronie.
  
  format: int32
- total_count
  wymagane
  Liczba pasujących encji; null, gdy pagination_without_total=true.
  
  One of the following:
  integer
  null
- next
  string
  wymagane
  Bezwzględny URL następnej strony w postaci offset/limit.
- previous
  string
  wymagane
  Bezwzględny URL poprzedniej strony w postaci offset/limit.
}
entities
array of
object
wymagane
- id
  integer
  wymagane
  format: int64
- uuid
  string
  wymagane
  format: uuid
- number
  string
  wymagane
- currency
  string
  wymagane
  Kod ISO 4217.
- kind
  vat
  or
  proforma
  or
  margin
  or
  advance
  or
  correction
  or
  margin_correction
  +5 more
  wymagane
- payment_method
  wymagane
  One of the following:
  PaymentMethod
  null
- recipient_signature
  string
  wymagane
- seller_signature
  string
  wymagane
- invoice_date
  string
  wymagane
  format: date
- vat_date_value
  string
  wymagane
  Data powstania obowiązku VAT: sale_date, issue_date albo paid_date (metoda kasowa).
- occasional_sale
  boolean
  wymagane
- status
  draft
  or
  sent
  or
  printed
  or
  unpaid
  or
  paid
  or
  scheduled
  wymagane
- payment_date
  wymagane
  One of the following:
  string
  null
- paid_date
  wymagane
  One of the following:
  string
  null
- gross_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- left_to_pay
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- client_id
  wymagane
  One of the following:
  integer
  null
- client_uuid
  wymagane
  One of the following:
  Uuid
  null
- client_company_name
  wymagane
  One of the following:
  string
  null
- client_first_name
  wymagane
  One of the following:
  string
  null
- client_last_name
  wymagane
  One of the following:
  string
  null
- client_business_activity_kind
  wymagane
  One of the following:
  BusinessActivityKind
  null
- client_street
  wymagane
  One of the following:
  string
  null
- client_street_number
  wymagane
  One of the following:
  string
  null
- client_flat_number
  wymagane
  One of the following:
  string
  null
- client_city
  wymagane
  One of the following:
  string
  null
- client_post_code
  wymagane
  One of the following:
  string
  null
- client_tax_code
  string
  wymagane
- client_country
  wymagane
  One of the following:
  CountryCode
  null
- sale_type
  service
  or
  merchandise
  or
  wymagane
  Tylko transakcje zagraniczne; w pozostałych "".
- invoice_date_kind
  wymagane
  One of the following:
  InvoiceDateKind
  null
- document_markings_ids
  wymagane
  ID oznaczeń dokumentu jako stringi. Zobacz GET /incomes_documents_markings.json.
  
  One of the following:
  array<string>
  null
- bdo_code
  wymagane
  One of the following:
  string
  null
- not_income
  wymagane
  One of the following:
  boolean
  null
- vat_exchange_date_kind
  wymagane
  One of the following:
  string
  null
- sales_kind
  sprzedaz_podstawowa
  or
  sprzedaz_pozostala
  wymagane
- amount_in_words
  wymagane
  One of the following:
  string
  null
- local_government_recipient_address
  wymagane
  One of the following:
  LocalGovernmentAddress
  company_name
  wymagane
  One of the following:
  string
  null
  nip
  wymagane
  One of the following:
  string
  null
  street
  wymagane
  One of the following:
  string
  null
  street_number
  wymagane
  One of the following:
  string
  null
  flat_number
  wymagane
  One of the following:
  string
  null
  postal_code
  wymagane
  One of the following:
  string
  null
  city
  wymagane
  One of the following:
  string
  null
  country
  wymagane
  One of the following:
  CountryCode
  null
  null
- third_party_addresses
  array of
  object
  wymagane
  id
  integer
  wymagane
  format: int64
  company_name
  wymagane
  One of the following:
  string
  null
  tax_id
  wymagane
  One of the following:
  string
  null
  street
  wymagane
  One of the following:
  string
  null
  building_number
  wymagane
  One of the following:
  string
  null
  door_number
  wymagane
  One of the following:
  string
  null
  post_code
  wymagane
  One of the following:
  string
  null
  city
  wymagane
  One of the following:
  string
  null
  country_code
  wymagane
  One of the following:
  CountryCode
  null
  role_code
  wymagane
  Kod roli podmiotu trzeciego w KSeF; zobacz ThirdPartyAddressInput.role_code.
  
  One of the following:
  string
  null
  internal_identifier
  wymagane
  One of the following:
  string
  null
- building_service
  boolean
  wymagane
- created_at
  string
  wymagane
  format: date-time
- ksef_number
  wymagane
  One of the following:
  string
  null
- transaction_terms
  wymagane
  One of the following:
  TransactionTerms
  contracts
  opcjonalne
  array of
  object
  number
  string
  wymagane
  date
  string
  wymagane
  format: date
  orders
  opcjonalne
  array of
  object
  number
  string
  wymagane
  date
  string
  wymagane
  format: date
  null
- notes
  wymagane
  One of the following:
  string
  null
- ksef_data
  wymagane
  One of the following:
  InvoiceKsefData
  request_uuid
  wymagane
  null dla faktur odrzuconych przed wysyłką.
  
  One of the following:
  string
  null
  ksef_number
  wymagane
  Numer KSeF nadany po przyjęciu.
  
  One of the following:
  string
  null
  status
  pending
  or
  sent
  or
  success
  or
  error
  or
  cancelled
  or
  rejected
  wymagane
  rejected tylko w odpowiedziach zbiorczych, dla dokumentów, których w ogóle nie wysłano.
  
  status_description
  wymagane
  One of the following:
  string
  null
  timestamps
  object
  wymagane
  request_created_at
  string
  wymagane
  request_finished_at
  wymagane
  One of the following:
  string
  null
  KsefSendError
  status
  error
  wymagane
  status_description
  string
  wymagane
  null
- related_exchange_differences_internal_evidences
  array of
  object
  wymagane
  id
  integer
  wymagane
  format: int64
  number
  string
  wymagane
  uuid
  string
  wymagane
  format: uuid
- margin_kind_id
  integer
  wymagane
  format: int64
- margin_kind
  string
  wymagane
  Nazwa procedury marży po polsku.
- margin_kind_symbol
  second_hand_goods
  or
  travel_agencies
  or
  works_of_art
  or
  collectables_and_antiques
  wymagane
- margin_amount_price
  integer
  wymagane
  Łączna marża.
  
  format: int64
- bank_account
  wymagane
  Ustawione tylko dla metod płatności transfer i accredited.
  
  One of the following:
  string
  null
- bank_name
  wymagane
  One of the following:
  string
  null
- swift
  wymagane
  One of the following:
  string
  null
- services
  array of
  object
  wymagane
  id
  integer
  wymagane
  format: int64
  name
  string
  wymagane
  gtu_id
  wymagane
  One of the following:
  integer
  null
  unit
  string
  wymagane
  "", gdy nie ustawiono.
  
  quantity
  number
  wymagane
  format: double
  gross_with_margin_amount_price
  integer
  wymagane
  Cena sprzedaży z marżą.
  
  format: int64
  margin_amount_price
  integer
  wymagane
  Kwota marży.
  
  format: int64
  flat_rate_tax_symbol
  opcjonalne
  Tylko u podatników na ryczałcie.
  
  One of the following:
  string
  null
- advance_date
  wymagane
  One of the following:
  string
  null
- advance_price
  integer
  wymagane
  Kwota otrzymana z tą zaliczką.
  
  format: int64
- advance_margin_price
  integer
  wymagane
  Część advance_price przypadająca na marżę.
  
  format: int64
- advance_tax_price
  integer
  wymagane
  VAT od advance_margin_price.
  
  format: int64
- previous_advance_id
  wymagane
  One of the following:
  integer
  null
- previous_advances
  array of
  object
  wymagane
  id
  integer
  wymagane
  format: int64
  uuid
  string
  wymagane
  format: uuid
  number
  string
  wymagane
  kind
  string
  wymagane
  Polski symbol rodzaju: zaliczka_marza.
  
  invoice_date
  string
  wymagane
  format: date
  advance_price
  integer
  wymagane
  Kwota otrzymana z zaliczką.
  
  format: int64
  gross_price
  integer
  wymagane
  To samo co advance_price.
  
  format: int64
  margin_price
  integer
  wymagane
  Część zaliczki przypadająca na marżę.
  
  format: int64
  tax_price
  integer
  wymagane
  VAT od margin_price.
  
  format: int64
  net_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- next_advances
  array of
  object
  wymagane
  id
  integer
  wymagane
  format: int64
  uuid
  string
  wymagane
  format: uuid
  number
  string
  wymagane
  kind
  string
  wymagane
  Polski symbol rodzaju: zaliczka_marza.
  
  invoice_date
  string
  wymagane
  format: date
  advance_price
  integer
  wymagane
  Kwota otrzymana z zaliczką.
  
  format: int64
  gross_price
  integer
  wymagane
  To samo co advance_price.
  
  format: int64
  margin_price
  integer
  wymagane
  Część zaliczki przypadająca na marżę.
  
  format: int64
  tax_price
  integer
  wymagane
  VAT od margin_price.
  
  format: int64
  net_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- previous_invoice_uuid
  opcjonalne
  Tylko w odpowiedzi get.
  
  One of the following:
  Uuid
  null
- following_invoice_uuid
  opcjonalne
  Tylko w odpowiedzi get.
  
  One of the following:
  Uuid
  null
- client_vat_number_active
  opcjonalne
  Tylko w odpowiedzi get. Numer VAT klienta jest czynny w rejestrze VAT.
  
  One of the following:
  boolean
  null
- show_sales_kind
  opcjonalne
  boolean
  Tylko w odpowiedzi get.
- exchange_rates_data
  opcjonalne
  Tylko w odpowiedzi get; null dla faktur w PLN.
  
  One of the following:
  ExchangeRatesData
  vat_exchange_table_number
  wymagane
  One of the following:
  string
  null
  vat_exchange_date
  wymagane
  One of the following:
  string
  null
  pit_exchange_table_number
  wymagane
  One of the following:
  string
  null
  pit_exchange_date
  wymagane
  One of the following:
  string
  null
  exchange_vat_rate
  string
  wymagane
  Kurs z przecinkiem dziesiętnym, np. 4,2512.
  
  exchange_pit_rate
  string
  wymagane
  Kurs z przecinkiem dziesiętnym, np. 4,2512.
  
  null
- statuses
  opcjonalne
  array of
  object
  Tylko w odpowiedzi get.
  
  symbol
  string
  wymagane
  name
  string
  wymagane
  group
  string
  wymagane
- parent_invoice_data
  opcjonalne
  Tylko w odpowiedzi get. null, chyba że faktura VAT lub zaliczkowa została wystawiona z innego dokumentu.
  
  One of the following:
  ParentInvoiceData
  uuid
  string
  wymagane
  format: uuid
  number
  string
  wymagane
  gross_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
  invoice_date
  string
  wymagane
  format: date
  null
}

400

Nieprawidłowe parametry wyszukiwania (q[...]); na niektórych endpointach także nieprawidłowe parametry stronicowania.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

406

Ścieżka nie kończy się na .json.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string