Skip to main content
POST
Import an invoice

Authorizations

Authorization
string
header
required

Body

application/json

Invoice object to import

clientId
string<uuid>
required
reference
string
required
Maximum string length: 80
amount
integer
required
Required range: x >= 0
netAmount
integer
required
Required range: x >= 0
issueDate
string<date>
required
dueDate
string<date>
required
externalId
string | null
Maximum string length: 80
sentDate
string<date>
deprecated

use issueDate instead

Response

Returns the imported invoice

id
string<uuid>
tenantId
string<uuid>
clientId
string<uuid>
externalId
string | null
reference
string
amount
integer
remainingAmount
integer
paidAmount
integer
offsetAmount
integer
sentDate
string<date-time>
deprecated

use issueDate instead

issueDate
string<date-time>
dueDate
string<date-time>
status
enum<string>

Invoice status

Available options:
due,
overdue,
paid,
disputed,
offset,
payment_in_progress,
upcoming_payment,
recovery
upcomingPaymentDate
string<date-time> | null
dueDates
object[]
payments
object[]
createdAt
string<date-time>
updatedAt
string<date-time>