Try in playground

Field reference

The core GETS payload fields every country starts from, with their default requirement and type. Each country’s fields page adds its own fields and rules.

These are the fields of payload in POST https://prod.gets.complyance.io/api/v3/unify. For the endpoint, headers, the rest of the request body, the response and errors, see Submit and retrieve.

The table lists the 308 core fields, with the requirement the core gives each one. A country adds its own fields and can make a core field mandatory, conditional or optional for some document types, or leave it out. Before you rely on a requirement, check your country’s fields page, which lists every field the country uses and the values each one accepts:

To compare countries here, choose Compare countries. For the payload as one machine-readable file, use the GETS JSON Schema.

Payload fields

308 fields · conditional fields are required only when the condition in their description is met

Description
Invoice CurrencyMandatorystringDocument currency
Document NumberMandatorystringUnique document number
Document BaseMandatorystringThe base document type, such as tax_invoice or credit_note. Each country’s values are listed under Enums on its fields page.
Issue DateMandatorydateDocument issue date
Additional NotesOptionalstringA textual note that gives unstructured information that is relevant to the Invoice as a whole.
Document IDOptionalstringInternal system document identifier (UUID or database ID)
Document ModifiersOptionalarrayModifiers that apply to the document, such as export. Send [] when none apply. Each country’s values are listed under Enums on its fields page.
Document VariantOptionalstringA variant of the base document type, in the countries that have them. Leave it out for an ordinary document.
Due DateOptionaldatePayment due date
Exchange Rate DateOptionaldateExchange rate date
Exchange RateOptionalnumberExchange rate when currency differs from tax currency
Exchange Source CurrencyOptionalstringExchange rate source currency
Exchange Target CurrencyOptionalstringExchange rate target currency
Invoice Period EndOptionaldateEnd date of the invoiced period
Invoice Period FrequencyOptionalstringFrequency of the billing period (monthly, weekly, etc.)
Invoice Period StartOptionaldateStart date of the invoiced period
Issue TimeOptionalstringTime the document was issued, as hh:mm:ss.
Note Issuance ReasonOptionalstringReason for credit/debit note
Reference IDOptionalstringOriginal invoice reference ID
Reference NumbersOptionalarrayReference to original invoice (notes)
Tax Accounting CurrencyOptionalstringTax currency (often same as document currency)
Seller CityMandatorystringThe common name of the city, town or village, where the Seller address is located.
Seller CountryMandatorystringSeller country code
Seller NameMandatorystringSeller company name
Seller Registration TypeMandatorystringSeller registration type
Seller Registration ValueMandatorystringAn identifier issued by an official registrar that identifies the Seller as a legal entity or person.
Seller Tax ID TypeMandatorystringThe scheme of the TAX identifier.
Seller Tax ID ValueMandatorystringSeller tax ID value
Seller Access Code BuildingOptionalstringseller access code building
Seller Access Code GateOptionalstringseller access code gate
Seller Access Code IntercomOptionalstringseller access code intercom
Seller Address TypeOptionalstringseller address type
Seller Address UsageOptionalstringseller address usage
Seller ApartmentOptionalstringseller apartment
Seller Attention ToOptionalstringseller attention to
Seller Building NameOptionalstringseller building name
Seller Building NumberOptionalstringSeller building number
Seller Business Hours CloseOptionalstringseller business hours close
Seller Business Hours DaysOptionalarrayseller business hours days
Seller Business Hours OpenOptionalstringseller business hours open
Seller Care OfOptionalstringseller care of
Seller Delivery InstructionsOptionalstringseller delivery instructions
Seller Delivery PointOptionalstringseller delivery point
Seller DistrictOptionalstringSeller district
Seller FloorOptionalstringseller floor
Seller Geo Location LatitudeOptionalnumberseller geo location latitude
Seller Geo Location LongitudeOptionalnumberseller geo location longitude
Seller LandmarkOptionalstringseller landmark
Seller Plus CodeOptionalstringseller plus code
Seller PO BoxOptionalstringseller po box
Seller Post OfficeOptionalstringseller post office
Seller Room NumberOptionalstringseller room number
Seller Street NameOptionalstringseller street name
Seller Street NumberOptionalstringseller street number
Seller Sub DistrictOptionalstringseller sub district
Seller Time ZoneOptionalstringseller time zone
Seller Valid FromOptionaldateseller valid from
Seller Valid ToOptionaldateseller valid to
Seller Verification DateOptionaldateseller verification date
Seller Verification SourceOptionalstringseller verification source
Seller VerifiedOptionalstringseller verified
Seller WardOptionalstringseller ward
Seller What Three WordsOptionalstringseller what three words
Seller ZoneOptionalstringseller zone
Seller Address Line 1OptionalstringThe main address line in an address.
Seller Address Line 2OptionalstringAn additional address line in an address that can be used to give further details supplementing the main line.
Seller Address Line 3OptionalstringSeller address line 3
Seller Postal CodeOptionalstringThe identifier for an addressable group of properties according to the relevant postal service.
Seller State/ProvinceOptionalstringThe subdivision of a country. Such as a region, a county, a state, a province etc..
Seller Business ActivityOptionalstringSeller business activity
Seller Contact EmailOptionalstringAn e-mail address for the contact point.
Seller Contact NameOptionalstringA contact point for a legal entity or person.
Seller Contact PhoneOptionalstringA phone number for the contact point.
Seller Industry Classification CodeOptionalstringIndustry classification code
Seller Industry Classification DescriptionOptionalstringIndustry classification description
Seller Industry Classification SchemeOptionalstringIndustry classification scheme
Seller Party IDOptionalstringSeller internal party ID
Seller Trade NameOptionalstringSeller trade name
Buyer CountryMandatorystringBuyer country code
Buyer NameMandatorystringBuyer company/name
Buyer Registration TypeMandatorystringBuyer registration type
Buyer Registration ValueMandatorystringAn identifier issued by an official registrar that identifies the Buyer as a legal entity or person.
Buyer Access Code BuildingOptionalstringbuyer access code building
Buyer Access Code GateOptionalstringbuyer access code gate
Buyer Access Code IntercomOptionalstringbuyer access code intercom
Buyer Address TypeOptionalstringbuyer address type
Buyer Address UsageOptionalstringbuyer address usage
Buyer ApartmentOptionalstringbuyer apartment
Buyer Attention ToOptionalstringbuyer attention to
Buyer Building NameOptionalstringbuyer building name
Buyer Building NumberOptionalstringBuyer building number
Buyer Business Hours CloseOptionalstringbuyer business hours close
Buyer Business Hours DaysOptionalarraybuyer business hours days
Buyer Business Hours OpenOptionalstringbuyer business hours open
Buyer Care OfOptionalstringbuyer care of
Buyer Delivery InstructionsOptionalstringbuyer delivery instructions
Buyer Delivery PointOptionalstringbuyer delivery point
Buyer DistrictOptionalstringBuyer district
Buyer FloorOptionalstringbuyer floor
Buyer Geo Location LatitudeOptionalnumberbuyer geo location latitude
Buyer Geo Location LongitudeOptionalnumberbuyer geo location longitude
Buyer LandmarkOptionalstringbuyer landmark
Buyer Plus CodeOptionalstringbuyer plus code
Buyer PO BoxOptionalstringbuyer po box
Buyer Post OfficeOptionalstringbuyer post office
Buyer Room NumberOptionalstringbuyer room number
Buyer Street NameOptionalstringbuyer street name
Buyer Street NumberOptionalstringbuyer street number
Buyer Sub DistrictOptionalstringbuyer sub district
Buyer Time ZoneOptionalstringbuyer time zone
Buyer Valid FromOptionaldatebuyer valid from
Buyer Valid ToOptionaldatebuyer valid to
Buyer Verification DateOptionaldatebuyer verification date
Buyer Verification SourceOptionalstringbuyer verification source
Buyer VerifiedOptionalstringbuyer verified
Buyer WardOptionalstringbuyer ward
Buyer What Three WordsOptionalstringbuyer what three words
Buyer ZoneOptionalstringbuyer zone
Buyer Address Line 1OptionalstringThe main address line in an address.
Buyer Address Line 2OptionalstringAn additional address line in an address that can be used to give further details supplementing the main line.
Buyer Address Line 3OptionalstringBuyer address line 3
Buyer CityOptionalstringThe common name of the city, town or village, where the Buyer’s address is located.
Buyer Postal CodeOptionalstringThe identifier for an addressable group of properties according to the relevant postal service.
Buyer State/ProvinceOptionalstringThe subdivision of a country. Such as a region, a county, a state, a province etc..
Buyer Business ActivityOptionalstringBuyer business activity
Buyer Contact EmailOptionalstringAn e-mail address for the contact point.
Buyer Contact NameOptionalstringA contact point for a legal entity or person.
Buyer Contact PhoneOptionalstringA phone number for the contact point.
Buyer Industry Classification CodeOptionalstringBuyer industry code
Buyer Industry Classification DescriptionOptionalstringBuyer industry description
Buyer Industry Classification SchemeOptionalstringBuyer industry scheme
Buyer Party IDOptionalstringBuyer internal party ID
Buyer Tax ID TypeOptionalstringThe scheme of the TAX identifier.
Buyer Tax ID ValueOptionalstringThe buyer’s tax identifier, such as a VAT number or TIN, of the type given in type.
Buyer Trade NameOptionalstringBuyer trade name
Delivery Access Code BuildingOptionalstringdelivery access code building
Delivery Access Code GateOptionalstringdelivery access code gate
Delivery Access Code IntercomOptionalstringdelivery access code intercom
Delivery Address TypeOptionalstringdelivery address type
Delivery Address UsageOptionalstringdelivery address usage
Delivery ApartmentOptionalstringdelivery apartment
Delivery Attention ToOptionalstringdelivery attention to
Delivery Building NameOptionalstringdelivery building name
Delivery Building NumberOptionalstringdelivery building number
Delivery Business Hours CloseOptionalstringdelivery business hours close
Delivery Business Hours DaysOptionalarraydelivery business hours days
Delivery Business Hours OpenOptionalstringdelivery business hours open
Delivery Care OfOptionalstringdelivery care of
Delivery Delivery InstructionsOptionalstringdelivery delivery instructions
Delivery Delivery PointOptionalstringdelivery delivery point
Delivery DistrictOptionalstringdelivery district
Delivery FloorOptionalstringdelivery floor
Delivery Geo Location LatitudeOptionalnumberdelivery geo location latitude
Delivery Geo Location LongitudeOptionalnumberdelivery geo location longitude
Delivery LandmarkOptionalstringdelivery landmark
Delivery Plus CodeOptionalstringdelivery plus code
Delivery PO BoxOptionalstringdelivery po box
Delivery Post OfficeOptionalstringdelivery post office
Delivery Room NumberOptionalstringdelivery room number
Delivery Street NameOptionalstringdelivery street name
Delivery Street NumberOptionalstringdelivery street number
Delivery Sub DistrictOptionalstringdelivery sub district
Delivery Time ZoneOptionalstringdelivery time zone
Delivery Valid FromOptionaldatedelivery valid from
Delivery Valid ToOptionaldatedelivery valid to
Delivery Verification DateOptionaldatedelivery verification date
Delivery Verification SourceOptionalstringdelivery verification source
Delivery VerifiedOptionalstringdelivery verified
Delivery WardOptionalstringdelivery ward
Delivery What Three WordsOptionalstringdelivery what three words
Delivery ZoneOptionalstringdelivery zone
Delivery Address Line 1OptionalstringThe main address line in an address.
Delivery Address Line 2OptionalstringAdditional delivery address line
Delivery Address Line 3OptionalstringThird delivery address line
Delivery CityOptionalstringThe common name of the city, town or village, where the deliver to address is located.
Delivery CountryOptionalstringA code that identifies the country.
Delivery Post CodeOptionalstringPostal code for delivery address
Delivery Country SubdivisionOptionalstringState, emirate or province for delivery address
Delivery Business ActivityOptionalstringDelivery business activity
Delivery Contact EmailOptionalstringDelivery contact email
Delivery Contact NameOptionalstringDelivery contact name
Delivery Contact PhoneOptionalstringDelivery contact phone
Actual Delivery DateOptionaldateActual delivery date
Actual Delivery TimeOptionalstringActual delivery time
Customs Declaration NumberOptionalstringcustoms declaration number
Destination PortOptionalstringDestination port
Export DateOptionaldateexport date
FreightOptionalstringfreight
Freight DocumentOptionalstringfreight document
IncotermsOptionalstringDelivery terms (Incoterms)
Origin PortOptionalstringOrigin port
Special TermsOptionalstringspecial terms
Transport ModeOptionalstringtransport mode
Delivery Industry Classification CodeOptionalstringDelivery industry classification code
Delivery Industry Classification DescriptionOptionalstringDelivery industry classification description
Delivery Industry Classification SchemeOptionalstringDelivery industry classification scheme
Delivery Party NameOptionalstringDelivery party name
Delivery Party IDOptionalstringIdentifier for delivery party
Delivery Peppol IDOptionalstringDelivery party's Peppol network identifier
Deliver to Legal Registration TypeOptionalstringType of registration for delivery party
Deliver to Legal RegistrationOptionalstringRegistration number for delivery party
Delivery Tax ID TypeOptionalstringDelivery tax ID type
Delivery Tax ID ValueOptionalstringDelivery tax ID value
Delivery Trade NameOptionalstringDelivery party trade name
Line Item IDMandatorystringLine item identifier
Line Item TotalMandatorynumberLine item total
Line Item NameMandatorystringLine item name/description
Item Net PriceMandatorynumberNet unit price excluding VAT.
Line Item QuantityMandatorynumberThe quantity of items (goods or services) that is charged in the Invoice line.
Line Item Tax AmountMandatorynumberTax amount for the line item, excluding the net line amount.
Line Item Unit CodeMandatorystringUnit code (PCE, KGM, etc.)
Buyer Item CodeOptionalstringBuyer item code
Commodity Classification CodeOptionalstringCommodity classification code
Commodity Classification DescriptionOptionalstringCommodity classification description
Commodity Classification SchemeOptionalstringThe identification scheme shall be chosen from the entries in UNTDID 7143 [6].
Commodity CodeOptionalstringTariff/commodity code
Country Of OriginOptionalstringThe code identifying the country from which the item originates.
Line Item DescriptionOptionalstringA description for an item.
Line Discount/Charge AmountOptionalnumberDiscount/Charge amount
Line Discount/Charge Base AmountOptionalnumberDiscount/Charge base amount
Line Discount/Charge IDOptionalstringDiscount/Charge ID
Line Discount/Charge is ChargeOptionalbooleanIs charge or discount
Line Discount/Charge PercentageOptionalnumberDiscount/Charge percentage
Line Discount/Charge ReasonOptionalstringDiscount/Charge reason
Line Discount/Charge Reason CodeOptionalstringDiscount/Charge reason code
Line Discount/Charge Tax AmountOptionalnumberDiscount/Charge tax amount
Line Discount/Charge Tax CategoryOptionalstringDiscount/Charge tax category
Line Discount/Charge Tax RateOptionalnumberDiscount/Charge tax rate
Line Taxable ValueOptionalnumberThe total amount of the Invoice line (before tax).
Line TypeOptionalstringLine type
Base QuantityOptionalnumberThe number of item units to which the price applies.
Base Quantity Unit CodeOptionalstringBase quantity unit code
Item Gross PriceOptionalnumberUnit price before a price-level discount, excluding VAT.
Line Related Document TypeOptionalstringRelated document type
Line Related Document IDOptionalstringRelated document ID
Seller Item CodeOptionalstringSeller item code
Standard Item Code IDOptionalstringAn item identifier based on a registered scheme.
Standard Item Code SchemeOptionalstringThe identification scheme identifier of the Item standard identifier.
Line Tax CategoryOptionalstringThe VAT category code for the invoiced item.
Tax Exemption ReasonOptionalstringA textual statement of the reason why the line amount is exempted from VAT or why no VAT is being charged.
Tax Exemption Reason CodeOptionalstringA coded statement of the reason for why the line amount is exempted from VAT.
Line Tax RateOptionalnumberThe VAT rate, represented as percentage that applies to the invoiced item.
Amount DueMandatorynumberThe outstanding amount that is requested to be paid.
Total Amount Excluding TaxMandatorynumberTotal excluding tax
Total Amount Including TaxMandatorynumberTotal including tax
Total Line Taxable AmountMandatorynumberSum of line taxable values
Total Tax AmountMandatorynumberTotal tax amount
Prepaid AmountOptionalnumberThe sum of amounts which have been paid in advance.
Rounding AmountOptionalnumberRounding adjustment
Total AllowancesOptionalnumberSum of all allowances on document level in the Invoice.
Total ChargesOptionalnumberSum of all charges on document level in the Invoice.
Invoice Discount/Charge AmountOptionalnumberAllowance/charge amount
Invoice Discount/Charge Base AmountOptionalnumberBase amount
Invoice Discount/Charge Line IDOptionalstringAllowance/Charge ID
Invoice-level Is ChargeOptionalbooleanCharge (true) or allowance (false)
Invoice Discount/Charge PercentageOptionalnumberPercent applied
Invoice Discount/Charge ReasonOptionalstringReason for allowance/charge
Invoice Discount/Charge Reason CodeOptionalstringReason code
Invoice Discount/Charge Tax AmountOptionalnumberTax amount
Invoice Discount/Charge Tax CategoryOptionalstringTax category
Invoice Discount/Charge Tax RateOptionalnumberTax rate
Payee Account IDConditionalstringA unique identifier of the financial payment account, at a payment service provider, to which payment should be made.
Card Holder NameOptionalstringCard holder name
Card NetworkOptionalstringCard network ID
Card PANOptionalstringCard primary account number
Payee Account NameOptionalstringThe name of the payment account, at a payment service provider, to which payment should be made.
Payee Institution BranchOptionalstringAn identifier for the payment service provider where a payment account is located.
Direct Debit Mandate Ref IDOptionalstringDirect debit mandate reference
Payer Financial AccountOptionalstringPayer financial account
Payment IDOptionalstringPayment identifier
Payment Means CodeOptionalstringHow the payment is made, as a UNTDID 4461 payment means code, for example 30 for a credit transfer or 10 for cash.
Payment Means TextOptionalstringPayment method description
Discount AmountOptionalnumberThe payment amount that these terms apply to. When relevant, the amount includes tax.
Discount Due DateOptionaldateDiscount due date
Payment Terms NoteOptionalstringA textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).
Penalty AmountOptionalnumberPenalty amount
Penalty PercentageOptionalnumberPenalty percent
Settlement Discount PercentageOptionalnumberSettlement discount percent
Attachment ChecksumOptionalstringAttachment checksum
Attachment ContentOptionalstringAttachment base64 content
Attachment Content URLOptionalstringAttachment content URL
Attachment DescriptionOptionalstringAttachment description
Attachment FilenameOptionalstringAttachment file name
Attachment Mime CodeOptionalstringA code identifying the file type.
Attachment SizeOptionalnumberAttachment size
Supporting Document DescriptionOptionalstringDescription of supporting document
Supporting Document TypeOptionalstringType of supporting document
Supporting Document IDOptionalstringSupporting document identifier
Supporting Document Issue DateOptionaldateSupporting document issue date
Supporting Document URLOptionalstringReference URL
Destination AuthorityOptionalstringDestination authority
Destination BodyOptionalstringEmail body
Destination CountryOptionalstringDestination country
Destination Document TypeOptionalstringDestination document type
Destination Participant IDOptionalstringPeppol participant ID
Destination RecipientsOptionalarrayEmail recipients
Destination SubjectOptionalstringEmail subject
Destination TypeOptionalstringDestination type for submission
Is B2BOptionalbooleanBusiness to Business flag
Is TestbedOptionalbooleanTestbed document flag
PurposeOptionalstringDocument purpose (e.g., testbed, e-invoicing, mapping)
ModeOptionalstringDocument processing mode
OperationOptionalstringDocument operation type
Source IDOptionalstringSource identifier
Source NameOptionalstringSource name
Source TypeOptionalstringSource type
Source VersionOptionalstringSource version
VersionOptionalstringDocument version