Create Invoice
Use this request to create invoices and credit notes.
Note
This request can be used in the following integrations:
- Standalone Vertex Invoice IQ
- Vertex O Series Cloud integrations
To use Vertex Invoice IQ to generate an invoice or credit note, use a POST method and the following URL:
{service_url}/invoiceiq/invoices
Where {service_url}
For example:
https://marketplace.taxamo.com/invoiceiq/invoices
Details
| Type | Value |
|---|---|
| Endpoint | /invoiceiq/invoices |
| Method | POST |
| API Reference Topic |
Fields
The fields uses are the same as those used by the Vertex O Series Cloud API. These are explained the Calculation API Fields topic in the Vertex O Series Cloud API documentation.
Example
{
"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"
}
}
Updated 4 days ago