Skip to main content
GET
Retrieve an invoice batch payment

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

id
string<uuid>
required

Response

Invoice batch payment resource response

@context
string
default:/contexts/InvoiceBatchPayment
@id
string<iri-reference>

Invoice Batch Payment IRI reference

Example:

"/invoices/batch-payments/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:InvoiceBatchPayment
id
string<uuid>

Invoice batch payment ID

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

date
string<date-time> | null

Payment date

paymentMethod
enum<string> | null

Payment method code from the c_FormaPago catalog

Available options:
01,
02,
03,
04,
05,
06,
08,
12,
13,
14,
15,
17,
23,
24,
25,
26,
27,
28,
29,
30,
31,
99
Example:

"04"

currency
string | null

ISO 4217 alphabetic currency code

Required string length: 3
Example:

"MXN"

exchangeRate
number<float> | null

Set when currency is different than MXN

Example:

19.8

amount
number<float>

Total batch payment amount. Positive values are income for the entity; negative values are expenses.

Example:

-53249.8

operationNumber
string

Operation identifier, it is used for internal control

Example:

"1022030122"

beneficiaryBank
object
payerBank
object
payments
object[]
invoice
object
canceledAt
string<date-time> | null

Date and time the payment receipt invoice was canceled

createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"