Getting Started
Invoices
Create Invoice
Create an invoice.
POST
/
v1
/
invoices
curl --request POST \
--url https://api.nomod.com/v1/invoices \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"currency": "<string>",
"items": [
{
"name": "<string>",
"amount": "<string>",
"quantity": 500
}
],
"discount_percentage": 0,
"customer": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"note": "<string>",
"shipping_address_required": false,
"due_date": "2023-12-25",
"starts_at": "2023-12-25",
"custom_fields": [
{
"name": "<string>"
}
],
"success_url": "<string>",
"failure_url": "<string>"
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_id": "<string>",
"created": "2023-11-07T05:31:56Z",
"title": "<string>",
"code": "<string>",
"url": "<string>",
"amount": "<string>",
"currency": "<string>",
"status": "paid",
"discount": "<string>",
"service_fee": "<string>",
"tax": "<string>",
"shipping_address_required": true,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"name": "<string>",
"total_amount": "<string>",
"quantity": 2147483647,
"sku": "<string>"
}
],
"note": "<string>",
"expiry": "2023-11-07T05:31:56Z",
"discount_percentage": "<string>",
"service_fee_percentage": "<string>",
"tip_percentage": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>"
},
"tip": "<string>",
"invoice_number": "<string>",
"service_date": "2023-11-07T05:31:56Z",
"due_date": "2023-11-07T05:31:56Z",
"interval_count": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"due_days": 123,
"custom_fields": [],
"source": "woocommerce",
"success_url": "<string>",
"failure_url": "<string>",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"content_type": "<string>",
"file": "<string>"
}
],
"reminders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"days": 123,
"title": "<string>",
"invoice": 123,
"run_at": "2023-11-07T05:31:56Z"
}
],
"events": [
{
"created": "2023-11-07T05:31:56Z",
"type": "created",
"message": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>"
}
}
],
"customer": {}
}
Authorizations
Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings
Body
application/json
Response
201
application/json
The response is of type object
.
curl --request POST \
--url https://api.nomod.com/v1/invoices \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"currency": "<string>",
"items": [
{
"name": "<string>",
"amount": "<string>",
"quantity": 500
}
],
"discount_percentage": 0,
"customer": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"note": "<string>",
"shipping_address_required": false,
"due_date": "2023-12-25",
"starts_at": "2023-12-25",
"custom_fields": [
{
"name": "<string>"
}
],
"success_url": "<string>",
"failure_url": "<string>"
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_id": "<string>",
"created": "2023-11-07T05:31:56Z",
"title": "<string>",
"code": "<string>",
"url": "<string>",
"amount": "<string>",
"currency": "<string>",
"status": "paid",
"discount": "<string>",
"service_fee": "<string>",
"tax": "<string>",
"shipping_address_required": true,
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"name": "<string>",
"total_amount": "<string>",
"quantity": 2147483647,
"sku": "<string>"
}
],
"note": "<string>",
"expiry": "2023-11-07T05:31:56Z",
"discount_percentage": "<string>",
"service_fee_percentage": "<string>",
"tip_percentage": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>"
},
"tip": "<string>",
"invoice_number": "<string>",
"service_date": "2023-11-07T05:31:56Z",
"due_date": "2023-11-07T05:31:56Z",
"interval_count": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"due_days": 123,
"custom_fields": [],
"source": "woocommerce",
"success_url": "<string>",
"failure_url": "<string>",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"content_type": "<string>",
"file": "<string>"
}
],
"reminders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"days": 123,
"title": "<string>",
"invoice": 123,
"run_at": "2023-11-07T05:31:56Z"
}
],
"events": [
{
"created": "2023-11-07T05:31:56Z",
"type": "created",
"message": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>"
}
}
],
"customer": {}
}
Assistant
Responses are generated using AI and may contain mistakes.