--- title: "Invoice Created" method: POST path: "webhooks_invoiceCreated" --- # Invoice Created `POST webhooks_invoiceCreated` (webhook) A new invoice was created ## Payload - WebhooksInvoiceWebhook - `eventType` string, required: The type of the event. - `invoice` InvoiceTypesInvoiceResponse, required - `status` 'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED', required - `amount` number, double: Total amount of invoice in major units - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' - `invoiceDate` string, date-time: Date the invoice was issued. - `deductionDate` string, date-time: Initial date when funds are scheduled to be deducted from payer's account. The actual deduction date may differ from this date, and will be reflected in the processedAt field. - `nextDeductionDate` string, date-time: For invoice templates, this is the date when the next recurring payment will be scheduled. - `dueDate` string, date-time: Due date of invoice. - `invoiceNumber` string - `noteToSelf` string - `serviceStartDate` string, date-time - `serviceEndDate` string, date-time - `netTerms` integer: Net terms in days. Must be a positive number. - `payerId` string - `payer` EntityTypesCounterpartyResponse - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - `business` EntityTypesBusinessProfileResponse - `email` string - `legalBusinessName` string, required - `businessType` 'soleProprietorship' | 'unincorporatedAssociation' | 'trust' | 'publicCorporation' | 'privateCorporation' | 'llc' | 'partnership' | 'unincorporatedNonProfit' | 'incorporatedNonProfit' - `phone` CommonsPhoneNumber - `countryCode` string, required - `number` string, required - `doingBusinessAs` string - `website` string - `description` string - `address` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `ownersProvided` boolean: True if all representatives have been provided for this business. - `taxIDProvided` boolean, required - `taxId` EntityTypesTaxID - `ein` EntityTypesEin, required - … - `formationDate` string, date-time - `industryCodes` EntityTypesIndustryCodes - `mcc` string - `averageMonthlyTransactionVolume` number, double - `averageTransactionSize` number, double - `maxTransactionSize` number, double - `individual` EntityTypesIndividualProfileResponse - `email` string - `name` CommonsFullName, required - `firstName` string, required - `middleName` string - `lastName` string, required - `suffix` string - `phone` CommonsPhoneNumber - `countryCode` string, required - `number` string, required - `address` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `birthDateProvided` boolean, required - `governmentIDProvided` boolean, required - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - `accountId` string, required: The ID the counterparty has assigned to this account. - `postalCode` string: The postal code the counterparty has assigned to this account. - `nameOnAccount` string: The name on the account the counterparty has assigned to this account. - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accountName` string, required - `bankName` string, required - `routingNumber` string, required - `accountNumber` string, required - `accountType` 'CHECKING' | 'SAVINGS' | 'UNKNOWN', required - `status` 'NEW' | 'VERIFIED' | 'VERIFICATION_FAILED' | 'PENDING' | 'ERRORED', required - `checkOptions` PaymentMethodTypesBankAccountCheckOptions - … - object - `type` 'card', required: Discriminator value: card - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `cardType` 'credit' | 'debit' | 'prepaid' | 'unknown', required - `cardBrand` 'AmericanExpress' | 'Discover' | 'Mastercard' | 'Visa', required - `lastFour` string, required - `expMonth` string, required - `expYear` string, required - object - `type` 'check', required: Discriminator value: check - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `payToTheOrderOf` string, required - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required - `postalCode` string, required - `country` string, required - object - `type` 'custom', required: Discriminator value: custom - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `foreignId` string: ID for this payment method in your system - `accountName` string - `accountNumber` string - `availableBalance` number, double: The available balance for this payment method. - `schemaId` string, required - `schema` PaymentMethodTypesCustomPaymentMethodSchemaResponse, required - … - `data` object, required: Object of key/value pairs that matches the keys in the linked payment method schema. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'utility', required: Discriminator value: utility - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `utilityId` string, required: The ID of the utility that this payment method is linked to. - object - `type` 'wallet', required: Discriminator value: wallet - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `availableBalance` PaymentMethodTypesWalletBalance, required - … - `pendingBalance` PaymentMethodTypesWalletBalance, required - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - `totalCount` integer, required - `totalAmount` number, double, required - `statuses` EntityTypesCounterpartyInvoiceMetricsStatusResponse[], required - `status` 'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED', required - `totalCount` integer, required - `totalAmount` number, double, required - `paymentSource` union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accountName` string, required - `bankName` string, required - `routingNumber` string, required - `accountNumber` string, required - `accountType` 'CHECKING' | 'SAVINGS' | 'UNKNOWN', required - `status` 'NEW' | 'VERIFIED' | 'VERIFICATION_FAILED' | 'PENDING' | 'ERRORED', required - `checkOptions` PaymentMethodTypesBankAccountCheckOptions - `enabled` boolean: If true, will allow the user to print checks from this bank account - `initialCheckNumber` integer: If provided, will start the check number sequence at the provided number. If not provided, will start at 5000. - `routingNumberOverride` string: If provided, will print a check with the provided routing number instead of the one from the bank account - `accountNumberOverride` string: If provided, will print a check with the provided account number instead of the one from the bank account - `accountHolderNameOverride` string: If provided, will print a check with the provided account holder name instead of the payer name from the invoice - `accountHolderAddressOverride` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `signatoryName` string, required: Name of the person who's signature will be printed on the check. - `signatureImage` string: Base64 encoded image of the signature. If not provided, will use the signatoryName to generate a signature. Mercoa will automatically grayscale, resize, and convert the image to a PNG the image to fit on the check. - `useSignatureImage` boolean: If true, will print checks with the provided signatureImage. If false, will print checks with a generated signature from the signatoryName. If this parameter is not set the default behavior is to use the signatureImage if provided. - object - `type` 'card', required: Discriminator value: card - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `cardType` 'credit' | 'debit' | 'prepaid' | 'unknown', required - `cardBrand` 'AmericanExpress' | 'Discover' | 'Mastercard' | 'Visa', required - `lastFour` string, required - `expMonth` string, required - `expYear` string, required - object - `type` 'check', required: Discriminator value: check - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `payToTheOrderOf` string, required - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required - `postalCode` string, required - `country` string, required - object - `type` 'custom', required: Discriminator value: custom - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `foreignId` string: ID for this payment method in your system - `accountName` string - `accountNumber` string - `availableBalance` number, double: The available balance for this payment method. - `schemaId` string, required - `schema` PaymentMethodTypesCustomPaymentMethodSchemaResponse, required - `id` string, required - `name` string, required - `isSource` boolean, required: This payment method can be used as a payment source for an invoice - `isDestination` boolean, required: This payment method can be used as a payment destination for an invoice - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required: List of currencies that this payment method supports. - `fields` PaymentMethodTypesCustomPaymentMethodSchemaField[], required - `name` string, required - `displayName` string - `type` 'text' | 'number' | 'select' | 'date' | 'phone' | 'email' | 'url' | 'dynamicUrl' | 'embeddedUrl' | 'address' | 'usBankRoutingNumber' | 'usBankAccountNumber', required - `optional` boolean, required: Indicates whether this field is optional - `useAsAccountName` boolean: Indicates whether this field should be used as the name of the payment method. Only one field can be used as the name. Will set the accountName field of the payment method to the value of this field. - `useAsAccountNumber` boolean: Indicates whether this field should be used as the account number of the payment method. Only one field can be used as the account number. Will set the accountNumber field of the payment method to the value of this field. - `options` string[]: When type is 'select', provide options that can be selected - `estimatedProcessingTime` integer, required: Estimated time in days for this payment method to process a payments. 0 is an same-day payment methods, -1 is unknown processing time. - `maxAmount` number, double: The maximum amount that can be transferred from this payment method in a single transaction. - `minAmount` number, double: The minimum amount that can be transferred from this payment method in a single transaction. Default is 1. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `data` object, required: Object of key/value pairs that matches the keys in the linked payment method schema. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'utility', required: Discriminator value: utility - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `utilityId` string, required: The ID of the utility that this payment method is linked to. - object - `type` 'wallet', required: Discriminator value: wallet - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `availableBalance` PaymentMethodTypesWalletBalance, required - `amount` number, double, required: The amount in major units of the currency. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `pendingBalance` PaymentMethodTypesWalletBalance, required - `amount` number, double, required: The amount in major units of the currency. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `paymentSourceId` string - `paymentSourceOptions` InvoiceTypesPaymentSourceOptions - `type` 'bnpl', required: Discriminator value: bnpl - `installmentsStartDate` string, required: The start date for installments in YYYY-MM-DD format - `defermentWeeks` integer, required: The number of weeks to defer repayment - `acceptedTerms` boolean, required: Whether the user has agreed to the BNPL terms - `loanId` string: The ID of the loan to use for the BNPL payment. - `downpaymentId` string: The ID of the downpayment to use for the BNPL payment. - `vendorId` string - `vendor` EntityTypesCounterpartyResponse - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - `business` EntityTypesBusinessProfileResponse - `email` string - `legalBusinessName` string, required - `businessType` 'soleProprietorship' | 'unincorporatedAssociation' | 'trust' | 'publicCorporation' | 'privateCorporation' | 'llc' | 'partnership' | 'unincorporatedNonProfit' | 'incorporatedNonProfit' - `phone` CommonsPhoneNumber - `countryCode` string, required - `number` string, required - `doingBusinessAs` string - `website` string - `description` string - `address` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `ownersProvided` boolean: True if all representatives have been provided for this business. - `taxIDProvided` boolean, required - `taxId` EntityTypesTaxID - `ein` EntityTypesEin, required - … - `formationDate` string, date-time - `industryCodes` EntityTypesIndustryCodes - `mcc` string - `averageMonthlyTransactionVolume` number, double - `averageTransactionSize` number, double - `maxTransactionSize` number, double - `individual` EntityTypesIndividualProfileResponse - `email` string - `name` CommonsFullName, required - `firstName` string, required - `middleName` string - `lastName` string, required - `suffix` string - `phone` CommonsPhoneNumber - `countryCode` string, required - `number` string, required - `address` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `birthDateProvided` boolean, required - `governmentIDProvided` boolean, required - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - `accountId` string, required: The ID the counterparty has assigned to this account. - `postalCode` string: The postal code the counterparty has assigned to this account. - `nameOnAccount` string: The name on the account the counterparty has assigned to this account. - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accountName` string, required - `bankName` string, required - `routingNumber` string, required - `accountNumber` string, required - `accountType` 'CHECKING' | 'SAVINGS' | 'UNKNOWN', required - `status` 'NEW' | 'VERIFIED' | 'VERIFICATION_FAILED' | 'PENDING' | 'ERRORED', required - `checkOptions` PaymentMethodTypesBankAccountCheckOptions - … - object - `type` 'card', required: Discriminator value: card - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `cardType` 'credit' | 'debit' | 'prepaid' | 'unknown', required - `cardBrand` 'AmericanExpress' | 'Discover' | 'Mastercard' | 'Visa', required - `lastFour` string, required - `expMonth` string, required - `expYear` string, required - object - `type` 'check', required: Discriminator value: check - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `payToTheOrderOf` string, required - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required - `postalCode` string, required - `country` string, required - object - `type` 'custom', required: Discriminator value: custom - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `foreignId` string: ID for this payment method in your system - `accountName` string - `accountNumber` string - `availableBalance` number, double: The available balance for this payment method. - `schemaId` string, required - `schema` PaymentMethodTypesCustomPaymentMethodSchemaResponse, required - … - `data` object, required: Object of key/value pairs that matches the keys in the linked payment method schema. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'utility', required: Discriminator value: utility - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `utilityId` string, required: The ID of the utility that this payment method is linked to. - object - `type` 'wallet', required: Discriminator value: wallet - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `availableBalance` PaymentMethodTypesWalletBalance, required - … - `pendingBalance` PaymentMethodTypesWalletBalance, required - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - `totalCount` integer, required - `totalAmount` number, double, required - `statuses` EntityTypesCounterpartyInvoiceMetricsStatusResponse[], required - `status` 'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED', required - `totalCount` integer, required - `totalAmount` number, double, required - `paymentDestination` union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accountName` string, required - `bankName` string, required - `routingNumber` string, required - `accountNumber` string, required - `accountType` 'CHECKING' | 'SAVINGS' | 'UNKNOWN', required - `status` 'NEW' | 'VERIFIED' | 'VERIFICATION_FAILED' | 'PENDING' | 'ERRORED', required - `checkOptions` PaymentMethodTypesBankAccountCheckOptions - `enabled` boolean: If true, will allow the user to print checks from this bank account - `initialCheckNumber` integer: If provided, will start the check number sequence at the provided number. If not provided, will start at 5000. - `routingNumberOverride` string: If provided, will print a check with the provided routing number instead of the one from the bank account - `accountNumberOverride` string: If provided, will print a check with the provided account number instead of the one from the bank account - `accountHolderNameOverride` string: If provided, will print a check with the provided account holder name instead of the payer name from the invoice - `accountHolderAddressOverride` CommonsAddress - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required: State or province code. Must be in the format XX. - `postalCode` string, required: Postal code. Must be in the format XXXXX or XXXXX-XXXX. - `country` string - `signatoryName` string, required: Name of the person who's signature will be printed on the check. - `signatureImage` string: Base64 encoded image of the signature. If not provided, will use the signatoryName to generate a signature. Mercoa will automatically grayscale, resize, and convert the image to a PNG the image to fit on the check. - `useSignatureImage` boolean: If true, will print checks with the provided signatureImage. If false, will print checks with a generated signature from the signatoryName. If this parameter is not set the default behavior is to use the signatureImage if provided. - object - `type` 'card', required: Discriminator value: card - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `cardType` 'credit' | 'debit' | 'prepaid' | 'unknown', required - `cardBrand` 'AmericanExpress' | 'Discover' | 'Mastercard' | 'Visa', required - `lastFour` string, required - `expMonth` string, required - `expYear` string, required - object - `type` 'check', required: Discriminator value: check - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `payToTheOrderOf` string, required - `addressLine1` string, required - `addressLine2` string - `city` string, required - `stateOrProvince` string, required - `postalCode` string, required - `country` string, required - object - `type` 'custom', required: Discriminator value: custom - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `foreignId` string: ID for this payment method in your system - `accountName` string - `accountNumber` string - `availableBalance` number, double: The available balance for this payment method. - `schemaId` string, required - `schema` PaymentMethodTypesCustomPaymentMethodSchemaResponse, required - `id` string, required - `name` string, required - `isSource` boolean, required: This payment method can be used as a payment source for an invoice - `isDestination` boolean, required: This payment method can be used as a payment destination for an invoice - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required: List of currencies that this payment method supports. - `fields` PaymentMethodTypesCustomPaymentMethodSchemaField[], required - `name` string, required - `displayName` string - `type` 'text' | 'number' | 'select' | 'date' | 'phone' | 'email' | 'url' | 'dynamicUrl' | 'embeddedUrl' | 'address' | 'usBankRoutingNumber' | 'usBankAccountNumber', required - `optional` boolean, required: Indicates whether this field is optional - `useAsAccountName` boolean: Indicates whether this field should be used as the name of the payment method. Only one field can be used as the name. Will set the accountName field of the payment method to the value of this field. - `useAsAccountNumber` boolean: Indicates whether this field should be used as the account number of the payment method. Only one field can be used as the account number. Will set the accountNumber field of the payment method to the value of this field. - `options` string[]: When type is 'select', provide options that can be selected - `estimatedProcessingTime` integer, required: Estimated time in days for this payment method to process a payments. 0 is an same-day payment methods, -1 is unknown processing time. - `maxAmount` number, double: The maximum amount that can be transferred from this payment method in a single transaction. - `minAmount` number, double: The minimum amount that can be transferred from this payment method in a single transaction. Default is 1. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `data` object, required: Object of key/value pairs that matches the keys in the linked payment method schema. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'utility', required: Discriminator value: utility - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `utilityId` string, required: The ID of the utility that this payment method is linked to. - object - `type` 'wallet', required: Discriminator value: wallet - `id` string, required - `isDefaultSource` boolean, required: Indicates whether this payment method is the default source for the entity - `isDefaultDestination` boolean, required: Indicates whether this payment method is the default destination for the entity - `supportedCurrencies` PaymentMethodTypesCurrencyCode[], required - `externalAccountingSystemId` string: ID for this payment method in the external accounting system (e.g Rutter or Codat) - `frozen` boolean, required: Frozen payment methods cannot be used for payments, but will still be returned in API responses. - `metadata` object, required: Metadata associated with this payment method. - `confirmedByEntity` boolean: (ALPHA, MAY BE REMOVED) Indicates whether the payment method has been verified by the entity. This is useful if another entity has added this payment method to this entity, and you want the owner of the payment method to verify it is correct. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `availableBalance` PaymentMethodTypesWalletBalance, required - `amount` number, double, required: The amount in major units of the currency. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `pendingBalance` PaymentMethodTypesWalletBalance, required - `amount` number, double, required: The amount in major units of the currency. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `paymentDestinationId` string - `paymentDestinationOptions` union - object - `type` 'check', required: Discriminator value: check - `delivery` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `printDescription` boolean: If true, prints the invoice description (noteToSelf) on the check note. Defaults to false. - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `delivery` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `description` string: ACH Statement Description. By default, this will be 'AP' followed by the first 8 characters of the invoice ID (for a single invoice) or the first 8 characters of the transaction ID (for a batch payment). Must be at least 4 characters and no more than 10 characters, and follow this regex pattern `^[a-zA-Z0-9\-#.$&* ]{4,10}$` - object - `type` 'utility', required: Discriminator value: utility - `accountId` string, required: The ID for the utility account to pay with. Links to accounts listed on payor/payee relationship. - object - `type` 'custom', required: Discriminator value: custom - `dynamicUrls` object: Map of field names to dynamic URL values that will be used for dynamicUrl fields in custom payment method schemas - `paymentTiming` CalculateCalculatePaymentTimingResponse - `estimatedProcessingDate` string, date-time, required: Estimated date the payment will be or was processed. - `businessDays` integer, required: Number of business days between the estimated processing date and the estimated settlement date. This does not take into account bank holidays or weekends. - `estimatedProcessingTime` integer, required: Estimated payment time in days. This time takes into account bank holidays and weekends. - `estimatedSettlementDate` string, date-time, required: Estimated date the payment will be or was settled. This is the same as the request's deductionDate plus the paymentTiming. - `paymentDestinationConfirmed` boolean, required: True if the payment destination has been confirmed by the vendor. False if the payment destination has been set (for example, a check to an address) but has not been confirmed by the vendor. - `batchPayment` boolean: If true, this invoice will be paid as a batch payment. Batches are automatically determined by Mercoa based on the payment source, destination, and scheduled payment date. - `hasDocuments` boolean, required: True if the invoice has documents attached. - `hasSourceEmail` boolean, required: True if the invoice was created by an incoming email. - `lineItems` InvoiceTypesInvoiceLineItemResponse[] - `id` string, required - `amount` number, double: Total amount of line item in major units. - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `description` string - `name` string - `quantity` number, double - `unitPrice` number, double: Unit price of line item in major units. - `category` string, required: Category of the line item. Defaults to 'EXPENSE'. - `serviceStartDate` string, date-time - `serviceEndDate` string, date-time - `metadata` object - `glAccountId` string: ID of general ledger account associated with this line item. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `taxAmount` number, double: Tax amount for this invoice. - `shippingAmount` number, double: Shipping amount for this invoice. - `approvers` InvoiceTypesApprovalSlot[], required - `upstreamPolicyId` string - `upstreamPoliciesApproved` boolean: Whether all upstream policies are approved. - `approvalPolicyId` string, required - `approvalSlotId` string, required - `assignedUserId` string - `action` 'NONE' | 'APPROVE' | 'REJECT', required - `eligibleRoles` string[], required - `eligibleUserIds` EntityTypesEntityUserId[], required - `date` string, date-time, required: Either the date the invoice was created, date the approver was assigned, or date of last action by approver, whichever is latest. - `approvalPolicy` EntityTypesApprovalPolicyResponse[], required - `id` string, required - `trigger` EntityTypesTrigger[], required - union - object - `type` 'amount', required: Discriminator value: amount - `amount` number, double, required - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'CNY' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required - `comparison` 'eq' | 'gt' | 'gte' | 'lt' | 'lte' - object - `type` 'vendor', required: Discriminator value: vendor - `vendorIds` EntityTypesEntityId[], required - object - `type` 'metadata', required: Discriminator value: metadata - `key` string, required: The metadata key to match - `value` string[], required: The metadata value the invoice must have to trigger this policy - object: A catchall trigger will trigger if no other triggers match. - `type` 'catchall', required: Discriminator value: catchall - `rule` union, required - object: A rule that will assign approvers to an invoice. - `type` 'approver', required: Discriminator value: approver - `numApprovers` integer, required: Number of approvals required to approve an invoice - `identifierList` union, required - object: List of entity user roles that should be used to determine approvers - … - object: List of entity user IDs that should be used to determine approvers - … - `autoAssign` boolean: If true, the policy will automatically assign approvers to the invoice. If more than one approver is eligible, the policy will assign all eligible approvers to the invoice. - object: A rule that will automatically approve an invoice, regardless of any other rules that were triggered. - `type` 'automatic', required: Discriminator value: automatic - `upstreamPolicyId` string, required - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `metadata` object, required: Metadata associated with this invoice. - `creatorEntityId` string - `entityGroupId` string - `entityGroupForeignId` string: The foreign ID of the entity group that created this invoice. - `creatorUser` EntityTypesEntityUserResponse - `id` string, required - `foreignId` string: The ID used to identify this user in your system. - `email` string - `name` string - `roles` string[], required - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `comments` InvoiceTypesCommentResponse[] - `id` string, required - `text` string, required - `user` EntityTypesEntityUserResponse - `id` string, required - `foreignId` string: The ID used to identify this user in your system. - `email` string - `name` string - `roles` string[], required - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `associatedApprovalAction` InvoiceTypesAssociatedApprovalAction - `userId` string, required - `action` 'NONE' | 'APPROVE' | 'REJECT', required - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `paymentSchedule` union - object - `type` 'oneTime', required: Discriminator value: oneTime - `repeatEvery` integer: How often to repeat the payments. Defaults to 1. Must be greater than 0. For example, if repeatEvery is set to 2 and this is a daily payment, the payment will be made every other day. If repeatEvery is set to 3 and this is a weekly payment, the payment will be made every third week. - `ends` union - integer - string, date-time - object - `type` 'daily', required: Discriminator value: daily - `repeatEvery` integer: How often to repeat the payments. Defaults to 1. Must be greater than 0. For example, if repeatEvery is set to 2 and this is a daily payment, the payment will be made every other day. If repeatEvery is set to 3 and this is a weekly payment, the payment will be made every third week. - `ends` union - integer - string, date-time - object - `type` 'weekly', required: Discriminator value: weekly - `repeatEvery` integer: How often to repeat the payments. Defaults to 1. Must be greater than 0. For example, if repeatEvery is set to 2 and this is a daily payment, the payment will be made every other day. If repeatEvery is set to 3 and this is a weekly payment, the payment will be made every third week. - `ends` union - integer - string, date-time - `repeatOn` InvoiceTypesDayOfWeek[], required - object - `type` 'monthly', required: Discriminator value: monthly - `repeatEvery` integer: How often to repeat the payments. Defaults to 1. Must be greater than 0. For example, if repeatEvery is set to 2 and this is a daily payment, the payment will be made every other day. If repeatEvery is set to 3 and this is a weekly payment, the payment will be made every third week. - `ends` union - integer - string, date-time - `dayOffset` integer: deprecated. will be removed in the future and will always be 0. - `repeatOnDay` integer, required: Day of the month to repeat on. Positive values (1-31): Represent the day of the month counting from the start (e.g., 10 is the 10th day of the month). Negative values (-1 to -31): Represent the day of the month counting backward from the end (e.g., -1 is the last day of the month, -2 is the second-to-last day). - object - `type` 'yearly', required: Discriminator value: yearly - `repeatEvery` integer: How often to repeat the payments. Defaults to 1. Must be greater than 0. For example, if repeatEvery is set to 2 and this is a daily payment, the payment will be made every other day. If repeatEvery is set to 3 and this is a weekly payment, the payment will be made every third week. - `ends` union - integer - string, date-time - `repeatOnDay` integer, required: Day of the month to repeat on. Positive values (1-31): Represent the day of the month counting from the start (e.g., 10 is the 10th day of the month). Negative values (-1 to -31): Represent the day of the month counting backward from the end (e.g., -1 is the last day of the month, -2 is the second-to-last day). - `repeatOnMonth` integer, required: Month to repeat on (1-12). - `ocrJobId` string - `recurringTemplateId` string - `id` string, required - `processedAt` string, date-time: Date when the invoice payment was processed. - `settlementDate` string, date-time: Date of funds settlement. - `foreignId` string: The ID used to identify this invoice in your system. This ID must be unique within each creatorEntity in your system, e.g. two invoices with the same creatorEntity may not have the same foreign ID. - `failureType` 'SOURCE_PAYMENT_ERROR' | 'DESTINATION_PAYMENT_ERROR' | 'REJECTED_HIGH_RISK' | 'INSUFFICIENT_FUNDS' | 'PROCESSING_ERROR' - `transactions` TransactionTransactionResponseWithoutInvoices[]: Transactions associated with this invoice. - union - object - `type` 'bankAccountToBankAccount', required: Discriminator value: bankAccountToBankAccount - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `failureReason` TransactionTransactionFailureReason - `code` string: The failure reason code. - `description` string: The failure reason description. - object - `type` 'bankAccountToMailedCheck', required: Discriminator value: bankAccountToMailedCheck - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `checkNumber` integer, required: The number of the check - `mailedOnDate` string, date-time: The date the check was mailed. If the check was not mailed, this field will be null. - object - `type` 'bankAccountToPrintedCheck', required: Discriminator value: bankAccountToPrintedCheck - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `checkNumber` integer, required: The number of the check - object - `type` 'bankAccountToWallet', required: Discriminator value: bankAccountToWallet - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `failureReason` TransactionTransactionFailureReason - `code` string: The failure reason code. - `description` string: The failure reason description. - object - `type` 'cardToBankAccount', required: Discriminator value: cardToBankAccount - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `failureReason` TransactionTransactionFailureReason - `code` string: The failure reason code. - `description` string: The failure reason description. - object - `type` 'cardToWallet', required: Discriminator value: cardToWallet - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'walletToBankAccount', required: Discriminator value: walletToBankAccount - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `failureReason` TransactionTransactionFailureReason - `code` string: The failure reason code. - `description` string: The failure reason description. - object - `type` 'walletToWallet', required: Discriminator value: walletToWallet - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentSourceId` string, required - `vendorId` string, required - `vendor` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentDestination` union, required - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `paymentDestinationId` string, required - `paymentDestinationOptions` union - object - … - object - … - object - … - object - … - `fees` InvoiceTypesInvoiceFeesResponse - `sourcePaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the source payment method. For example, credit card interchange and acquiring fees. - `sourcePlatformMarkupFee` number, double, required: Fee charged to the payer (C2). - `destinationPaymentMethodFee` number, double, required: Fee charged to the platform (C1) for processing the destination payment method. For example, postage for a check payment. - `destinationPlatformMarkupFee` number, double, required: Fee charged to the payee (C3). - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - object - `type` 'custom', required: Discriminator value: custom - `id` string, required - `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED', required - `amount` number, double, required - `currency` string, required - `payerId` string, required - `payer` EntityTypesCounterpartyResponse, required - `id` string, required - `name` string, required - `email` string, required - `foreignId` string: The ID used to identify this entity in your system - `emailTo` string: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox. - `emailToAlias` string[]: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias. - `isCustomer` boolean, required: True if this entity has a direct relationship with your organization. - `accountType` 'business' | 'individual', required - `profile` EntityTypesProfileResponse, required - … - `logo` string: URL for the entity logo - `status` 'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed', required - `oatfiStatus` string: The OatFi status of this entity - `oatfiUnderwritingResponse` object: The OatFi underwriting response of this entity - `acceptedTos` boolean, required: True if this entity has accepted the terms of service. - `isPayor` boolean, required: True if this entity can pay invoices. - `isPayee` boolean, required: True if this entity can receive payments. - `isNetworkPayor` boolean, required: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity. - `isNetworkPayee` boolean, required: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity. - `metadata` object: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `accounts` EntityTypesCounterpartyCustomizationAccount[]: If the entity searching for counterparties has any accounts configured in the Payee/Payor relationship, they will be returned - … - `paymentMethods` PaymentMethodTypesPaymentMethodResponse[] - … - `counterpartyType` EntityTypesCounterpartyNetworkType[] - `invoiceMetrics` EntityTypesCounterpartyInvoiceMetricsResponse - … - `paymentSource` union, required - object - … - object - … - object - … - … truncated; see the full OpenAPI document linked below ## Acknowledgement `200` Webhook received successfully --- [API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)