Skip to content

Proof payment

codestringrequired

proof payments identifier. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

orderCodestring or nullrequired

order code (can be null)

proformaInvoiceCodestring or nullrequired

proforma invoice code (can be null)

createdAtstring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date of create, in ISO 8601 format

updatedAtstring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date of update, in ISO 8601 format

issueDatestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date on which was proof payment issued, in ISO 8601 format

taxDatestring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date of tax

isValidbooleanrequired

is proof payment valid?

currencyCodestringrequired

currency code. List of available currencies within the e-shop can be found in endpoint GET /api/eshop.

paymentstring or null(typePriceNullable)^(-)?[0-9]+\.[0-9]{2}$required

total price on the bill

closedbooleanrequired

is proof payment closed?

billFullNamestring or nullrequired

name on the bill (can be null)

billCompanystring or nullrequired

company name on the bill (can be null)

billStreetstring or nullrequired

street on the bill (can be null)

billHouseNumberstring or nullrequired

house number on the bill (can be null)

billCitystring or nullrequired

city on the bill (can be null)

billDistrictstring or nullrequired

county on the bill (can be null)

billAdditionalstring or nullrequired

additional info for address on the bill (can be null)

billZipstring or nullrequired

ZIP or postal code on the bill (can be null)

billCountryCodestring or nullrequired

two-character ISO 3166-1 alpha-2 country code (or null)

billRegionNamestring or nullrequired

region name on the bil (can be null)

billRegionShortcutstring or nullrequired

region abbreviation on the bil (can be null)

vatIdstring or nullrequired

VAT identification number. (can be null)

taxIdstring or nullrequired

TAX identification number. For Czech address, taxId is same as vatId. (can be null)

companyIdstring or nullrequired

Company registration number. (can be null)

languagestring

Language code. Available only if module foreignLanguages is active and initialized.

emailstring or nullrequired
phonestring or nullrequired

Phone number

sourceobjectrequired

proof payments source

cashdeskIdinteger or nullrequired

cashdesk identifier

customerGuidtypeGuidUnlimited (string) or nullrequired
One of:

global unique permanent customer identifier (can be null)

<= 36 characters
string(typeGuidUnlimited)
customerProfileIdinteger or nullrequired

customer profile identifier (can be null)

remarkstring or nullrequired

remark (not visible for customer) (can be null)

varSymbolinteger, [ 0 .. 9999999999 ](typeVarSymbol)required

variable symbol

constSymbolstring or null(typeConstSymbolNullable)^[0-9]{1,4}$required

constant symbol (can be null)

specSymbolinteger or null, [ 0 .. 9999999999 ](typeSpecSymbolNullable)required

specific symbol (can be null)

billingMethodbillingMethod (object) or nullrequired
One of:

information about the method of payment

billBankAccountstring or nullrequired

bank account on the bill (can be null)

billIbanstring or nullrequired

e-shop IBAN on the bill (can be null)

billBicstring or nullrequired

bank code - SWIFT on the bill (can be null)

bankAccountstring or nullrequired

bank account (can be null)

ibanstring or nullrequired

e-shop IBAN (can be null)

bicstring or nullrequired

bank code - SWIFT (can be null)

documentRemarkstring or nullrequired

remark in the document (visible for customer) (can be null)

invoiceCodestring or nullrequired

Linked to invoice code (can be null)

vatBreakdownobject or null(proofPaymentVatBreakdown)required
vatModestring or null

VAT mode, can be null, for possible values see VAT modes code list

invoicingExchangeRatestring(typeExchangeRate)^[0-9]+\.[0-9]{8}$required

currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!

identificationNumberstring or nullrequireddeprecated

Identification number (can be null)

{
  "code": "P--2015000170-1",
  "orderCode": "2015000001",
  "proformaInvoiceCode": "2015000170",
  "createdAt": "2018-05-29T09:02:27+0200",
  "updatedAt": "2018-05-29T09:02:27+0200",
  "issueDate": "2018-05-29T09:02:27+0200",
  "taxDate": "2017-04-04",
  "isValid": true,
  "currencyCode": "CZK",
  "payment": "21.00",
  "closed": true,
  "billFullName": "John Doe",
  "billCompany": "Shoptet, a.s.",
  "billStreet": "Křižíkova",
  "billHouseNumber": "237/36",
  "billCity": "Praha 2",
  "billDistrict": "Praha 2",
  "billAdditional": "4. floor",
  "billZip": "120 00",
  "billCountryCode": "CZ",
  "billRegionName": "Capital city",
  "billRegionShortcut": "CC",
  "vatId": "CZ123456789",
  "taxId": "CZ123456789",
  "companyId": "12345678",
  "language": "cs",
  "email": "example@example.com",
  "phone": "603481066",
  "source": {
    "id": 1,
    "name": "Administration"
  },
  "cashdeskId": 123,
  "customerGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "customerProfileId": 123,
  "identificationNumber": "12345678",
  "remark": "This is a remark",
  "varSymbol": 2021000021,
  "constSymbol": "0308",
  "specSymbol": 201323134,
  "billingMethod": {
    "id": 3,
    "name": "Cash"
  },
  "billBankAccount": "123456789/1234",
  "billIban": "CZ6508000000192000145399",
  "billBic": "CNBACZPPXXXas",
  "bankAccount": "123456789/1234",
  "iban": "CZ6508000000192000145399",
  "bic": "CNBACZPPXXXas",
  "documentRemark": "This is a document remark",
  "invoiceCode": "2017100013",
  "vatBreakdown": {
    "items": [ … ],
    "summary": { … }
  },
  "vatMode": "normal",
  "invoicingExchangeRate": "1.04568087"
}