{
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"name": "<string>",
"billingAddress": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"county": "<string>",
"country": "<string>",
"state": "<string>"
}
},
"memo": "<string>",
"handle": "<string>",
"status": "draft",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-12-25",
"dueDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unitAmount": 123,
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"amount": 123,
"taxAmount": 123,
"tax": {
"taxable": true,
"taxCode": "<string>",
"taxRate": 123
},
"discount": {
"percentage": 123,
"amount": 123
}
}
],
"settlements": [
{
"date": "2023-12-25",
"amount": 123,
"reference": "<string>",
"note": "<string>"
}
],
"totalExclVat": 123,
"totalVat": 123,
"totalInclVat": 123,
"totalDue": 123,
"type": "invoice",
"settlementStatus": "settled"
}{
"currency": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"name": "<string>",
"billingAddress": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"county": "<string>",
"country": "<string>",
"state": "<string>"
}
},
"memo": "<string>",
"handle": "<string>",
"status": "draft",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date": "2023-12-25",
"dueDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"unitAmount": 123,
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"periodStart": "2023-12-25",
"periodEnd": "2023-12-25",
"amount": 123,
"taxAmount": 123,
"tax": {
"taxable": true,
"taxCode": "<string>",
"taxRate": 123
},
"discount": {
"percentage": 123,
"amount": 123
}
}
],
"settlements": [
{
"date": "2023-12-25",
"amount": 123,
"reference": "<string>",
"note": "<string>"
}
],
"totalExclVat": 123,
"totalVat": 123,
"totalInclVat": 123,
"totalDue": 123,
"type": "invoice",
"settlementStatus": "settled"
}Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.
Request body with invoice, lines, tax and discount.
Show child attributes
Quantity up to 4 decimal places (0.0000). Can be positive or negative. Default to 0.
Unit price in lowest currency (cents). Must be positive. See https://go.plude.io/h11101. Default to 0.
Stock keeping unit of line. See https://go.plude.io/h21010.
A description or product or service.
A detailed multiline description. Use \n for line breaks.
Start of date period.
End of date period. Must be accompanied with PeriodStart.
Optional. Value of "standard", "reduced", "exempt" or specific code "ptc_xx". Defaults to standard.
Properties for an invoice line discount. Either percentage or amount must be provided.
400Newly created invoice.
Show child attributes
Show child attributes
Unique invoice number.
draft, booked Show child attributes
Gets the unique identifier of the invoice line.
Quantity or count of units billed by the line. Precision to 4.
Unit amount (in the invoice currency specified) for the line.
Amount (in the invoice currency specified) for the line. This will always be equal to UnitAmount * Quantity - Discount.
Amount of tax, if the line is taxable. Auto calculated as a percentage of the line amount based on the tax rate, see Tax.
invoice, credit_note settled, over_settled, under_settled, not_settled Was this page helpful?