Create Invoice
Use this request to create invoices and credit notes.
This request generates tax-compliant digital invoices and credit notes for:
- Vertex O Series Cloud Online Commerce
- Standalone Vertex Invoice IQ
Use this endpoint to create invoice documents from transaction data, including seller and customer details, tax calculations, product information, and invoice customization settings.
The request uses the same transaction fields as the Vertex O Series Cloud API.
Details
| Endpoint | Method |
|---|---|
/invoiceiq/invoices | POST |
Request parameters
The parameters used by this request are the same as those used by the Vertex O Series Cloud API. For more information, see Calculation API Field References.
Sample request
{
"documentDate": "8463-58-29",
"transactionId": "string",
"customer": {
"customerName": "string",
"taxRegistrations": [
{
"taxRegistrationNumber": "string",
"taxRegistrationAdditionalId": "string",
"isoCountryCode": "string",
"mainDivision": "string",
"fiscalRepresentative": {
"businessName": "string",
"address": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"taxRegistrationNumber": "string"
},
"validationResult": {
"isValid": true
},
"taxRegistrationType": "VAT Registration"
}
],
"destination": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"administrativeDestination": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
}
},
"lineItems": [
{
"lineItemNumber": 0,
"lineItemDescription": "string",
"taxes": [
{
"calculatedTax": 0,
"effectiveRate": 0,
"jurisdiction": {
"jurisdictionType": "APO"
},
"imposition": {
"value": "string"
},
"buyerRegistrationId": "string",
"sellerRegistrationId": "string",
"taxLiabilityOwner": "MARKETPLACE"
}
],
"customer": {
"customerName": "string",
"taxRegistrations": [
{
"taxRegistrationNumber": "string",
"taxRegistrationAdditionalId": "string",
"isoCountryCode": "string",
"mainDivision": "string",
"fiscalRepresentative": {
"businessName": "string",
"address": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"taxRegistrationNumber": "string"
},
"validationResult": {
"isValid": true
},
"taxRegistrationType": "VAT Registration"
}
],
"destination": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"administrativeDestination": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
}
},
"product": {
"productClass": "string",
"value": "string"
},
"lineItemId": "string",
"extendedPrice": 0,
"quantity": {
"unitOfMeasure": "str",
"value": 0
},
"unitPrice": 0,
"seller": {
"physicalOrigin": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"department": "string",
"division": "string",
"businessName": "string",
"administrativeOrigin": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"invoicing": {
"invoiceCustomization": {
"invoiceCustomizationCode": "string",
"invoiceDeliveryEmailFromAddress": "string",
"invoiceDeliveryReplyToAddress": "string",
"invoiceEmailSubject": "string",
"refundNoteEmailSubject": "string",
"invoiceLogoUrl": "http://uZ%6Io",
"invoiceFooterText": "string"
},
"invoiceSignatureUrl": "https://ZPsK^`iH>Nf",
"invoiceNumberFormat": "string"
},
"marketplace": {
"invoicing": {
"invoiceCustomization": {
"invoiceCustomizationCode": "string"
}
}
},
"taxRegistrations": [
{
"taxRegistrationNumber": "string",
"taxRegistrationAdditionalId": "string",
"isoCountryCode": "string",
"mainDivision": "string",
"fiscalRepresentative": {
"businessName": "string",
"address": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"taxRegistrationNumber": "string"
},
"validationResult": {
"isValid": true
},
"taxRegistrationType": "VAT Registration"
}
],
"company": "string"
},
"totalTax": 0
}
],
"currency": {
"isoCurrencyCodeAlpha": "MXF",
"isoCurrencyCodeNum": 999,
"isoCurrencyName": "string"
},
"taxPointDate": "2918-67-93",
"paymentDate": "0884-95-37",
"originalTransactionId": "string",
"seller": {
"physicalOrigin": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"department": "string",
"division": "string",
"businessName": "string",
"administrativeOrigin": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"invoicing": {
"invoiceCustomization": {
"invoiceCustomizationCode": "string",
"invoiceDeliveryEmailFromAddress": "string",
"invoiceDeliveryReplyToAddress": "string",
"invoiceEmailSubject": "string",
"refundNoteEmailSubject": "string",
"invoiceLogoUrl": "http://8D6dfu^L8n:;d<Z(hYs30uhU6IzM3^HU=BU*d",
"invoiceFooterText": "string"
},
"invoiceSignatureUrl": "https://D70Ih?xh%\\ULN(]N2'+9L`r?#du.J6XSTa<Scw48sUQ2bd_>#)#YHSWzC[G2",
"invoiceNumberFormat": "string"
},
"marketplace": {
"invoicing": {
"invoiceCustomization": {
"invoiceCustomizationCode": "string"
}
}
},
"taxRegistrations": [
{
"taxRegistrationNumber": "string",
"taxRegistrationAdditionalId": "string",
"isoCountryCode": "string",
"mainDivision": "string",
"fiscalRepresentative": {
"businessName": "string",
"address": {
"streetAddress1": "string",
"city": "string",
"postalCode": "string",
"streetAddress2": "string",
"mainDivision": "string",
"subDivision": "string",
"country": "string",
"taxAreaId": "string"
},
"taxRegistrationNumber": "string"
},
"validationResult": {
"isValid": true
},
"taxRegistrationType": "VAT Registration"
}
],
"company": "string"
}
}