API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Invoicing entities
Create invoicing entity
Create a new invoicing entity to send invoices from.
POST
/
v1
/
invoicing-entities
curl --request POST \
--url https://api.hyperline.co/v1/invoicing-entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"is_default": true,
"name": "Acme Corp",
"trade_name": "Acme",
"timezone": "America/New_York",
"language": "en",
"tax_id": "123456789",
"billing_email": "billing@acmecorp.com",
"address_line1": "123 Elm St",
"address_line2": "Suite 5",
"zip_code": "10001",
"state": "NY",
"city": "New York",
"country": "USA",
"currency": "USD",
"accounting_currency": "USD",
"invoice_number_pattern": "INV-#####",
"credit_note_number_pattern": "CN-#####",
"document_number_pattern": "DOC-#####",
"next_invoice_number": 1001,
"next_credit_note_number": 201,
"next_document_number": 1501,
"default_payment_delay": 30,
"invoice_grace_period_duration": 7,
"invoice_payment_initiation_delay": 2,
"document_payment_initiation_delay": 2,
"invoice_late_fees": "2% per month",
"invoice_footer": "Thank you for your business.",
"document_footer": "Thank you for your business.",
"quote_footer": "Thank you for your business.",
"logo_url": "http://example.com/logo.png",
"favicon_url": "http://example.com/logo.png",
"brand_color": "#FF5733"
}'
{
"id": "inv123",
"name": "Acme Corp",
"trade_name": "Acme",
"timezone": "America/New_York",
"language": "en",
"is_default": true,
"currency": "USD",
"accounting_currency": "USD",
"address_line1": "123 Elm St",
"address_line2": "Suite 5",
"zip_code": "10001",
"state": "NY",
"city": "New York",
"country": "USA",
"tax_id": "123456789",
"tax_id_valid": true,
"billing_email": "billing@acmecorp.com",
"invoice_number_pattern": "INV-#####",
"credit_note_number_pattern": "CN-#####",
"document_number_pattern": "DOC-#####",
"next_invoice_number": 1001,
"next_credit_note_number": 201,
"next_document_number": 1501,
"default_payment_delay": 30,
"invoice_grace_period_duration": 7,
"invoice_payment_initiation_delay": 2,
"document_payment_initiation_delay": 2,
"invoice_late_fees": "2% per month",
"invoice_footer": "Thank you for your business.",
"document_footer": "Thank you for your business.",
"logo_url": "http://example.com/logo.png",
"favicon_url": "http://example.com/logo.png",
"brand_color": "#FF5733",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-04-01T00:00:00Z",
"deleted_at": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201 - application/json
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/invoicing-entities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"is_default": true,
"name": "Acme Corp",
"trade_name": "Acme",
"timezone": "America/New_York",
"language": "en",
"tax_id": "123456789",
"billing_email": "billing@acmecorp.com",
"address_line1": "123 Elm St",
"address_line2": "Suite 5",
"zip_code": "10001",
"state": "NY",
"city": "New York",
"country": "USA",
"currency": "USD",
"accounting_currency": "USD",
"invoice_number_pattern": "INV-#####",
"credit_note_number_pattern": "CN-#####",
"document_number_pattern": "DOC-#####",
"next_invoice_number": 1001,
"next_credit_note_number": 201,
"next_document_number": 1501,
"default_payment_delay": 30,
"invoice_grace_period_duration": 7,
"invoice_payment_initiation_delay": 2,
"document_payment_initiation_delay": 2,
"invoice_late_fees": "2% per month",
"invoice_footer": "Thank you for your business.",
"document_footer": "Thank you for your business.",
"quote_footer": "Thank you for your business.",
"logo_url": "http://example.com/logo.png",
"favicon_url": "http://example.com/logo.png",
"brand_color": "#FF5733"
}'
{
"id": "inv123",
"name": "Acme Corp",
"trade_name": "Acme",
"timezone": "America/New_York",
"language": "en",
"is_default": true,
"currency": "USD",
"accounting_currency": "USD",
"address_line1": "123 Elm St",
"address_line2": "Suite 5",
"zip_code": "10001",
"state": "NY",
"city": "New York",
"country": "USA",
"tax_id": "123456789",
"tax_id_valid": true,
"billing_email": "billing@acmecorp.com",
"invoice_number_pattern": "INV-#####",
"credit_note_number_pattern": "CN-#####",
"document_number_pattern": "DOC-#####",
"next_invoice_number": 1001,
"next_credit_note_number": 201,
"next_document_number": 1501,
"default_payment_delay": 30,
"invoice_grace_period_duration": 7,
"invoice_payment_initiation_delay": 2,
"document_payment_initiation_delay": 2,
"invoice_late_fees": "2% per month",
"invoice_footer": "Thank you for your business.",
"document_footer": "Thank you for your business.",
"logo_url": "http://example.com/logo.png",
"favicon_url": "http://example.com/logo.png",
"brand_color": "#FF5733",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-04-01T00:00:00Z",
"deleted_at": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.