The Invoice generator API includes 2 services:
- Document creation
- Document re-generation
REQUIREMENTS
|
Method |
POST |
|
Authorization |
Basic base64 (‘login:password’)
For example: Authorization: Basic dGVzdDp0ZXN0 |
|
Character encoding |
UTF-8 |
|
HiPay Enterprise credentials |
Private |
|
Request body |
JSON |
|
Response format |
JSON |
DOCUMENT CREATION
Service endpoints
There are two endpoints (base URLs) to which you can make your API calls:
- Stage, if you are testing your integration,
- and Production, when you have finished testing and want your application to go live.
| Environment | Endpoint |
|---|---|
|
Stage |
https://stage-api.hipay-tpp.com/document |
|
Production |
https://api.hipay-tpp.com/document |
To create an invoice, you must send these 4 mandatory parameters in your Document creation request:
- file_destination
- layout_reference
- document_name
- reference_value
Please note: the “file_destination” parameter enables you to choose the document destination:
- “sftp”
- or “binary”
- or “sftp|binary”
Request example
{
"layout_reference": "My_Layout_8",
"document_name": "Invoice_245876",
"sending": {
"file_destination": "binary"
},
"document": {
"information": {
"label": "General information",
"type_label": "Document type",
"type_value": "Invoice",
"reference_label": "Reference",
"reference_value": "INV_P_2018_07_11_MCHx_Shop_01",
"date_label_1": "Printing date",
"date_value_1": "04/07/2018",
"date_label_2": "Processing date",
"date_value_2": "03/07/2018"
},
"header": {
"logo_1": "Image1_MerchantX_64-64.png",
"page_number": {
"display": true,
"prefix_label": "Page number:"
},
"description_1": "ABC COMPANY, the leader in its field",
"description_2": "30 locations worldwide"
},
"page_header": {
"display_on_first_page": true,
"logo_1": "Image4_MerchantA_64-64.png",
"logo_2": null,
"logo_3": null,
"page_number": {
"display": false
},
"description_1": "ABC COMPANY",
"description_2": "Confidential"
},
"order_information": {
"label": "Order information",
"reference_label_1": "Customer reference",
"reference_value_1": "XA34",
"reference_label_2": "Merchant reference",
"reference_value_2": "MCH37",
"date_label": "Order date",
"date_value": "02/07/2018",
"total_ht_label": "Excl. tax amount",
"total_ht_value": "€100",
"total_vat_label": "Tax amount",
"total_vat_value": "€20",
"total_ttc_label": "Incl. tax amount",
"total_ttc_value": "€120"
},
"customer_information": {
"label": "Account information",
"type_label": "Offer",
"type_value": "Premium",
"reference_label": "ID",
"reference_value": "12345"
},
"customer_communication": {
"label_1": "Special offer",
"value_1": "10% discount between 01/03/2018 and 15/03/2018",
"label_2": "Important information",
"value_2": "From 20/05/2018, shipping fees will be applicable for all orders under €5."
},
"payment_instruction": {
"label": "Payment instructions",
"payment_term_label": "Payment conditions:",
"payment_term_value": "30 days from reception",
"payment_method_label": "Payment method",
"payment_method_value": "Transfer on IBAN",
"total_to_pay_label": "Amount to be paid",
"total_to_pay_value": "120 EUR",
"due_date_label": "To be paid before:",
"due_date_value": "31/05/2018",
"iban_label": "IBAN:",
"iban_value": "FR 32 5000 4699XXXX89",
"bic_label": "SWIFT/BIC code:",
"bic_value": "XXXXIE2D"
},
"sender": {
"label_1": "Sender information",
"label_2": "Administrative information",
"company_name": "ABC COMPANY",
"address_1": "123 Main Street",
"address_2": "City",
"address_3": "Postal code",
"address_4": "COUNTRY",
"address_5": null,
"registration_number": "1234 5678 9",
"contact_name": "Contact @ ABC Company: John DOE",
"email": "Email: john@abccompany.fr",
"tel_number_1": "Phone number: XXX-XXX-XXXX",
"tel_number_2": null,
"website": "http://www.abc.company.fr",
"additional_information_1": "Twitter ID: @abccompany",
"additional_information_2": null
},
"on_behalf_of": {
"label_1": "OBO information",
"label_2": "Administrative information",
"company_name": "OBO company",
"address_1": "123 Main Street",
"address_2": "POSTAL CODE CITY",
"address_3": "COUNTRY",
"share_capital": "Share capital of X,XXX,XXX.XX euros",
"legal_form": "SAS",
"rcs": "RCS Paris 123 456 789",
"vat_identification_number": "Intracommunity VAT: FR91 123 456 789",
"national_registration_id_1": "SIREN: 123 456 789",
"national_registration_id_2": "SIRET: 123 456 789 000 06",
"contact_name": "Jane DOE",
"email": "jane.doe@obocompany.fr",
"tel_number_1": "Main number: 01 23 45 67 89",
"tel_number_2": null,
"website": "www.obocompany.fr",
"additional_information_1": null,
"additional_information_2": null
},
"recipient": {
"general": {
"label_1": "Customer information",
"label_2": "Detailed information",
"company_name": "Company XYZ",
"civility": "Ms.",
"first_name": "Jane",
"last_name": "DOE",
"address_1": "2 Anystreet",
"address_2": "POSTAL CODE CITY",
"address_3": "COUNTRY",
"address_4": null,
"address_5": null,
"registration_number": null,
"share_capital": "Share capital of X,XXX,XXX.XX euros",
"legal_form": "LLC",
"rcs": "RCS Paris 234 567 890",
"vat_identification_number": "Intracommunity VAT: FR91 234 567 890",
"national_registration_id_1": "SIREN: 234 567 890",
"national_registration_id_2": "SIRET: 234 567 890 000 06",
"contact_name": "Ms. Jane DOE",
"email": "janedoe@gmail.com",
"tel_number_1": "01 23 45 67 89",
"tel_number_2": null,
"website": "www.companyxyz.fr",
"additional_information_1": null,
"additional_information_2": null
},
"billing": {
"label_1": "Customer information",
"label_2": "Billing information",
"company_name": "Sohenso Corporation",
"civility": "Mr",
"first_name": "Joe",
"last_name": "SOHENSO",
"address_1": "3 Anystreet",
"address_2": "POSTAL CODE CITY",
"address_3": "COUNTRY",
"registration_number": null,
"share_capital": "Share capital of X,XXX,XXX.XX euros",
"legal_form": "SAS",
"rcs": "RCS Paris 345 678 901",
"vat_identification_number": "Intracommunity VAT: FR91 345 678 901",
"national_registration_id_1": "SIREN: 345 678 901",
"national_registration_id_2": "SIRET: 345 678 901 000 06",
"contact_name": "Mr Joe SOHENSO",
"email": "joesohenso@gmail.com",
"tel_number_1": "01 23 45 67 89",
"tel_number_2": null,
"website": null,
"additional_information_1": null,
"additional_information_2": null
},
"shipping": {
"label_1": "Customer information",
"label_2": "Shipping information",
"company_name": "Sohenso Corporation",
"civility": "Ms.",
"first_name": "Jane",
"last_name": "SOHENSO",
"address_1": "2 Anystreet",
"address_2": "Building 3C",
"address_3": "POSTAL CODE CITY",
"address_4": "COUNTRY",
"registration_number": null,
"share_capital": "Share capital of X,XXX,XXX.XX euros",
"legal_form": "LLC",
"rcs": "RCS Paris 234 567 890",
"vat_identification_number": "Intracommunity VAT: FR91 234 567 890",
"national_registration_id_1": "SIREN: 234 567 890",
"national_registration_id_2": "SIRET: 234 567 890 000 06",
"contact_name": "Ms. Ann HAGRAM",
"tel_number_1": "01 23 45 67 89"
}
},
"shipping_precisions": {
"label": "Shipping detailed information",
"shipping_mode_label": "Mode:",
"shipping_mode_value": "DHL express",
"delivery_area_label": "Zone:",
"delivery_area_value": "Europe",
"volume_label": "Volume:",
"volume_value": "< 1 cubic meter",
"weight_label": "Weight:",
"weight_value": "< 5 kg",
"packages_number_label": "Number of packages:",
"packages_number_value": "1"
},
"summary": {
"label": "Summary of amounts",
"header": ["Title", "Excl. Tax Amount", "Tax Amount", "Incl. Tax Amount"],
"values": [{
"lineType": "default",
"data": ["Product1", "50 EUR", "10 EUR", "60 EUR"]
},
{
"lineType": "default",
"data": ["Product2", "50 EUR", "10 EUR", "60 EUR"]
},
{
"lineType": "default",
"data": ["Total", "100 EUR", "20 EUR", "120 EUR"]
}
]
},
"items": {
"label": "Product details",
"header": ["Title", "Reference", "Quantity", "Excl. Tax Amount"],
"values": [{
"lineType": "default",
"data": ["Product1", "T2E11", "1", "50.00 EUR"]
},
{
"lineType": "default",
"data": ["Product2", "L9R13", "1", "50.00 EUR"]
},
{
"lineType": "Total",
"data": ["Total amount", " ", " ", "100.00 EUR"]
}
]
},
"invoice_summary": {
"label": "Summary table",
"header": ["Total Excl. Tax Amount", "Total Tax Amount", "Total Incl. Tax Amount"],
"values": [{
"lineType": "default",
"data": ["100 EUR", "20 EUR", "120 EUR"]
}]
},
"custom_items": {
"label": "Detail of taxes and social contributions",
"header": ["Excl. Tax Amount including :"],
"values": [{
"lineType": "default",
"data": ["Social tax : 2.20 EUR"]
},
{
"lineType": "default",
"data": ["Other tax : 1.50 EUR"]
}
]
},
"page_footer": {
"logo_1": null,
"logo_2": null,
"logo_3": null,
"page_number": {
"display": false,
"prefix_label": "Page"
},
"description_1": "ABC COMPANY 123\n Main Street\n City \n Postal code\n COUNTRY",
"description_2": "Payment conditions and terms of sale\n\nLate payment: late payment penalties shall apply. Minimum annual interest rate (3.03%)\nfixed by law plus a €40 flat-rate compensation."
}
}
}
Response status codes
Here is the list of return codes:
|
CODE |
DESCRIPTION |
|
|
201 |
Created |
The document has been created and
|
|
400 |
Bad Request |
Invalid data, creation error or sending error |
|
403 |
Forbidden |
Access denied: invalid credentials or insufficient permissions |
|
404 |
Not found |
The layout reference has not been found |
|
409 |
Conflict |
The document reference already exists or a document has already been created with the same data |
In case of a 400, 403 or 409 response, the document is not created.
DOCUMENT RE-GENERATION
Invoices can be re-generated within 60 days upon document creation.
Service endpoints
The {reference} of the document you want to re-generate must be specified in the endpoint URL.
It must correspond to the mandatory field “reference_value” sent in the Document creation request.
| Environment | Endpoint |
|---|---|
|
Stage |
https://stage-api.hipay-tpp.com/document/{reference}/regenerate |
|
Production |
https://api.hipay-tpp.com/document/{reference}/regenerate |
If you call the API Production endpoint to re-generate a document created through the API Stage endpoint, the API will return a 404 response code (reference not found).
You can choose if the re-generated document keeps its “document_name” (by default) or you can change it.
Request example
{
"document_name": "New document name", /* complementary parameter */
"sending" : {
"file_destination": "binary" /* sftp and/or binary */
}
}
Response status codes
Here is the list of return codes:
|
CODE |
DESCRIPTION |
|
|
200 |
Ok |
The document has been re-generated and
|
|
400 |
Bad Request |
Invalid data, re-generation error or sending error |
|
403 |
Forbidden |
Access denied: invalid credentials or insufficient permissions |
|
404 |
Not found |
The document reference has not been found |
In case of a 400, 403 or 404 response, the document is not re-generated.
POSSIBLE ERROR RETURNS
Invalid JSON
Description: Received data do not seem to be in JSON or JSON input is invalid.
Return code: 400
Response example:
{
"document_reference" : null,
"document_name" : null,
"layout_reference" : null,
"file_destination" : null,
"generation_status" : "FAILURE",
"generation_error_code" : "INVALID_JSON",
"generation_error_message" : "Provided data must be in valid JSON format.",
"generation_error_details" : null
}
Description: Some required information is missing or invalid in the provided data.
Return code: 400
Response example:
{
"document_reference" : "INV_2081200001",
"document_name" : "inv@l!d nam€",
"layout_reference" : "My_Layout_8",
"file_destination" : "binary",
"generation_status" : "FAILURE",
"generation_error_code" : "MISSING_OR_INVALID_REQUIRED_FIELD",
"generation_error_message" : "Missing or invalid required field",
"generation_error_details" : [
{
"property" : "document_name",
"message" : "Does not match the regex pattern ^{a-zA-Z0-9._-}*$"
},
{
"property" : "document.information",
"message" : "The property information is required"
}
]
}The “generation_error_details” field will vary depending on the provided data. Its format will remain the same and consists of an array of the errors in received data.
Each array item is an object containing two properties represented by the following keys:
- “property”: name of the field containing errors
- “message”: error message associated with the field
List of possible errors:
|
Error message |
Meaning |
|
The property #PROPERTY_NAME# is required |
The field is required. |
|
Does not match the regex pattern ^{a-zA-Z0-9._-}*$ |
The field does not comply with the preset format. It can only contain the following elements: - alphanumeric characters - periods (“.”) - underscores (“_”) - hyphens (“-”) |
File download not enabled
Description: The “File download” option has not been enabled on your account.
Return code: 403
Response example:
{
"document_reference" : "INV_2081200001",
"document_name" : "My_Custom_doc_name",
"layout_reference" : "My_Layout_8",
"file_destination" : "sftp",
"generation_status" : "FAILURE",
"generation_error_code" : "FILE_DOWNLOAD_NOT_ENABLED",
"generation_error_message" : "File download is not activated on your account. Please ask the HiPay team to enable it.",
"generation_error_details" : null
}Layout not found
Description: The selected layout does not exist.
Return code: 404
Response example:
{
"document_reference" : "INV_2081200001",
"document_name" : "My_Custom_doc_name",
"layout_reference" : "My_Layout_100",
"file_destination" : "sftp",
"generation_status" : "FAILURE",
"generation_error_code" : "LAYOUT_NOT_FOUND",
"generation_error_message" : "Layout not found",
"generation_error_details" : "Layout reference \"My_Layout_100\" does not exist"
}
Invalid document data
Description: Document data contain errors.
Return code: 400
Response example:
{
"document_reference" : "INV_2081200001",
"document_name" : "My_Custom_doc_name",
"layout_reference" : "My_Layout_8",
"file_destination" : "sftp",
"generation_status" : "FAILURE",
"generation_error_code" : "INVALID_DOCUMENT_DATA",
"generation_error_message" : "Invalid document data",
"generation_error_details" : [
{
"property" : "items.values",
"message" : "NULL value found, but an array is required"
},
{
"property" : "",
"message" : "The property customs_azerty is not defined and the definition does not allow additional properties"
},
{
"property" : "order_information.reference_value_1",
"message" : "The property reference_value_1 is required"
},
{
"property" : "summary",
"message" : "The property summary is required"
}
]
}The “generation_error_details” field will vary depending on the provided data. Its format will remain the same and consists of an array of the errors in received data.
Each array item is an object containing two properties represented by the following keys:
- “property”: name of the field containing errors
- “message”: error message associated with the field
List of possible errors:
|
Error message |
Meaning |
|
The property #PROPERTY_NAME# is required |
The field is mandatory. |
|
The property #PROPERTY_NAME# is not defined and the definition does not allow additional properties |
The property does not exist; additional properties are not allowed. |
|
#INVALID_TYPE# value found, but a #VALID_TYPE# is required
#INVALID_TYPE# value found, but a #VALID_TYPE# or a #VALID_TYPE# is required |
The field does not comply with the preset data type.
List of possible valid types: - Null - String - Integer - Boolean - Object - Array |
|
The image #IMAGE_NAME# is not defined |
The image does not exist. |
List of possible errors for an invoice layout:
|
Error message |
Meaning |
|
Missing #NUMBER# value(s), header is defined with #NUMBER# column(s) |
Some data are missing in the array compared to what is defined in the array header. |
|
Found #NUMBER# value(s), header is defined with #NUMBER# column(s) |
There are too many data in the array compared to what is defined in the array header. |
|
Missing #NUMBER# value(s), maximum number of columns defined is #NUMBER# value(s) |
Header columns have not been defined for the array. Some data are missing in the array compared to the row of data with the most values.
|
Document with same data already exists
Description: A document with the same data already exists.
Return code: 409
Response example:
{
"document_reference" : "INV_2081200001",
"document_name" : "My_Custom_doc_name",
"layout_reference" : "My_Layout_8",
"file_destination" : "binary",
"generation_status" : "FAILURE",
"generation_error_code" : "DOCUMENT_WITH_SAME_DATA_ALREADY_EXISTS",
"generation_error_message" : "Document with same data already exists",
"generation_error_details" : null
}REQUIRED INFORMATION FOR INVOICE LAYOUT
To generate invoices through our API, merchants must provide us beforehand with:
- a document (e.g.: in Excel or Word format) indicating all the fields (with their exact name and position in the layout) they want to appear on API generated invoices;
- an actual invoice, with all the formatting to replicate on API generated invoices.
FULL LIST OF REQUEST PARAMETERS
|
Format abbreviation |
Description |
|
AN |
Alphanumeric characters |
| B |
Boolean |
|
N |
Numeric characters only |
|
JSON |
JavaScript Object Notation |
|
DOCUMENT CREATION |
|||||||
|
Field name |
Format |
Allowed value |
Mandatory |
Description |
Example |
||
|
Level 1 |
Level 2 |
Level 3 |
|||||
|
sending |
file_destination |
AN |
sftp |
YES |
To choose if the document: |
sftp|binary | |
|
layout_reference |
AN |
YES |
To choose the layout of the document |
My_Layout_8 | |||
|
document_name |
AN |
YES |
Name that will be given to the document file |
Invoice_123456 |
|||
|
document_header |
logo_1 |
AN |
Name of the image file 1 stored on HiPay’s server to be displayed in the document header |
Image_MerchantX_64-64 |
|||
|
logo_2 |
AN |
Name of the image file 2 stored on HiPay’s server to be displayed in the document header |
|||||
|
logo_3 |
AN |
Name of the image file 3 stored on HiPay’s server to be displayed in the document header |
|||||
|
page_number |
display |
B |
True |
True to activate the pagination display in the document header |
True | ||
|
prefix_label |
AN |
Prefix before pagination |
Page number: |
||||
|
description_1 |
AN |
Free description in document header |
ABC COMPANY, the leader in its field | ||||
|
description_2 |
AN |
Free description in document header |
30 locations worldwide | ||||
|
page_header |
logo_1 |
AN |
Name of the image file 1 stored on HiPay’s server to be displayed in the page header (Every field of the page header block will be displayed on every page of the document, or on every page except the first one if you set "display_on_first_page" = False) |
Image4_MerchantA_64-64 | |||
|
logo_2 |
AN |
Name of the image file 2 stored on HiPay’s server to be displayed in the page header |
|||||
|
logo_3 |
AN |
Name of the image file 3 stored on HiPay’s server to be displayed in the page header |
|||||
|
page_number |
display |
B |
True |
True to activate the pagination display in the page header |
False | ||
|
prefix_label |
AN |
Prefix before pagination |
|||||
|
description_1 |
AN |
Free description in page header |
ABC COMPANY | ||||
|
description_2 |
AN |
Free description in page header |
Confidential | ||||
|
display_on_first_page |
B |
True |
To choose if you want to display or not pagination on first page |
False | |||
|
order_information |
label |
AN |
Main label of the order information |
Order information |
|||
|
reference_label_1 |
AN |
1st secondary label of the order information |
Customer reference |
||||
|
reference_value_1 |
AN |
Value for the 1st secondary label of the order information |
XA34 |
||||
|
reference_label_2 |
AN |
2nd secondary label of the order information |
Merchant reference |
||||
|
reference_value_2 |
AN |
Value for the 2nd secondary label of the order information |
MCH37 |
||||
|
date_label |
AN |
Date of the order information |
Order date |
||||
|
date_value |
AN |
Value for the date of the order |
02/07/2018 |
||||
|
total_ht_label |
AN |
Label for the amount of the order excluding taxes |
Excl. tax amount |
||||
|
total_ht_value |
AN |
Value for the amount of the order excluding taxes |
€100 |
||||
|
total_vat_label |
AN |
Label for the tax amount of the order |
Tax amount |
||||
|
total_vat_value |
AN |
Value for the tax amount of the order |
€20 |
||||
|
total_ttc_label |
AN |
Label for the amount of the order including taxes |
Incl. tax amount |
||||
|
total_ttc_value |
AN |
Value for the amount of the order including taxes |
€120 |
||||
|
information |
label |
AN |
Main label of the document information block |
General information |
|||
|
type_label |
AN |
Name of the category of the document |
Document type |
||||
|
type_value |
AN |
Number or reference for the category of the document |
Invoice |
||||
|
reference_label |
AN |
Label for the reference field |
Reference | ||||
|
reference_value |
AN |
YES |
Value for the reference field |
INV_P_2018_07_11_MCHx_Shop_01 |
|||
|
document_date_label_1 |
AN |
Label for the 1st date field |
Printing date |
||||
|
document_date_value_1 |
AN |
Value for the 1st date field |
04/07/2018 |
||||
|
document_date_label_2 |
AN |
Label for the 2nd date field |
Processing date |
||||
|
document_date_value_2 |
AN |
Value for the 2nd date field |
03/07/2018 |
||||
|
customer_information |
label |
AN |
Main label of the customer information |
Account information | |||
|
type_label |
AN |
1st secondary label of the customer information |
Offer | ||||
|
type_value |
AN |
Value for the 1st secondary label of the customer information |
Premium | ||||
|
reference_label |
AN |
Label for the reference field |
ID | ||||
|
reference_value |
AN |
Value for the reference field |
12345 | ||||
|
customer_communication |
label_1 |
AN |
Label for the 1st customer communication field |
Special offer |
|||
|
value_1 |
AN |
Value for the 1st customer communication field |
10% discount between 01/03/2018 and 15/03/2018 |
||||
|
label_2 |
AN |
Label for the 2nd customer communication field |
Important information |
||||
|
value_2 |
AN |
Value for the 2nd customer communication field |
From 20/05/2018, shipping fees will be applicable for all orders under €5. |
||||
|
sender |
label_1 |
AN |
Main label of the sender information block |
Sender information | |||
|
label_2 |
AN |
Secondary label of the sender information block |
Administrative information | ||||
|
company_name |
AN |
Name of the sender company |
ABC COMPANY | ||||
|
address_1 |
AN |
1st line of the sender company address |
123 Main Street | ||||
|
address_2 |
AN |
2nd line of the sender company address |
CITY | ||||
|
address_3 |
AN |
3rd line of the sender company address |
POSTAL CODE | ||||
|
address_4 |
AN |
4th line of the sender company address |
COUNTRY | ||||
|
address_5 |
AN |
5th line of the sender company address |
|||||
|
registration_number |
AN |
Registration number of the sender company |
1234 5678 9 | ||||
|
share_capital |
AN |
Share capital of the sender company |
|||||
|
legal_form |
AN |
Legal form of the sender company |
|||||
|
rcs |
AN |
RCS (Trade and Companies Register) number of the sender company |
|||||
|
vat_identification_number |
AN |
VAT identification number of the sender company |
|||||
|
national_registration_id_1 |
AN |
1st national registration ID of the sender company |
|
||||
|
national_registration_id_2 |
AN |
2nd national registration ID of the sender company |
|
||||
|
contact_name |
AN |
Name of the person to contact within the sender company |
Contact @ ABC Company: John DOE | ||||
|
|
AN |
Email of the person to contact within the sender company |
Email: john@abccompany.fr | ||||
|
tel_number_1 |
AN |
1st telephone number of the person to contact within the sender company |
Phone number: XXX-XXX-XXXX |
||||
|
tel_number_2 |
AN |
2nd telephone number of the person to contact within the sender company |
|||||
|
website |
AN |
Website of the sender company |
http://www.abc.company.fr | ||||
|
additional_information_1 |
AN |
Free field 1 for additional information about the sender company |
Twitter ID: @abccompany | ||||
|
additional_information_2 |
AN |
Free field 2 for additional information about the sender company |
|||||
|
on_behalf_of |
label_1 |
AN |
Main label of the OBO information block |
OBO information | |||
|
label_2 |
AN |
Secondary label of the OBO information block |
Administrative information | ||||
|
company_name |
AN |
Name of the OBO company |
OBO company | ||||
|
address_1 |
AN |
1st line of the OBO company address |
123 Main Street | ||||
|
address_2 |
AN |
2nd line of the OBO company address |
POSTAL CODE CITY |
||||
|
address_3 |
AN |
3rd line of the OBO company address |
COUNTRY | ||||
|
address_4 |
AN |
4th line of the OBO company address |
|||||
|
address_5 |
AN |
5th line of the OBO company address |
|||||
|
registration_number |
AN |
Registration number of the OBO company |
|||||
|
share_capital |
AN |
Share capital of the OBO company |
Share capital of X,XXX,XXX.XX euros | ||||
|
legal_form |
AN |
Legal form of the OBO company |
SAS | ||||
|
rcs |
AN |
RCS (Trade and Companies Register) number of the OBO company |
RCS Paris 123 456 789 | ||||
|
vat_identification_number |
AN |
VAT identification number of the OBO company |
Intracommunity VAT: FR91 123 456 789 |
||||
|
national_registration_id_1 |
AN |
1st national registration ID of the OBO company |
SIREN: 123 456 789 | ||||
|
national_registration_id_2 |
AN |
2nd national registration ID of the OBO company |
SIRET: 123 456 789 000 06 | ||||
|
contact_name |
AN |
Name of the person to contact within the OBO company |
Jane DOE | ||||
|
|
AN |
Email of the person to contact within the OBO company |
jane.doe@obocompany.fr | ||||
|
tel_number_1 |
AN |
1st telephone number of the person to contact within the OBO company |
Main number: 01 23 45 67 89 | ||||
|
tel_number_2 |
AN |
2nd telephone number of the person to contact within the OBO company |
|||||
|
website |
AN |
Website of the OBO company |
www.obocompany.fr | ||||
|
additional_information_1 |
AN |
Free field 1 for additional information about the OBO company |
|||||
|
additional_information_2 |
AN |
Free field 2 for additional information about the OBO company |
|||||
|
recipient |
general |
label_1 |
AN |
Main label of the general recipient information block |
Customer information | ||
|
label_2 |
AN |
Secondary label of the general recipient information block |
Detailed information | ||||
|
company_name |
AN |
Name of the general recipient company |
Company XYZ | ||||
|
civility |
AN |
Civility of the general recipient |
Ms. | ||||
|
first_name |
AN |
First name of the general recipient |
Jane | ||||
|
last_name |
AN |
Last name of the general recipient |
DOE | ||||
|
address_1 |
AN |
1st line of the general recipient company address |
2 Anystreet | ||||
|
address_2 |
AN |
2nd line of the general recipient company address |
POSTAL CODE CITY |
||||
|
address_3 |
AN |
3rd line of the general recipient company address |
COUNTRY | ||||
|
address_4 |
AN |
4th line of the general recipient company address |
|||||
|
address_5 |
AN |
5th line of the general recipient company address |
|||||
|
registration_number |
AN |
Registration number of the general recipient company |
|||||
|
share_capital |
AN |
Share capital of the general recipient company |
Share capital of X,XXX,XXX.XX euros | ||||
|
legal_form |
AN |
Legal form of the general recipient company |
LLC | ||||
|
rcs |
AN |
RCS (Trade and Companies Register) number of the general recipient company |
RCS Paris 234 567 890 | ||||
|
vat_identification_number |
AN |
VAT identification number of the general recipient company |
Intracommunity VAT: FR91 234 567 890 | ||||
|
national_registration_id_1 |
AN |
1st national registration ID of the general recipient company |
SIREN: 234 567 890 | ||||
|
national_registration_id_2 |
AN |
2nd national registration ID of the general recipient company |
SIRET: 234 567 890 000 06 | ||||
|
contact_name |
AN |
Name of the person to contact within the general recipient company |
Ms. Jane DOE | ||||
|
|
AN |
Email of the person to contact within the general recipient company |
janedoe@gmail.com | ||||
|
tel_number_1 |
AN |
1st telephone number of the person to contact within the general recipient company |
01 23 45 67 89 | ||||
|
tel_number_2 |
AN |
2nd telephone number of the person to contact within the general recipient company |
|||||
|
website |
AN |
Website of the general recipient company |
www.companyxyz.fr | ||||
|
additional_information_1 |
AN |
Free field 1 for additional information about the general recipient company |
|||||
|
additional_information_2 |
AN |
Free field 2 for additional information about the general recipient company |
|||||
|
billing |
label_1 |
AN |
Main label of the billing recipient information block |
Customer information | |||
|
label_2 |
AN |
Secondary label of the billing recipient information block |
Billing information | ||||
|
company_name |
AN |
Name of the billing recipient company |
Sohenso Corporation | ||||
|
civility |
AN |
Civility of the billing recipient |
Mr | ||||
|
first_name |
AN |
First name of the billing recipient |
Joe | ||||
|
last_name |
AN |
Last name of the billing recipient |
SOHENSO | ||||
|
address_1 |
AN |
1st line of the billing recipient company address |
3 Anystreet | ||||
|
address_2 |
AN |
2nd line of the billing recipient company address |
POSTAL CODE CITY |
||||
|
address_3 |
AN |
3rd line of the billing recipient company address |
COUNTRY | ||||
|
address_4 |
AN |
4th line of the billing recipient company address |
|||||
|
address_5 |
AN |
5th line of the billing recipient company address |
|||||
|
registration_number |
AN |
Registration number of the billing recipient company |
|||||
|
share_capital |
AN |
Share capital of the billing recipient company |
Share capital of X,XXX,XXX.XX euros | ||||
|
legal_form |
AN |
Legal form of the billing recipient company |
SAS | ||||
|
rcs |
AN |
RCS (Trade and Companies Register) number of the billing recipient company |
RCS Paris 345 678 901 | ||||
|
vat_identification_number |
AN |
VAT identification number of the billing recipient company |
Intracommunity VAT: FR91 345 678 901 | ||||
|
national_registration_id_1 |
AN |
1st national registration ID of the billing recipient company |
SIREN: 345 678 901 | ||||
|
national_registration_id_2 |
AN |
2nd national registration ID of the billing recipient company |
SIRET: 345 678 901 000 06 | ||||
|
contact_name |
AN |
Name of the person to contact within the billing recipient company |
Mr Joe SOHENSO | ||||
|
|
AN |
Email of the person to contact within the billing recipient company |
joesohenso@gmail.com | ||||
|
tel_number_1 |
AN |
1st telephone number of the person to contact within the billing recipient company |
01 23 45 67 89 | ||||
|
tel_number_2 |
AN |
2nd telephone number of the person to contact within the billing recipient company |
|||||
|
website |
AN |
Website of the billing recipient company |
|||||
|
additional_information_1 |
AN |
Free field 1 for additional information about the billing recipient company |
|||||
|
additional_information_2 |
AN |
Free field 2 for additional information about the billing recipient company |
|||||
|
shipping |
label_1 |
AN |
Main label of the shipping recipient information block |
Customer information | |||
|
label_2 |
AN |
Secondary label of the shipping recipient information block |
Shipping information | ||||
|
company_name |
AN |
Name of the shipping recipient company |
Sohenso Corporation | ||||
|
civility |
AN |
Civility of the shipping recipient |
Ms. | ||||
|
first_name |
AN |
First name of the shipping recipient |
Jane | ||||
|
last_name |
AN |
Last name of the shipping recipient |
SOHENSO | ||||
|
address_1 |
AN |
1st line of the shipping recipient company address |
2 Anystreet | ||||
|
address_2 |
AN |
2nd line of the shipping recipient company address |
Building 3C | ||||
|
address_3 |
AN |
3rd line of the shipping recipient company address |
POSTAL CODE CITY |
||||
|
address_4 |
AN |
4th line of the shipping recipient company address |
COUNTRY | ||||
|
address_5 |
AN |
5th line of the shipping recipient company address |
|||||
|
registration_number |
AN |
Registration number of the shipping recipient company |
|||||
|
share_capital |
AN |
Share capital of the shipping recipient company |
Share capital of X,XXX,XXX.XX euros | ||||
|
legal_form |
AN |
Legal form of the shipping recipient company |
LLC | ||||
|
rcs |
AN |
RCS (Trade and Companies Register) number of the shipping recipient company |
RCS Paris 234 567 890 | ||||
|
vat_identification_number |
AN |
VAT identification number of the shipping recipient company |
Intracommunity VAT: FR91 234 567 890 | ||||
|
national_registration_id_1 |
AN |
1st national registration ID of the shipping recipient company |
SIREN: 234 567 890 | ||||
|
national_registration_id_2 |
AN |
2nd national registration ID of the shipping recipient company |
SIRET: 234 567 890 000 06 | ||||
|
contact_name |
AN |
Name of the person to contact within the shipping recipient company |
Ms. Ann HAGRAM | ||||
|
|
AN |
Email of the person to contact within the shipping recipient company |
|||||
|
tel_number_1 |
AN |
1st telephone number of the person to contact in the shipping recipient company |
01 23 45 67 89 | ||||
|
tel_number_2 |
AN |
2nd telephone number of the person to contact within the shipping recipient company |
|||||
|
website |
AN |
Website of the shipping recipient company |
|||||
|
additional_information_1 |
AN |
Free field 1 for additional information about the shipping recipient company |
|||||
|
additional_information_2 |
AN |
Free field 2 for additional information about the shipping recipient company |
|||||
|
shipping_precisions |
label |
AN |
Main label of the shipping precisions block |
Shipping detailed information | |||
|
shipping_mode_label |
AN |
Label for the shipping mode |
Mode: |
||||
|
shipping_mode_value |
AN |
Value for the shipping mode |
DHL express |
||||
|
delivery_area_label |
AN |
Label for the delivery area |
Zone: | ||||
|
delivery_area_value |
AN |
Value for the delivery area |
Europe | ||||
|
volume_label |
AN |
Label for the volume |
Volume: | ||||
|
volume_value |
AN |
Value for the volume |
< 1 cubic meter | ||||
|
weight_label |
AN |
Label for the weight |
Weight: | ||||
|
weight_value |
AN |
Value for the weight |
< 5 kg | ||||
|
packages_number_label |
AN |
Label for the number of packages |
Number of packages: | ||||
|
packages_number_value |
AN |
Value for the number of packages |
1 | ||||
|
items |
label |
AN |
Main label for the item array |
Product details | |||
|
header |
JSON |
List of column titles of the item array |
["Title", "Reference", "Quantity", "Excl. Tax Amount"] |
||||
|
values |
JSON |
List of values of the item array |
[ |
||||
|
summary |
label |
AN |
Main label for the summary array |
Summary of amounts | |||
|
header |
JSON |
List of column titles of the summary array |
["Title", "Excl. Tax Amount", "Tax Amount", "Incl. Tax Amount"] |
||||
|
values |
JSON |
List of values of the summary array |
[ |
||||
|
invoice_summary |
label |
AN |
Main label for the invoice summary array |
Summary table | |||
|
header |
JSON |
List of column titles of the invoice summary array |
["Total Excl. Tax Amount", "Total Tax Amount", "Total Incl. Tax Amount"] | ||||
|
values |
JSON |
List of values of the invoice summary array |
[ { "lineType": "default", "data": ["100 EUR", "20 EUR", "120 EUR"] } ] |
||||
|
custom_items |
label |
AN |
Main label for the custom items array |
Detail of taxes and social contributions | |||
|
header |
JSON |
List of column titles of the custom items array |
["Excl. Tax Amount including :"] | ||||
|
values |
JSON |
List of values of the custom items array |
[ { "lineType": "default", "data": ["Social tax : 2.20 EUR"] }, { "lineType": "default", "data": ["Other tax : 1.50 EUR"] }, ] |
||||
|
payment_instruction |
label |
AN |
Main label for the payment instruction block |
Payment instructions | |||
|
payment_term_label |
AN |
Label for the payment term |
Payment conditions: | ||||
|
payment_term_value |
AN |
Value for the payment term |
30 days from reception | ||||
|
payment_method_label |
AN |
Label for the payment method |
Payment method | ||||
|
payment_method_value |
AN |
Value for the payment method |
Transfer on IBAN | ||||
|
total_to_pay_label |
AN |
Label for the total amount to pay |
Amount to be paid | ||||
|
total_to_pay_value |
AN |
Value for the total amount to pay |
120 EUR | ||||
|
due_date_label |
AN |
Label for the due date |
To be paid before: | ||||
|
due_date_value |
AN |
Value for the due date |
31/05/2018 | ||||
|
iban_label |
AN |
Label for the IBAN |
IBAN: | ||||
|
iban_value |
AN |
Value for the IBAN |
FR 32 5000 4699XXXX89 | ||||
|
bic_label |
AN |
Label for the BIC code |
SWIFT/BIC code: | ||||
|
bic_value |
AN |
Value for the BIC code |
XXXXIE2D | ||||
|
document_footer |
logo_1 |
AN |
Name of the image file 1 stored on HiPay’s server to be displayed in the document footer (Every field of the document footer block will be displayed on the last page of the document) |
||||
|
logo_2 |
AN |
Name of the image file 2 stored on HiPay’s server to be displayed in the document footer |
|||||
|
logo_3 |
AN |
Name of the image file 3 stored on HiPay’s server to be displayed in the document footer |
|||||
|
page_number |
display |
B |
True |
True to activate the pagination display in the document footer |
False | ||
|
prefix_label |
AN |
Prefix before pagination |
|||||
|
description_1 |
AN |
Free description in the document footer |
|||||
|
description_2 |
AN |
Free description in the document footer |
|||||
|
page_footer |
logo_1 |
AN |
Name of the image file 1 stored on HiPay’s server to be displayed in the page footer (Every field of the page footer block will be displayed on every page of the document) |
||||
|
logo_2 |
AN |
Name of the image file 2 stored on HiPay’s server to be displayed in the page footer |
|||||
|
logo_3 |
AN |
Name of the image file 3 stored on HiPay’s server to be displayed in the page footer |
|||||
|
page_number |
display |
B |
True |
True to activate the pagination display in the page footer |
False | ||
|
prefix_label |
AN |
Prefix before pagination |
|||||
|
description_1 |
AN |
Free description in the page footer |
ABC COMPANY 123 Main Street City Postal code COUNTRY |
||||
|
description_2 |
AN |
Free description in the page footer |
Payment conditions and terms of sale Late payment: late payment penalties shall apply. Minimum annual interest rate (3.03%) fixed by law plus a €40 flat-rate compensation. |
||||
|
custom_1 |
AN |
custom field 1 |
|||||
|
... |
|
|
|||||
|
custom_20 |
AN |
custom field 20 |
|||||
|
DOCUMENT RE-GENERATION |
|||||||
|
Field name |
Format |
Allowed value |
Mandatory |
Description |
Example |
||
|
Level 1 |
Level 2 |
Level 3 |
|||||
|
sending |
file_destination |
AN |
sftp |
YES |
To choose if the document: |
sftp | |
|
document_name |
AN |
Name that will be given to the document file |
Invoice_245876 |
||||
Comments
0 comments
Article is closed for comments.