CreateInvoice

post

https://{yourlidiaurl}/order/orders/invoices/create

Creates a new invoice for an order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The invoice details including lines, amounts, and billing information.

invoiceId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the invoice id.

parentId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the parent id.

invoiceNumber

string | null

Gets or sets the invoice number.

amount

string

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the amount.

invoiceDate

date-time

Gets or sets the invoice date.

type

string

enum

Allowed values: Individual (0), Corporate (1).

Allowed:

scope

string

enum

Allowed values: None (0), Order (10), Delivery (20), Return (30).

Allowed:

orderId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the order id.

deliveryId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the delivery id.

orderProcessId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the order process id.

fromParty

string

enum

Allowed values: None (0), Merchant (10), Network (20), Platform (30), Buyer (40), User (50).

Allowed:

toParty

string

enum

Allowed values: None (0), Merchant (10), Network (20), Platform (30), Buyer (40), User (50).

Allowed:

state

string

enum

Allowed values: Pending (0), Approved (10), Valid (20), Rejected (-99).

Allowed:

currency

string | null

Gets or sets the currency.

documentId

string | null

Gets or sets the document id.

issuerId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the issuer id.

issuerBillingInfoData

string | null

Gets or sets the issuer billing info data.

recipientId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the recipient id.

recipientBillingInfoData

string | null

Gets or sets the recipient billing info data.

lines

array of objects | null

Gets or sets the list of invoice lines.

lines

properties

array of objects | null

Gets or sets the list of invoice properties.

properties

logs

array of objects | null

Gets or sets the list of invoice logs.

logs

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

userEmail

string | null

Gets or sets the email address of the user performing the operation.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

status

string

enum

Allowed values: Draft (0), Active (1), Unknown (-999), Deleted (-99), Blocked (-12), Freezed (-11), Test (-9), Passive (-1).

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200

The newly created invoice.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!