Skip to main content

Get Invoice Data

This method allows the user to get details about an invoice using invoice reference.

Query Parameters
invoiceNumberDto object REQUIRED
Header Parameters
TZ

The timezone header is optional. If provided, the header value will be applied to the API response's date and time fields. If the timezone header is not included, the default UTC timezone will be used and returned to the response.

Responses
200

OK

Schema OPTIONAL
errors object[] OPTIONAL
id string OPTIONAL
message string OPTIONAL
id string OPTIONAL
currency string OPTIONAL
amount number OPTIONAL
totalAmount number OPTIONAL
createdAt date-time OPTIONAL
paymentDetails object OPTIONAL
paymentReference string OPTIONAL
amount number OPTIONAL
totalAmount number OPTIONAL
currency string OPTIONAL
paymentDateTime date-time OPTIONAL
paymentFee number OPTIONAL
collector string OPTIONAL
payer string OPTIONAL
paymentMode string OPTIONAL

Possible values: [BANK_TRANSFER, CARDS, MOBILE_MONEY, DIRECT_PAYMENT, CASH, COLLECTED_EXTERNALLY, SC_SFTP]

merchant object OPTIONAL
code string OPTIONAL
name string OPTIONAL
tin string OPTIONAL
address object OPTIONAL
id int64 OPTIONAL
street string OPTIONAL
addressNumber string OPTIONAL
phone string OPTIONAL
zipCode string OPTIONAL
city string OPTIONAL
country string OPTIONAL
customers object[] OPTIONAL
code string OPTIONAL
name string OPTIONAL
tin string OPTIONAL
type string OPTIONAL
address object OPTIONAL
street string OPTIONAL
addressNumber string OPTIONAL
phone string OPTIONAL
zipCode string OPTIONAL
city string OPTIONAL
country string OPTIONAL
mandatedBy string OPTIONAL
mandatedByCustomerName string OPTIONAL
mandatedByCustomerCode string OPTIONAL
mandatedAt date-time OPTIONAL
errors object[] OPTIONAL
id string OPTIONAL
message string OPTIONAL
beneficiaries object[] OPTIONAL
amount number OPTIONAL
beneficiaryCode string OPTIONAL
beneficiaryName string OPTIONAL
merchantCode string OPTIONAL
events object[] OPTIONAL
status string OPTIONAL
occurredAt date-time OPTIONAL
pilotingPhaseValidation string OPTIONAL
code string OPTIONAL
payable boolean OPTIONAL