Get Invoice Data For Specified Merchant

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

Path Parameters
`merchantReference` string — REQUIRED

Query Parameters
`merchantCodeDto` 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

Schema — OPTIONAL

object[]

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

type string — OPTIONAL

status string — OPTIONAL

Possible values: [UNPAID, VOID, DRAFT, PENDING, PAID, DELETED, EXPIRED]

expirationDate date-time — OPTIONAL

date date-time — OPTIONAL

collectorCode string — OPTIONAL

customerName string — OPTIONAL

merchantReference string — OPTIONAL

merchantReferenceURL string — OPTIONAL

description string — OPTIONAL

justification string — OPTIONAL

warning boolean — OPTIONAL

showReconciliationInfo boolean — OPTIONAL

penaltyWarning boolean — OPTIONAL

customerMismatchWarning boolean — OPTIONAL

shared boolean — OPTIONAL

additionalFields object[] — OPTIONAL

code string — OPTIONAL

value string — OPTIONAL

items object[] — OPTIONAL

code string — OPTIONAL

name string — OPTIONAL

amountWithoutTaxes number — OPTIONAL

quantity number — OPTIONAL

basePrice number — OPTIONAL

amountWithTaxes number — OPTIONAL

beneficiaryCode string — OPTIONAL

group string — OPTIONAL

rank int32 — OPTIONAL

taxes object[] — OPTIONAL

code string — OPTIONAL

rate number — OPTIONAL

amount number — OPTIONAL

description string — OPTIONAL

rank int32 — OPTIONAL

normalizedInvoice object — OPTIONAL

dateTime date-time — OPTIONAL

qrCode string — OPTIONAL

codeMECeFDGI string — OPTIONAL

counters string — OPTIONAL

nim string — OPTIONAL

invoiceId string — OPTIONAL

penalty object — OPTIONAL

id int64 — OPTIONAL

createdAt date-time — OPTIONAL

createdBy string — OPTIONAL

modifiedAt date-time — OPTIONAL

modifiedBy string — OPTIONAL

totalAmount number — OPTIONAL

taxBaseAmount number — OPTIONAL

status string — OPTIONAL

Possible values: [DRAFT_CALCULATION, PENALTY_IMPLEMENTED, VOIDED]

currency string — OPTIONAL

implementationDate date-time — OPTIONAL

invoiceId string — OPTIONAL

penaltyItems object[] — OPTIONAL

id int64 — OPTIONAL

createdAt date-time — OPTIONAL

createdBy string — OPTIONAL

modifiedAt date-time — OPTIONAL

modifiedBy string — OPTIONAL

implementationDate date-time — OPTIONAL

amount number — OPTIONAL

status string — OPTIONAL

Possible values: [DRAFT, IMPLEMENTED]

processed boolean — OPTIONAL

code string — OPTIONAL

payable boolean — OPTIONAL