User
idintegerUnique identifier for the given user.
firstNamestringThe first name of the user
lastNamestringThe last name of the user
emailstring · emailA valid email address of the user
dateOfBirthstring · dateThe birthdate in Y-m-d format
Example: 1997-10-31emailVerifiedbooleanSet to true if the user's email has been verified.
createDatestring · dateThe date that the user was created.
Invoice
uuidstring · minLength: 1Unique identifier
permalinkstring · minLength: 1The invoice url. You can append "/pdf" to get the pdf version.
numbernumberThe invoice number
typeobjectbillerobjectcustomerobjectitemsobject[] · minItems: 1 · uniquenotestring · minLength: 1The invoice public note
amountnumberThe net amount of the invoice
vatAmountnumberThe vat amount
finalAmountnumberThe final amount
payableAmountnumberThe payable amount, after applier taxes
discountedAmountnumberThe discounted amount
restAmountnumberThe amount that is not paid
isPaidbooleanInvoice paid status
layoutLangstring · minLength: 1The language of the invoice. "GR" or "EN"
paymentMethodIdsobject[]templateIdnumberIf template is used, add the ID
hideItemNumbooleanif Numbering is hidden from products
isRecurringbooleanIf it is scheduled
isSendbooleanIf it was send by email
isReadbooleanIf the email was opened/read
dateIssuedstring · minLength: 1Date format Y-m-d
dateExpiresstringDate format Y-m-d
dateReadstringDate format Y-m-d
createdAtstring · minLength: 1ISO 8601 format
updatedAtstring · minLength: 1ISO 8601 format
deletedAtstring | null · date · readOnlyISO 8601 format
tagsobject[]Tags attached to invoice
isMydataEnabledbooleanIf Mydata is enabled for this invoice
mydataobjectdispatchDatedispatchTimevehicleNumbermovePurposeloadingPlacedestinationcorrelatedInvoicesobject[]taxTotalsobject[]totalWithheldAmountnumbertotalFeesAmountnumbertotalStampDutyAmountnumbertotalOtherTaxesAmountnumbertotalDeductionsAmountnumbervatListofflinePaymentMethodsobject[] · minItems: 1 · uniqueonlinePaymentMethodsobject[] · minItems: 1 · uniquetemplateExtrasobject
Meta
current_pagenumberfromnumberlast_pagenumberlinksobject[] · minItems: 1 · uniquepathstring · minLength: 1per_pagenumbertonumbertotalnumber
InvoiceListItem
uuidstring · minLength: 1 · readOnlyUnique identifier
billerIdnumberBiller's ID
customerobjectnumbernumberThe invoice number
typeobjectnotestringThe public note, if any.
amountnumberThe net amount
vatAmountnumberThe vat amount
finalAmountnumberThe total amount
payableAmountnumberThe payable amount, after taxes
restAmountnumberThe unpaid ( if any ) amount of invoice
isPaidbooleanPaid status of invoice
layoutLangstring · minLength: 1The language of the invoce, GR or EN
paymentMethodIdsarrayPaymentmethods Id's
templateIdnumberIf customer template is used, fill in the ID
hideItemNumbooleanHide item numbering
isRecurringbooleanIf was setup as recurring (scheduled)
isSendbooleanIf is send to the client by email
isReadbooleanthe client has read/open the email
dateIssuedstring · date · minLength: 1Date Format Y-m-d
dateExpiresstring · dateDate Format Y-m-d
dateReadstring · dateDate Format Y-m-d
createdAtstring · date-time · minLength: 1ISO 8601 format
updatedAtstring · date-time · minLength: 1ISO 8601 format
deletedAtstring | null · date-time · readOnlyISO 8601 format
isMydataEnabledbooleanIf mydata is enabled for this invoice
correlatedInvoicesobject[]Correlated invoices if any
permalinkstring · uri · readOnlyThe public URL for invoice
Customer
idnumber · readOnly · requiredCustomer's Unique Identifier
countrystring · minLength: 2 · maxLength: 2 · requiredISO 3166-1 alpha-2 code
Example: GRcustomerTypenumber · enum · required1 - Local, 2 - EU(VIES), 3 - Abroad
Enum values:123
emailstringEmail address. Mandatory if you're using the "send invoice by email" feature.
inChargestringFull name of person in charge
infostringPrivate note for customer
companystringCompany name
professionstringCompany's field/profession. Applicable in some countries
vatIdstringCompany's VatID
taxOfficestringTax Office
streetAddressstringThe physical address of the company
citystringThe city that the company is located
postalCodestringThe postal code
phonestringThe company's telephone
mobilestringMobile phone
faxstringFax number
field1string | nullCustom field 1
field2string | nullCustom field 2
field3string | nullCustom field 3
field4string | nullCustom field 4
enabledbooleanIs customer enabled?
langstring · enumChoose the language you want the customer to receive his invoices.
Enum values:elendiscountnumberPre select a discount percentage each time you create an invoice for this customer
aliasstringA friendly short name that you identify the customer.
debtnumberPrevious debt/balance of customer, before inserting him in the app.
overflowAmountnumber · readOnlyOverflow amount of account
totalnumber · readOnlyCustomer's total balance
unpaidnumberCustomer unpaid amount
createdAtstring · date-time · readOnlyISO 8601 format
updatedAtstring · minLength: 1ISO 8601 format
deletedAtstring | null · date-timeISO 8601 format
isCompanybooleanCustomer is a company or an individual
publicNotestring · minLength: 1This note will be publicly available in the "notes" section of an invoice
currencystringcontactTypenumber · enumEnum values:123
Biller
companystring · requiredBiller's name / company
vatIdstring · minLength: 9 · requiredBiller's vat ID
postalCodestring · minLength: 1 · requiredPostal code
countrystring · minLength: 1 · requiredISO 3166-1 alpha-2 code
idnumber · readOnlyBiller's unique ID
companySecstring · minLength: 1Biller name in secondary language
professionstring · minLength: 1Biller Profession
professionSecstring · minLength: 1Biller profession in secondary language
taxOfficestring · minLength: 1Biller's tax office
streetAddressstring · minLength: 1The physical street address
streetAddressSecstring · minLength: 1The physical street address in secondary language
citystring · minLength: 1Biller's city
citySecstring · minLength: 1Biller's city in secondary language
phonestring · minLength: 1Phone number
phoneSecstring · minLength: 1Phone number in secodary language
mobilestringMobile phone number
mobileSecstring · minLength: 1Mobile phone number in secondary language
faxstringFax number
logostring · minLength: 1The full URL of the biller's logo
urlstring · minLength: 1Full url of the Biller's website
urlSecstring · minLength: 1Full url of the Biller's website in secondary language
urlLabelstring · minLength: 1A friendly name for website
freeTextstring · minLength: 1Html block with extra info
freeTextSecstring · minLength: 1Html block with extra info in secondary language
createdAtstring · date-time · readOnlyISO 8601 format
updatedAtstring · date-time · readOnlyISO 8601 format
Payment
idnumberinvoiceIdnumberpaymentMethodIdnumberamountnumberinfostringtransactionIdapptransactionIdcustomerIdnumberpaidInvoicesoverflowAmountnumberdateOccurredstring · minLength: 1createdAtstring · minLength: 1ISO 8601 format
updatedAtstring · minLength: 1ISO 8601 format
Supplier
idnumbercompanystring · minLength: 1infostringprofessionstringvatIdstring · minLength: 1taxOfficestring · minLength: 1streetAddressstring · minLength: 1citystringzipCodestringphonestringmobilestringfaxstringemailstringurlstringenabledbooleanaliasstringcurrencystring · minLength: 1countrystring · minLength: 1createdAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
updatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
deletedAtstring | null · date-time · readOnlyISO 8601 format
Ocp
uuidstring · minLength: 1customerIdnumbertitlestring · minLength: 1descriptionstring · minLength: 1productIdreturnUrlstringpaymentmethodIdnumbercostnumbervatIdnumberactivebooleaninvoiceTypeIdnumbernetValuenumberlocalestring · minLength: 1wasSendbooleantagsobject[]salesobject[]expirationAtstring · date-time · minLength: 1ISO 8601 format
createdAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
updatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
deletedAtstring · date-time · readOnlyISO 8601 format
Tag
tagstring · minLength: 1 · requiredThe tag name
idnumberThe unique id of the tag
descriptionA description of the tag
Product
idnumbernamestring · minLength: 1descriptionstring · minLength: 1nameSecstringdescriptionSecstringunitPricenumberdefaultVatIdnumberstocknumberwithStockbooleanisVatIncludedbooleanorderingbooleanactivebooleanisServiceboolean | nullbulkjobIdcreatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
updatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
deletedAtstring | null · date-time · readOnlyISO 8601 format
Purchase
idnumberinfostringsupplierIdnumberpricenumbervatAmountnumberirsAmountnumberinvoiceNumstring · minLength: 1taxOfficestreetAddresscompanyExpensebooleanisCreditedbooleanpaidbooleanirsTypenumberirsPercentreceiptIdoriginalPriceoriginalVatoriginalCurrencysystemCurrencyratedateOccurredstring · date · minLength: 1datePaidstring · date · minLength: 1createdAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
updatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
Paymentmethod
idnumber · requirednamestring · minLength: 1 · requiredisOnlineMethodboolean · requiredstatusboolean · requireddefaultboolean · required
nameSecinfoinfoSecibanbicaccountHoldercreatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
updatedAtstring · date-time · minLength: 1 · readOnlyISO 8601 format
deletedAtstring | null · date-time · readOnlyISO 8601 format
Vat
idnumberVat ID
namestring · minLength: 1Vat friendly name
valuenumberVat value (%)
descriptionstringA description if needed
isDefaultbooleanSet as default while being used from resources
isHiddenbooleanHide from the dropdown menus because it's inactive.
mydataVatCatnumberThe mydata Category
operandstring · enum · readOnlyThe operand of the vat
Enum values:+-isPercentablebooleanIf the type is Percentable or not
taxIdnumberThe linked taxId
deletedAtstring | null · date-timeISO 8601 format
Setting
dateFormatstring · minLength: 1 · requiredcurrencystring · minLength: 1 · requiredcurrencySymbolstring · minLength: 1 · requireddefaultInvoiceTypenumber · requireddefaultTemplatestring · minLength: 1 · requiredappLanguagestring · minLength: 1 · requiredmultiLanguageboolean · requiredreceiveReportboolean · requiredforwardingEmailstring · minLength: 1 · requiredaccountantobject · requiredocpobject · requiredpersonalizedEmailobject · required
incrementingNumberLengthreportToEmail