PaymentReceivedParams

Tělo požadavku pro vytvoření nebo editaci platby přijaté.

Není to tvar detailu. Odpověď z GET /payment_received/{id} nejde poslat zpět na PUT beze změny — vnořené objekty se při zápisu posílají jako ID a dopočtené částky se neposílají vůbec:

Pole	GET (odpověď)	POST / PUT (požadavek)
zákazník	customer — objekt	customer_id — ID
dodavatel	supplier — objekt	supplier_id — ID
faktura	invoice — objekt	invoice_id — ID
opravný daňový doklad	creditnote — objekt	creditnote_received_id — ID
pokladna	cash_register — objekt	cash_register_id — ID
bankovní účet	bank_account — objekt	bank_account — ID
EET zpráva	eet_status — objekt	eet_status — ID
price, price_czk, price_inc_vat, price_inc_vat_czk, currency	dopočítané	neposílají se

Platba se páruje nejvýš na jeden doklad — invoice_id, proforma_invoice_id a creditnote_received_id se nedají kombinovat.

právě jedno z

• Protistranou je zákazník
• Protistranou je dodavatel

právě jedno z

• Platba na bankovní účet
• Platba do pokladny

sequence_codestringmax. délka 45

Číslo dokladu. Když se nevyplní, přidělí ho číselná řada nastavená ve firmě.

např. PP20190001

external_codestringmax. délka 45

Vlastní číslo dokladu z cizího systému.

např. FV3425435

variable_symbolstringmax. délka 10

Variabilní symbol.

např. 20190001

datestring<date>povinné

Datum vystavení. Musí spadat do otevřeného účetního období.

např. 2019-07-12

date_vatstring<date>

Datum zdanitelného plnění. U neplátce DPH se nevyplňuje.

např. 2019-07-12

proforma_invoice_idinteger

ID zálohové faktury vydané, kterou platba hradí.

oss_modeboolean

Platba je v režimu One Stop Shop. Režim jde zapnout jen u platby navázané na zálohovou fakturu, ostatní pravidla jsou shodná s režimem OSS u faktur. Zapisovatelné (od verze API 1.2), dříve jen pro čtení.

eetboolean

Platba byla odeslána do EET. Zapsat true lze jen při vytváření platby s payment_type cash a s pokladnou povolenou pro EET, podrobnosti v průvodci doklady (od verze API 1.1).

payment_typestringpovinnétransfercash

Způsob úhrady. Na platbách je množina užší než na dokladech — aplikace pouští jen bankovní převod a hotovost. Popisy hodnot vrací Metody plateb.

Hodnota musí odpovídat protistraně platby: transfer se páruje s bank_account, cash s cash_register_id.

date_vat_prevstring<date>

Datum předchozí sazby DPH. Vyplňuje se u plateb, které spadají do období se změnou sazby.

např. 2019-05-05

descriptionstring

Poznámka na platbě.

např. Popis

rounding_typeRoundingTypenoneroundupdown

Způsob zaokrouhlení. Když se nevyplní, použije se nastavení firmy.

reference_markstringmax. délka 45

Párovací znak platby.

např. RF

full_paidboolean

Platba hradí napárovaný doklad v plné výši.

liquidation_amount(number | null)<double>může být null

Částka, kterou platba likviduje z napárovaného dokladu, v měně dokladu. Povinná, když je doklad vystavený v jiné měně než CZK nebo když se měna účtu či pokladny liší od měny dokladu (od verze API 1.2).

např. 50

items object[]povinné

Položky platby. Platba musí mít alespoň jednu.

Array [

textstringpovinnémax. délka 255

Popis položky.

např. Položka A

amountnumberpovinné

Počet jednotek.

např. 1

pricenumber<double>povinné

Cena za jednotku.

např. 50

unit_price_inc_vatboolean

Cena za jednotku je uvedená včetně DPH.

unitstringmax. délka 10

Jednotka.

např. ks

vatnumberpovinné

Sazba DPH v procentech. Platné sazby vrací Sazby DPH.

např. 21

vat_totalnumber<double>

DPH celkem za položku.

např. 0

department_idinteger

ID střediska.

contract_idinteger

ID zakázky.

accountentrytype_idinteger | nullmůže být null

ID typu účetní položky. Přepisuje chart_account_id.

vattype_idinteger | nullmůže být null

ID typu DPH. Přepisuje vat_chart_id.

chart_account_idinteger | nullmůže být null

ID účtu účetní osnovy.

vat_chart_idinteger | nullmůže být null

ID účtu DPH.

]

customer_idinteger

ID zákazníka jako protistrany.

supplier_idinteger

ID dodavatele jako protistrany.

invoice_idinteger

ID faktury vydané, kterou platba hradí.

creditnote_received_idinteger

ID opravného daňového dokladu přijatého, který platba hradí (od verze API 1.2).

cash_register_idinteger

ID pokladny, do které se platí. Používá se s payment_type nastaveným na cash. Pro odeslání do EET musí mít pokladna EET povolené.

bank_accountinteger

ID bankovního účtu, na který se platí. Používá se s payment_type nastaveným na transfer; u hotovostní platby se neposílá.

eet_statusinteger

ID už odeslané EET zprávy. Použije se pro platby evidované mimo iÚčto — záznam se s platbou automaticky propojí. Připojit ho lze jen k platbě s eet nastaveným na true (od verze API 1.1).

PaymentReceivedParams

{
  "sequence_code": "PP20190001",
  "external_code": "FV3425435",
  "variable_symbol": "20190001",
  "date": "2019-07-12",
  "date_vat": "2019-07-12",
  "proforma_invoice_id": 1234,
  "oss_mode": false,
  "eet": false,
  "payment_type": "transfer",
  "date_vat_prev": "2019-05-05",
  "description": "Popis",
  "rounding_type": "round",
  "reference_mark": "RF",
  "full_paid": true,
  "liquidation_amount": 50,
  "items": [
    {
      "text": "Položka A",
      "amount": 1,
      "price": 50,
      "unit_price_inc_vat": false,
      "unit": "ks",
      "vat": 21,
      "vat_total": 0,
      "department_id": 1,
      "contract_id": 1,
      "accountentrytype_id": 532,
      "vattype_id": 1,
      "chart_account_id": 46,
      "vat_chart_id": 52
    }
  ],
  "customer_id": 785,
  "supplier_id": 45,
  "invoice_id": 13290,
  "creditnote_received_id": 13290,
  "cash_register_id": 115,
  "bank_account": 456,
  "eet_status": 12
}