bankAccount can be enabled for checks
and used as the payment source when the payment destination is a check.
approvals page to token options. This page allows users to add and manage counterparties and approval rules.
updateEntity endpoints as well as the
Business Representative endpoint.
getBalance endpoint to
paymentMethods. This endpoint will return the current balance for an payment method. Currently only supported for bank accounts added via Plaid.
markPaid option on
iframeOptions. Instead, use the new
offline payment method type as the destination.
ownedByOrg on the entity object. Please use
isCustomer on the entity object is now a required field for entity creation. It remains optional for entity updates.
createdById on the invoice object. Please use
creatorId on the invoice object. Please use
glAccountId to invoice line items. This field is used to map line items to a GL Account. This field is optional.
lineItem option to metadata. This field is used to map metadata to a line item.
creatorEntityId to invoice /create and /update request types.
creatorEntityId will become a required field in the future. It is recommended to use this field instead of
creatorId which will be deprecated in the future.
creatorUserId to invoice /create and /update request and response types. It is recommended to use this field instead of
createdById which will be deprecated in the future.
foreignId to invoice /create and /update request and response types. This field is used to store an external ID for an invoice.
isCustomer on the entity object. It is recommended to use this field instead of
ownedByOrg which will be deprecated in the future.
accountName to bank account payment methods. This is a user facing name for the bank account that is editable by the user.
metadata triggers for approval policies.
INVOICE_FAILED notification type.
disabled field to notification policies to completely disable a notification type.
Entity: Enable Mercoa Payments
creatorId to invoice creation to specify if the payee or payor created the invoice
generateInvoicePdf endpoint to generate PDF of an invoice
isPayee fields are now required when creating an entity.
AP11aa2b77 for the payment associated with this invoice.
serviceEndDate fields to invoice line items
ownedByOrg filter to entity search
payerId filter to invoice search
excludeReceivables filters to entity invoice search
DELETE endpoint for entity metadata
archivePayees has been renamed to
mercoaClient.entity.archivePayees are now
KEY_VALUE to support key value pairs.
markPaid to allow users to mark invoices as paid on the iFrame.
expiresIn to set the expiration time of a token.
It is recommended to use these endpoints instead, as they will support pagination, search, and higher performance.
The old endpoint will be deprecated in the future.
PAYER_NAME to invoice order by options.
counterpartyId filter to
sendOnboardingLink endpoints to the
invoiceId parameter to:
paymentMethod is now a discriminated union instead of nested objects. This change was made in
v0.2.0 but had backwards compatibility. This change is now required.
fundedDate has been renamed to
settlementDate for consistency with industry norms.
defaultDestination parameters to
paymentMethod creation and update requests.
isDefaultDestination parameters to
entity creation and update requests.
getRawToken endpoints for an entity and entity users:
getRawToken is a
GET endpoint that returns a JWT token for use with the API
getToken is a
POST endpoint that returns a JWT token for use with the iFrame. This endpoint takes in a configuration object to customize the iFrame experience.
userId has been renamed to
assignedUserId for consistency with the response object
approvalSlotId is now needed to specify the which slot the user will be assigned to.
userNotificationPolicy endpoints to control what notifications are sent to a user. See documentation for more details.
createPaymentMethod endpoint when creating a bank account to require
accountId when using Plaid. This is to support multiple bank accounts per Plaid Link:
getToken endpoint for an entity user:
entity.invoice.find now return paginated results.
Previously, the response would be an array of the data requested. Now, the response is an object with the data and metadata about the request.
The response now looks like this:
data: [ ... ],
Notifications are launched in beta! Your entity users can now get notifications for events like
Notifications are available in the dashboard, iFrame, and the API. Email notifications are coming soon.
Python issue with circular dependencies is fixed. Types are once again exported at the root level to make imports easier.
paymentMethod is now a discriminated union instead of nested objects.
Old Payment Method:
addressLineOne: '123 Fake Street'
New Payment Method:
addressLineOne: '123 Fake Street'
0.2.0 uses namespaces to make using the SDK more intuitive. The API routes have not changed, only the SDK structure
mercoaClient.paymentMethod.get() --> mercoaClient.entity.paymentMethod.get()
mercoaClient.entity.getInvoices() --> mercoaClient.entity.invoice.find()
mercoaClient.entityUsers.get() --> mercoaClient.entity.users.get()
mercoaClient.invoice.getDocuments() --> mercoaClinet.invoice.document.getAll()
mercoaClient.invoice.approve() --> mercoaClinet.invoice.approval.approve()
mercoaClient.invoice.getComment() --> mercoaClient.invoice.comment.get()
updateVendor options on invoice creation/update.
New pages for managing Entity Users and Approval Policies are live!
NEW, and require the rules on the policy to be fulfilled to move into the
Update Payment Method had the wrong request body parameters that were too restrictive.
createdBy added to invoice.
userId added to invoice comment.
Added new invoice status of
If you are using the API to create or update invoices, invoices will need to be set as
Scheduled instead of
New to be scheduled for processing. iFrame users will not be affected.
supportedCurrencies field to Custom Payment Method Schemas
This field is optional and will default to USD. If your payment rail supports currency other than USD or does not support USD, set this value to the supported currencies.
Added new fields for
isPayee. These fields will become mandatory in the future. These fields determine if this entity is a payor or payee (vendor). If the entity is both, then both fields should be set to true.
Updated documentation for
ownedByOrg field. This field currently determines if the entity is a payor or payee (vendor). In the future, this field will only be used to determine if you have a direct relationship with this entity.
Note: Current behavior will check if the isPayor and isPayee fields are not set and fall back to the old
ownedByOrg method of determining who is a payer or vendor.
emailToAlias field. This field is used to support email forwarding.
Python SDK Update
Manual webhook retrigger