Skip to main content
GET
/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required
invoiceId
string
required

Response

200 - application/json

Successful response

id
string
required
realm
string
required
organization
string
required
allowedPaymentMethods
enum<string>[]
required
Available options:
BANK_SLIP,
PIX_INITIATION,
PIX_AUTOMATIC,
PIX,
P2P
closingAt
string<date-time>
required
dueAt
string<date-time>
required
expiresAt
string<date-time>
required
invoiceNumber
number
required
creditParties
object[]
required
amount
number
required
status
enum<string>
required
Available options:
OPEN,
CLOSED,
UPCOMING,
PAID,
CANCELED
createdBy
string
required
updatedBy
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
external
object
required
contract
string
deal
string
dealName
string
description
string
debitParties
object[]
fine
object
interest
object
discount
object
paymentStatus
enum<string>
Available options:
NONE,
PENDING,
PROCESSING,
PROCESSED,
FAILED
paymentsAttempts
number
paidAt
string<date-time>
scheduled
boolean
previousInvoiceId
string