We built a simple API to generate invoice PDFs programmatically, the same engine that powers our app. Whether you're automating your billing workflow or integrating invoicing into your own product, this API has you covered.
The API accepts invoice details and returns a ready-to-use PDF. We don't store any of your invoice data.
Beyond PDF, the API also supports generating e-invoices in UBL (Universal Business Language) with the invoice PDF embedded. As e-invoicing becomes the global standard, UBL compliance can be complex to implement, our API handles it for you.
Use Case
Whether you're automating your billing workflow or building invoicing into your own product, our API is flexible enough to handle a wide range of use cases:
Automate invoice generation from your own application or backend
Generate a PDF from invoice details you already have, recipient, line items, and more.
Produce invoices for B2B buyers from an order or receipt
Create invoices for VAT compliance
Sell products or services on credit terms
Create e-invoices in UBL (Universal Business Language)
Integrate invoicing into your existing billing workflow
Getting Started
Before making your first API request, you'll need an API key to authenticate your requests. Follow these steps to get one:
Click New API Key, and copy your key somewhere safe.
Include your API key in the Authorization header of every request
The free plan includes up to 100 invoices per month. If you need to generate more, upgrade to a paid API subscription. Paid plans come with higher limits and priority support.
PDF Invoice API
Use this to generate a professional invoice PDF from your invoice data. Pass in your sender details, client information, and line items, and get back a ready-to-download PDF.
Endpoints
POSThttps://hubinvo.com/api/generate-invoice
Headers
Authorization
string
Required
Bearer authentication header of the form Bearer api_key, where api_key is your api key.
Content type one of: application/json, application/x-www-form-urlencoded
Body
name
string
default:INVOICE
The title or heading displayed at the top of the invoice document.
currency
string
default:USD
The 3-letter ISO 4217 currency code (e.g. USD, EUR, IDR).
color
string
default:#65a30d
Hex color code used as the accent color for the invoice template.
template
string
default:clasic
The invoice template design to use. Must be one of: clasic
logoUrl
string
URL of the logo to display on the invoice. Must be a PNG or JPG image, max 5MB.
numberLabel
string
default:Number
Custom label for the invoice number field.
number
string
Required
The invoice number used to uniquely identify this invoice.
dateLabel
string
default:Date
Custom label for the invoice date field.
date
string
default:"currentDate"
The invoice issue date in yyyy-mm-dd format. Defaults to the current date if not provided.
dueDateLabel
string
default:Due Date
Custom label for the due date field.
dueDate
string
The payment due date in yyyy-mm-dd format.
fromLabel
string
default:From
Custom label for the sender section.
senderName
string
Required
Full name or company name of the invoice sender.
senderEmail
string
Email address of the invoice sender.
senderAddress
string
Mailing address of the invoice sender.
senderPhone
string
Phone number of the invoice sender.
senderWebsite
string
Website URL of the invoice sender.
billToLabel
string
default:Bill To
Custom label for the client details section.
clientName
string
Required
Full name or company name of the client being billed.
clientEmail
string
Email address of the client.
clientAddress
string
Mailing address of the client.
itemLabel
string
default:Item
Custom label for the item name column in the line items table.
rateLabel
string
default:Rate
Custom label for the rate column in the line items table.
quantityLabel
string
default:Quantity
Custom label for the quantity column in the line items table.
amountLabel
string
default:Amount
Custom label for the amount column in the line items table.
items
array<object>
Required
List of line items to include on the invoice. At least one item is required.
name
string
Required
Name or description of the line item.
rate
number
Required
Unit price of the item. Must be greater than 0.
quantity
number
Required
Quantity of the item. Must be greater than 0.
adjustments
array<object>
List of adjustments to apply to the invoice subtotal, such as taxes or discounts. Order affects calculation.
label
string
Required
Display name of the adjustment (e.g. "Tax", "Discount").
type
enum<percentage | flat>
Required
Whether the adjustment is a percentage of the subtotal or a fixed flat amount.
value
number
Required
The adjustment amount. Accepts positive and negative values. If type is percentage, this is treated as a percent (e.g. 10 = 10%). If type is flat, this is a fixed amount.
inclusive
boolean
Only applies when type is percentage. If true, the percentage is calculated as inclusive (already included in the item price) rather than added on top.
notesLabel
string
default:Notes
Custom label for the notes section.
notes
string
Additional notes or remarks to display at the bottom of the invoice.
termsLabel
string
default:Terms
Custom label for the terms section.
terms
string
Terms and conditions to display at the bottom of the invoice.
subtotalLabel
string
default:Subtotal
Custom label for the subtotal line.
totalLabel
string
default:Total
Custom label for the total line.
amoutPaidLabel
string
default:Amount Paid
Custom label for the amount paid line.
amountPaid
number
default:0
The amount already paid by the client. Must be greater than or equal to 0. Deducted from the total to calculate the balance due.
Use this to generate an e-invoice in UBL (Universal Business Language) XML format. Ideal for businesses that require machine-readable invoices for VAT compliance, B2B transactions, or PEPPOL network integration.
Endpoints
POSThttps://hubinvo.com/api/generate-invoice/ubl
Headers
Authorization
string
Required
Bearer authentication header of the form Bearer api_key, where api_key is your api key.
An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms. Learn more.
Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way. Learn more.
ID
string
Required
A unique identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used. Learn more.
issueDate
string
Required
The date when the Invoice was issued. Format "YYYY-MM-DD"
dueDate
string
The date when the payment is due.Format "YYYY-MM-DD". In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
invoiceTypeCode
number
Required
A code specifying the functional type of the Invoice. Learn more.
notes
array<object>
content
string
Required
languageID
string
taxPointDate
string
The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive. This element is required if the Value added tax point date is different from the Invoice issue date. Format "YYYY-MM-DD".
documentCurrencyCode
string
Required
The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency. Only one currency shall be used in the Invoice, except for the VAT accounting currency code (BT-6) and the invoice total VAT amount in accounting currency (BT-111). Example: USD, EUR, JPY, etc.
taxCurrencyCode
string
The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller. Shall be used in combination with the Invoice total VAT amount in accounting currency (BT-111), when the VAT accounting currency code differs from the Invoice currency code. Example: USD, EUR, JPY, etc.
accountingCost
string
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
buyerReference
string
An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference (BT-13).
invoicePeriod
string
A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period start date and/or end date must be used.
startDate
string
The date when the Invoice period starts. Format = "YYYY-MM-DD".
endDate
string
The date when the Invoice period ends. Format = "YYYY-MM-DD".
descriptionCode
string
The code of the date when the VAT becomes accountable for the Seller and for the Buyer. One of: 3, 35, or 432. Learn more.
orderReference
array<object>
Order and sales order reference
id
string
Required
An identifier of a referenced purchase order, issued by the Buyer. An invoice must have buyer reference (BT-10) or purchase order reference. In cases where sales order reference is provided, but there's no purchase order reference, then use value "NA" as this element is mandatory in UBL.
salesOrderId
string
An identifier of a referenced sales order, issued by the Seller. In cases where sales order reference is provided, but there's no purchase order reference, then set cac:OrderReference/cbc:ID to value "NA" as this element is mandatory in UBL.
billingReference
array<object>
A group of business terms providing information on one or more preceding Invoices.
invoiceDocReference
object
Required
Invoice document reference
id
string
Required
The identification of an Invoice that was previously sent by the Seller.
issueDate
string
The date when the Preceding Invoice was issued.Shall be provided in case the Preceding Invoice identifier is not unique. Format = "YYYY-MM-DD".
despatchDocumentReference
string
An identifier of a referenced despatch advice.
receiptDocumentReference
string
An identifier of a referenced receiving advice.
originatorDocumentReference
string
The identification of the call for tender or lot the invoice relates to.
contractDocumentReference
string
The identification of a contract.
additionalDocumentReference
array<object>
A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
id
string
Required
An identifier for an object on which the invoice is based, given by the Seller, or the identifier for the supporting document.
schemeID
string
The identification scheme identifier of the Invoiced object identifier. Learn more.
documentTypeCode
string
Code "130" MUST be used to indicate an invoice object reference. Not used for other additional documents.
documentDescription
string
A description of the supporting document, such as: timesheet, usage report etc.
attachment
object
A description of the supporting document, such as: timesheet, usage report etc.
embeddedDocumentBinaryObject
string
An attached document embedded as binary object (Base64) or sent together with the invoice.
mimeCode
string
The mime code of the attached document. Learn more.
filename
string
The file name of the attached document
externalReference
string
The URL (Uniform Resource Locator) that identifies where the external document is located. A means of locating the resource, including its primary access mechanism, e.g. http:// or ftp://.
projectReference
string
The identification of the project the invoice refers to.
seller
object
Required
A group of business terms providing information about the Seller.
endPoint
object
Required
scheme
string
Required
The identification scheme identifier of the Seller electronic address. Learn more.
id
string
Required
Identifies the Seller's electronic address to which the application level response to the invoice may be delivered.
identification
array<object>
scheme
string
The identification scheme identifier of the Seller identifier. For bank assigned creditor identifier (BT-90), value MUST be "SEPA". Learn more.
id
string
Required
name
string
A name by which the Seller is known, other than Seller name (also known as Business name).
address
object
Required
A group of business terms providing information about the address of the Seller. Sufficient components of the address are to be filled to comply with legal requirements.
streetName
string
The main address line in an address.
additionalStreetName
string
An additional address line in an address that can be used to give further details supplementing the main line.
cityName
string
The common name of the city, town or village, where the Seller address is located.
postalZone
string
The identifier for an addressable group of properties according to the relevant postal service.
countrySubentity
string
The subdivision of a country.
addressLine
string
An additional address line in an address that can be used to give further details supplementing the main line.
A name by which the Seller is known, other than Seller name (also known as Business name).
companyId
string
Required
The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller's address) of the Seller for tax purposes or a reference that enables the Seller to state his registered tax status. In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present
schemeID
string
Mandatory element. For Seller VAT identifier (BT-31), use value "VAT", for the seller tax registration identifier (BT-32), use != "VAT"
legalEntity
object
Required
A name by which the Seller is known, other than Seller name (also known as Business name).
registrationName
string
Required
The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.
legalForm
string
Additional legal information relevant for the Seller.
companyId
object
Additional legal information relevant for the Seller.
id
string
Required
An identifier issued by an official registrar that identifies the Seller as a legal entity or person. In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present
schemeID
string
The identification scheme identifier of the Seller legal registration identifier. Learn more.
contact
object
A group of business terms providing contact information about the Seller.
name
string
A contact point for a legal entity or person.
phone
string
A phone number for the contact point.
email
string
An e-mail address for the contact point.
buyer
object
Required
A group of business terms providing information about the Buyer.
endPoint
object
Required
scheme
string
Required
The identification scheme identifier of the Seller electronic address. Learn more.
id
string
Required
Identifies the Seller's electronic address to which the application level response to the invoice may be delivered.
identification
array<object>
scheme
string
The identification scheme identifier of the Seller identifier. For bank assigned creditor identifier (BT-90), value MUST be "SEPA". Learn more.
id
string
Required
name
string
A name by which the Seller is known, other than Seller name (also known as Business name).
address
object
Required
A group of business terms providing information about the address of the Seller. Sufficient components of the address are to be filled to comply with legal requirements.
streetName
string
The main address line in an address.
additionalStreetName
string
An additional address line in an address that can be used to give further details supplementing the main line.
cityName
string
The common name of the city, town or village, where the Seller address is located.
postalZone
string
The identifier for an addressable group of properties according to the relevant postal service.
countrySubentity
string
The subdivision of a country.
addressLine
string
An additional address line in an address that can be used to give further details supplementing the main line.
A name by which the Seller is known, other than Seller name (also known as Business name).
companyId
string
Required
The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller's address) of the Seller for tax purposes or a reference that enables the Seller to state his registered tax status. In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present
schemeID
string
Mandatory element. For Seller VAT identifier (BT-31), use value "VAT", for the seller tax registration identifier (BT-32), use != "VAT"
legalEntity
object
Required
A name by which the Seller is known, other than Seller name (also known as Business name).
registrationName
string
Required
The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.
legalForm
string
Additional legal information relevant for the Seller.
companyId
object
Additional legal information relevant for the Seller.
id
string
Required
An identifier issued by an official registrar that identifies the Seller as a legal entity or person. In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present
schemeID
string
The identification scheme identifier of the Seller legal registration identifier. Learn more.
contact
object
A group of business terms providing contact information about the Seller.
name
string
A contact point for a legal entity or person.
phone
string
A phone number for the contact point.
email
string
An e-mail address for the contact point.
payeeParty
object
A group of business terms providing information about the Payee, i.e. the role that receives the payment. Shall be used when the Payee is different from the Seller.
identification
object
id
string
Required
This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
schemeID
string
The identification scheme identifier of the payee identifier. For bank assigned creditor identifier (BT-90), value MUST be "SEPA" Learn more.
name
string
Required
The name of the Payee.
legalEntity
object
The name of the Payee.
companyId
object
id
string
Required
An identifier issued by an official registrar that identifies the Payee as a legal entity or person.
schemeID
string
The identification scheme identifier of the Payee legal registration identifier. Learn more.
taxRepresentativeParty
object
A group of business terms providing information about the Seller's tax representative.
name
string
Required
The full name of the Seller's tax representative party.
address
object
Required
A group of business terms providing information about the postal address for the tax representative party. Sufficient components of the address are to be filled to comply with legal requirements.
streetName
string
The main address line in an address.
additionalStreetName
string
An additional address line in an address that can be used to give further details supplementing the main line.
cityName
string
The common name of the city, town or village, where the Seller address is located.
postalZone
string
The identifier for an addressable group of properties according to the relevant postal service.
countrySubentity
string
The subdivision of a country.
addressLine
string
An additional address line in an address that can be used to give further details supplementing the main line.
The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller's address) of the Seller for tax purposes or a reference that enables the Seller to state his registered tax status. In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present
schemeID
string
Mandatory element. For Seller VAT identifier (BT-31), use value "VAT", for the seller tax registration identifier (BT-32), use != "VAT"
delivery
object
A group of business terms providing information about where and when the goods and services invoiced are delivered.
actualDeliveryDate
string
The date on which the supply of goods or services was made or completed. Format = "YYYY-MM-DD"
deliveryLocation
object
id
string
An identifier for the location at which the goods and services are delivered.
locationSchemeID
string
The identification scheme identifier of the Deliver to location identifier.
address
object
A group of business terms providing information about the address to which goods and services invoiced were or are delivered.
streetName
string
The main address line in an address.
additionalStreetName
string
An additional address line in an address that can be used to give further details supplementing the main line.
cityName
string
The common name of the city, town or village, where the Seller address is located.
postalZone
string
The identifier for an addressable group of properties according to the relevant postal service.
countrySubentity
string
The subdivision of a country.
addressLine
string
An additional address line in an address that can be used to give further details supplementing the main line.
The name of the party to which the goods and services are delivered.
paymentMeans
object
A group of business terms providing information about the payment.
code
string
The means, expressed as code, for how a payment is expected to be or has been settled. Learn more.
name
string
The means, expressed as text, for how a payment is expected to be or has been settled.
paymentDueDate
string
Format "YYYY-MM-DD".
paymentId
string
A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process.
financialAccount
object
A group of business terms to specify credit transfer payments.
id
string
A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. Such as IBAN or BBAN.
name
string
The name of the payment account, at a payment service provider, to which payment should be made.
financialInstitutionBranch
string
An identifier for the payment service provider where a payment account is located. Such as a BIC or a national clearing code where required. No identification scheme Identifier to be used.
cardAccount
object
A group of business terms providing information about card used for payment contemporaneous with invoice issuance.
primaryAccountNumberId
string
Required
The Primary Account Number (PAN) of the card used for payment.In accordance with card payments security standards, an invoice should never include a full card primary account number.
networkId
string
Required
Syntax required element not related to a business term.
holderName
string
The name of the payment card holder.
paymentMandate
object
A group of business terms to specify a direct debit.
id
string
Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit.
payerFinancialAccountId
string
The account to be debited by the direct debit.
paymentTermsNote
string
A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
allowanceCharge
array<object>
A group of business terms providing information about allowances applicable to the Invoice as a whole. A group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.
chargeIndicator
boolean
Required
Use “true” when informing about Charges and “false” when informing about Allowances.
reasonCode
string
The reason for the document level allowance or charge, expressed as a code. For allowances a subset of codelist UNCL5189 is to be used, and for charges codelist UNCL7161 applies. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason
reason
string
The reason for the document level allowance or charge, expressed as text. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason
multiplierFactorNumeric
number
The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance or charge amount. To state 20%, use value 20.
amount
number
currency
number
baseAmount
number
The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals
taxCategory
object
Required
categoryCode
string
Required
A coded identification of what VAT category applies to the document level allowance or charge. Learn more.
percent
number
The VAT rate, represented as percentage that applies for the relevant VAT category.
taxTotal
array<object>
When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.
taxAmount
number
Required
The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals
taxAmountCurrency
string
Required
Mandatory attribute, currency code.
subTotals
array<object>
Required
A group of business terms providing information about VAT breakdown by different categories, rates and exemption reasons
taxableAmount
number
Required
Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable). Must be rounded to maximum 2 decimals.
taxAmount
number
Required
The total VAT amount for a given VAT category. Must be rounded to maximum 2 decimals.
taxCategory
object
Required
categoryCode
string
Required
Coded identification of a VAT category. Learn more.
percent
number
The VAT rate, represented as percentage that applies for the relevant VAT category.
exemptionReason
string
A coded statement of the reason for why the amount is exempted from VAT.
exemptionReasonCode
string
A coded statement of the reason for why the amount is exempted from VAT. Learn more.
taxableAmountCurrency
string
Required
Mandatory attribute. Use BT-5 or BT-6. Currency code.
taxAmountCurrency
string
Required
Mandatory attribute. Use BT-5. Currency code
legalMonetaryTotal
object
Required
A group of business terms providing the monetary totals for the Invoice.
currency
string
Required
Mandatory attribute. Currency code
lineExtensionAmount
number
Required
Sum of all Invoice line net amounts in the Invoice. Must be rounded to maximum 2 decimals.
lineExtensionAmountCurrency
string
Currency code
taxExclusiveAmount
number
Required
The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals.
taxExclusiveAmountCurrency
string
Currency code
taxInclusiveAmount
number
Required
The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals.
taxInclusiveAmountCurrency
string
Currency code
payableAmount
number
Required
The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals.
payableAmountCurrency
string
Currency code
payableRoundingAmount
number
The amount to be added to the invoice total to round the amount to be paid. Must be rounded to maximum 2 decimals.
payableRoundingAmountCurrency
string
Currency code
prepaidAmount
number
The sum of amounts which have been paid in advance. Must be rounded to maximum 2 decimals.
prepaidAmountCurrency
string
Currency code
allowanceTotalAmount
number
Sum of all allowances on document level in the Invoice. Must be rounded to maximum 2 decimals.
allowanceTotalAmountCurrency
string
Currency code
chargeTotalAmount
number
Sum of all charges on document level in the Invoice. Must be rounded to maximum 2 decimals.
chargeTotalAmountCurrency
string
Currency code
invoiceLines
array<object>
Required
A group of business terms providing information on individual Invoice lines.
id
string
Required
A unique identifier for the individual line within the Invoice.
note
array<object>
A textual note that gives unstructured information that is relevant to the Invoice line.
content
string
Required
A textual note
languageID
string
Language code
invoicedQuantity
number
Required
The quantity of items (goods or services) that is charged in the Invoice line.
lineExtensionAmount
number
Required
The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes. Must be rounded to maximum 2 decimals.
accountingCost
string
A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
invoicePeriod
object
A group of business terms providing information about the period relevant for the Invoice line.
startDate
string
The date when the Invoice period for this Invoice line starts. Format ="YYYY-MM-DD"
endDate
string
The date when the Invoice period for this Invoice line ends. Format ="YYYY-MM-DD"
orderLineReference
string
An identifier for a referenced line within a purchase order, issued by the Buyer.
documentReference
object
id
string
Required
An identifier for an object on which the invoice line is based, given by the Seller.
documentTypeCode
string
Code "130" MUST be used to indicate an invoice object reference. Not used for other additional documents
lineAllowanceChargeSchema
array<object>
chargeIndicator
boolean
Required
Use “true” when informing about Charges and “false” when informing about Allowances
reasonCode
string
The reason for the line level allowance or charge, expressed as a code.
reason
string
The reason for the line level allowance or charge, expressed as text.
multiplierFactorNumeric
number
The percentage that may be used, in conjunction with the line level allowance base amount, to calculate the line level allowance or charge amount.
amount
number
Required
The amount of an allowance or a charge, without VAT. Must be rounded to maximum 2 decimals
currency
string
Currency code
baseAmount
number
The base amount that may be used, in conjunction with the line level allowance or charge percentage, to calculate the line level allowance or charge amount. Must be rounded to maximum 2 decimals
name
string
Required
A name for an item.
description
string
A description for an item.The item description allows for describing the item and its features in more detail than the Item name.
buyersItemIdentification
string
An identifier, assigned by the Buyer, for the item.
sellersItemIdentification
string
An identifier, assigned by the Seller, for the item.
standardItemIdentification
object
id
string
Required
An item identifier based on a registered scheme.
schemeID
string
Required
The identification scheme identifier of the Item standard identifier
originCountry
string
The code identifying the country from which the item originates.
commodityClassification
array<object>
The code identifying the country from which the item originates.
code
string
Required
A code for classifying the item by its type or nature.
listID
string
Required
The identification scheme identifier of the Item classification identifier
listVersionID
string
The identification scheme version identifier of the Item classification identifier
taxCategory
object
Required
categoryCode
string
Required
The VAT category code for the invoiced item.
percent
number
The VAT rate, represented as percentage that applies to the invoiced item.
additionalItemProperties
array<object>
The code identifying the country from which the item originates.
name
string
Required
The name of the attribute or property of the item.
value
number
Required
The value of the attribute or property of the item.
price
number
Required
currency
string
Required
Currency code
unitCode
string
Required
The unit of measure that applies to the Item price base quantity, must be the same as the unit code of the Invoiced/credited quantity.
baseQuantity
number
The number of item units to which the price applies.
priceAllowanceCharge
object
The number of item units to which the price applies.
amount
number
Required
The total discount subtracted from the Item gross price to calculate the Item net price.
currency
string
Currency code
baseAmount
number
The unit price, exclusive of VAT, before subtracting Item price discount, can not be negative
Have a question about the API, found a bug, or need help integrating? Visit our feedback portal to submit bug reports, ask questions, or request new features, we read every submission and do our best to help.