Create a new invoice

post

https://api.test.bictorys.com/invoice-management/v1/invoices

Create a new invoice for a customer. The invoice can be sent to the customer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

send_notification

boolean

Defaults to true

Controls whether a notification email is sent to the customer.

true (default): Bictorys sends the notification email
false: No notification email will be sent

If this parameter is omitted, the notification will be sent by default.

Body Params

reference

string

invoice reference

customerId

string

unique identifier of the customer, recipient of the invoice

currency

string

required

invoice currency

dueDate

date

required

invoice due date

orderDetails

array of objects

list of purchased items

orderDetails

deliveryCharges

double

Defaults to 0

shipping costs

deductedAmount

double

Defaults to 0

amount in absolute value to be deducted to final amount

status

string

enum

status of the invoice

Allowed:

redirectUrlAfterPayment

string

Optional. Provide an url if you want to redirect customer after successful payment is done.

deviceId

string

The identifier of the device used to make the request

enableMultiplePayment

boolean

Defaults to false

By default, only one payment is authorized on each invoice. In case you want to allow multiple payment (recurrent payment) on this invoice, set the value to true

Responses

201

The invoice is created successfully

401

The caller is not authenticated

403

Access rights not sufficient

400Bad Request

500Internal Server Error.