Search transactions

GET

https://api.mercoa.com/transactions

GET

/transactions

curl -G https://api.mercoa.com/transactions \
     -H "Authorization: Bearer <token>" \
     --data-urlencode startDate=2024-01-15T09:30:00Z \
     --data-urlencode endDate=2024-01-15T09:30:00Z \
     -d limit=10

{
  "count": 3,
  "hasMore": false,
  "data": [
    {
      "type": "bankAccountToBankAccount",
      "amount": 10000,
      "createdAt": "2024-01-01T00:00:00Z",
      "currency": "USD",
      "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "invoices": [
        {
          "approvalPolicy": [
            {
              "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
              "trigger": [
                {
                  "type": "amount",
                  "amount": 100,
                  "currency": "USD"
                }
              ],
              "rule": {
                "type": "approver",
                "identifierList": {
                  "type": "rolesList",
                  "value": [
                    "Admin",
                    "Controller"
                  ]
                },
                "numApprovers": 2
              },
              "upstreamPolicyId": "root",
              "createdAt": "2024-01-01T00:00:00Z",
              "updatedAt": "2024-01-02T00:00:00Z"
            }
          ],
          "approvers": [
            {
              "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
              "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
              "action": "APPROVE",
              "eligibleRoles": [
                "admin"
              ],
              "eligibleUserIds": [
                "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
              ],
              "date": "2021-01-01T00:00:00Z",
              "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
            }
          ],
          "createdAt": "2021-01-01T00:00:00Z",
          "hasDocuments": true,
          "hasSourceEmail": true,
          "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
          "metadata": {
            "key1": "value1",
            "key2": "value2"
          },
          "paymentDestinationConfirmed": true,
          "status": "PAID",
          "updatedAt": "2021-01-01T00:00:00Z",
          "amount": 100,
          "comments": [
            {
              "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
              "text": "This is an approval comment",
              "createdAt": "2021-01-01T00:00:00Z",
              "updatedAt": "2021-01-01T00:00:00Z",
              "user": {
                "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
                "roles": [
                  "admin",
                  "approver"
                ],
                "createdAt": "2024-01-01T00:00:00Z",
                "updatedAt": "2024-01-01T00:00:00Z",
                "foreignId": "MY-DB-ID-12345",
                "email": "john.doe@acme.com",
                "name": "John Doe"
              },
              "associatedApprovalAction": {
                "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
                "action": "APPROVE"
              }
            }
          ],
          "creatorUser": {
            "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
            "roles": [
              "admin",
              "approver"
            ],
            "createdAt": "2024-01-01T00:00:00Z",
            "updatedAt": "2024-01-01T00:00:00Z",
            "foreignId": "MY-DB-ID-12345",
            "email": "john.doe@acme.com",
            "name": "John Doe"
          },
          "currency": "USD",
          "deductionDate": "2021-01-01T00:00:00Z",
          "dueDate": "2021-01-31T00:00:00Z",
          "foreignId": "YOUR-DATABASE-ID",
          "invoiceDate": "2021-01-01T00:00:00Z",
          "invoiceNumber": "INV-123",
          "lineItems": [
            {
              "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
              "currency": "USD",
              "category": "EXPENSE",
              "createdAt": "2021-01-01T00:00:00Z",
              "updatedAt": "2021-01-01T00:00:00Z",
              "amount": 100,
              "description": "Product A",
              "name": "Product A",
              "quantity": 1,
              "unitPrice": 100,
              "serviceStartDate": "2021-01-01T00:00:00Z",
              "serviceEndDate": "2021-01-31T00:00:00Z",
              "metadata": {
                "key1": "value1",
                "key2": "value2"
              },
              "glAccountId": "600394"
            }
          ],
          "noteToSelf": "For the month of January",
          "payer": {
            "acceptedTos": true,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "customer@acme.com",
            "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
            "isCustomer": true,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": false,
            "isPayor": true,
            "name": "Acme Inc.",
            "profile": {
              "business": {
                "legalBusinessName": "Acme Inc.",
                "taxIDProvided": true,
                "email": "customer@acme.com",
                "businessType": "llc",
                "phone": {
                  "countryCode": "1",
                  "number": "4155551234"
                },
                "address": {
                  "addressLine1": "123 Main St",
                  "city": "San Francisco",
                  "stateOrProvince": "CA",
                  "postalCode": "94105",
                  "addressLine2": "Unit 1",
                  "country": "US"
                },
                "ownersProvided": true,
                "taxId": {
                  "ein": {
                    "number": "12-3456789"
                  }
                }
              }
            },
            "status": "verified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "accounts": [
              {
                "accountId": "85866843",
                "postalCode": "94105",
                "nameOnAccount": "John Doe"
              }
            ],
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-12345",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              }
            ]
          },
          "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
          "paymentDestination": {
            "type": "check",
            "addressLine1": "123 Main St",
            "city": "New York",
            "country": "US",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
            "isDefaultDestination": true,
            "isDefaultSource": false,
            "metadata": {},
            "payToTheOrderOf": "John Doe",
            "postalCode": "10001",
            "stateOrProvince": "NY",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "addressLine2": "Apt 1",
            "confirmedByEntity": true
          },
          "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
          "paymentDestinationOptions": {
            "type": "check",
            "delivery": "MAIL",
            "printDescription": true
          },
          "paymentSource": {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          },
          "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
          "paymentSourceOptions": {
            "type": "bnpl",
            "acceptedTerms": true,
            "defermentWeeks": 8,
            "installmentsStartDate": "2025-06-18"
          },
          "processedAt": "2021-01-01T00:00:00Z",
          "serviceEndDate": "2021-01-31T00:00:00Z",
          "serviceStartDate": "2021-01-01T00:00:00Z",
          "settlementDate": "2021-01-03T00:00:00Z",
          "transactions": [
            {
              "type": "bankAccountToBankAccount",
              "amount": 10000,
              "createdAt": "2024-01-01T00:00:00Z",
              "currency": "USD",
              "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "payer": {
                "acceptedTos": true,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "customer@acme.com",
                "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
                "isCustomer": true,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": false,
                "isPayor": true,
                "name": "Acme Inc.",
                "profile": {
                  "business": {
                    "legalBusinessName": "Acme Inc.",
                    "taxIDProvided": true,
                    "email": "customer@acme.com",
                    "businessType": "llc",
                    "phone": {
                      "countryCode": "1",
                      "number": "4155551234"
                    },
                    "address": {
                      "addressLine1": "123 Main St",
                      "city": "San Francisco",
                      "stateOrProvince": "CA",
                      "postalCode": "94105",
                      "addressLine2": "Unit 1",
                      "country": "US"
                    },
                    "ownersProvided": true,
                    "taxId": {
                      "ein": {
                        "number": "12-3456789"
                      }
                    }
                  }
                },
                "status": "verified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "accounts": [
                  {
                    "accountId": "85866843",
                    "postalCode": "94105",
                    "nameOnAccount": "John Doe"
                  }
                ],
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-12345",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "My Checking Account",
                    "accountNumber": "99988767623",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "12345678",
                    "status": "VERIFIED",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": true
                  }
                ]
              },
              "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "paymentDestination": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "paymentSource": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "status": "COMPLETED",
              "updatedAt": "2024-01-01T00:00:00Z",
              "vendor": {
                "acceptedTos": false,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "vendor@bigboxstore.com",
                "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
                "isCustomer": false,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": true,
                "isPayor": false,
                "name": "Big Box Store",
                "profile": {
                  "business": {
                    "legalBusinessName": "Big Box Store",
                    "taxIDProvided": false,
                    "email": "vendor@bigboxstore.com",
                    "businessType": "publicCorporation",
                    "ownersProvided": false
                  }
                },
                "status": "unverified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-90909",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "Vendor Checking Account",
                    "accountNumber": "55934059697648",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "66554433",
                    "status": "NEW",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": false
                  }
                ]
              },
              "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
            }
          ],
          "vendor": {
            "acceptedTos": false,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "vendor@bigboxstore.com",
            "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
            "isCustomer": false,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": true,
            "isPayor": false,
            "name": "Big Box Store",
            "profile": {
              "business": {
                "legalBusinessName": "Big Box Store",
                "taxIDProvided": false,
                "email": "vendor@bigboxstore.com",
                "businessType": "publicCorporation",
                "ownersProvided": false
              }
            },
            "status": "unverified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-90909",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "Vendor Checking Account",
                "accountNumber": "55934059697648",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "66554433",
                "status": "NEW",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": false
              }
            ]
          },
          "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
        }
      ],
      "payer": {
        "acceptedTos": true,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "customer@acme.com",
        "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
        "isCustomer": true,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": false,
        "isPayor": true,
        "name": "Acme Inc.",
        "profile": {
          "business": {
            "legalBusinessName": "Acme Inc.",
            "taxIDProvided": true,
            "email": "customer@acme.com",
            "businessType": "llc",
            "phone": {
              "countryCode": "1",
              "number": "4155551234"
            },
            "address": {
              "addressLine1": "123 Main St",
              "city": "San Francisco",
              "stateOrProvince": "CA",
              "postalCode": "94105",
              "addressLine2": "Unit 1",
              "country": "US"
            },
            "ownersProvided": true,
            "taxId": {
              "ein": {
                "number": "12-3456789"
              }
            }
          }
        },
        "status": "verified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "accounts": [
          {
            "accountId": "85866843",
            "postalCode": "94105",
            "nameOnAccount": "John Doe"
          }
        ],
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-12345",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          }
        ]
      },
      "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "paymentDestination": {
        "type": "bankAccount",
        "accountName": "My Checking Account",
        "accountNumber": "99988767623",
        "accountType": "CHECKING",
        "bankName": "Chase",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
        "isDefaultDestination": true,
        "isDefaultSource": true,
        "metadata": {},
        "routingNumber": "12345678",
        "status": "VERIFIED",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "confirmedByEntity": true
      },
      "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
      "paymentSource": {
        "type": "bankAccount",
        "accountName": "My Checking Account",
        "accountNumber": "99988767623",
        "accountType": "CHECKING",
        "bankName": "Chase",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
        "isDefaultDestination": true,
        "isDefaultSource": true,
        "metadata": {},
        "routingNumber": "12345678",
        "status": "VERIFIED",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "confirmedByEntity": true
      },
      "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
      "status": "COMPLETED",
      "updatedAt": "2024-01-01T00:00:00Z",
      "vendor": {
        "acceptedTos": false,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "vendor@bigboxstore.com",
        "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
        "isCustomer": false,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": true,
        "isPayor": false,
        "name": "Big Box Store",
        "profile": {
          "business": {
            "legalBusinessName": "Big Box Store",
            "taxIDProvided": false,
            "email": "vendor@bigboxstore.com",
            "businessType": "publicCorporation",
            "ownersProvided": false
          }
        },
        "status": "unverified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-90909",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "Vendor Checking Account",
            "accountNumber": "55934059697648",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "66554433",
            "status": "NEW",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": false
          }
        ]
      },
      "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
    },
    {
      "type": "bankAccountToMailedCheck",
      "amount": 10000,
      "checkNumber": 4005,
      "createdAt": "2024-01-01T00:00:00Z",
      "currency": "USD",
      "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "invoices": [
        {
          "approvalPolicy": [
            {
              "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
              "trigger": [
                {
                  "type": "amount",
                  "amount": 100,
                  "currency": "USD"
                }
              ],
              "rule": {
                "type": "approver",
                "identifierList": {
                  "type": "rolesList",
                  "value": [
                    "Admin",
                    "Controller"
                  ]
                },
                "numApprovers": 2
              },
              "upstreamPolicyId": "root",
              "createdAt": "2024-01-01T00:00:00Z",
              "updatedAt": "2024-01-02T00:00:00Z"
            }
          ],
          "approvers": [
            {
              "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
              "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
              "action": "APPROVE",
              "eligibleRoles": [
                "admin"
              ],
              "eligibleUserIds": [
                "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
              ],
              "date": "2021-01-01T00:00:00Z",
              "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
            }
          ],
          "createdAt": "2021-01-01T00:00:00Z",
          "hasDocuments": true,
          "hasSourceEmail": true,
          "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
          "metadata": {
            "key1": "value1",
            "key2": "value2"
          },
          "paymentDestinationConfirmed": true,
          "status": "PAID",
          "updatedAt": "2021-01-01T00:00:00Z",
          "amount": 100,
          "comments": [
            {
              "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
              "text": "This is an approval comment",
              "createdAt": "2021-01-01T00:00:00Z",
              "updatedAt": "2021-01-01T00:00:00Z",
              "user": {
                "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
                "roles": [
                  "admin",
                  "approver"
                ],
                "createdAt": "2024-01-01T00:00:00Z",
                "updatedAt": "2024-01-01T00:00:00Z",
                "foreignId": "MY-DB-ID-12345",
                "email": "john.doe@acme.com",
                "name": "John Doe"
              },
              "associatedApprovalAction": {
                "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
                "action": "APPROVE"
              }
            }
          ],
          "creatorUser": {
            "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
            "roles": [
              "admin",
              "approver"
            ],
            "createdAt": "2024-01-01T00:00:00Z",
            "updatedAt": "2024-01-01T00:00:00Z",
            "foreignId": "MY-DB-ID-12345",
            "email": "john.doe@acme.com",
            "name": "John Doe"
          },
          "currency": "USD",
          "deductionDate": "2021-01-01T00:00:00Z",
          "dueDate": "2021-01-31T00:00:00Z",
          "foreignId": "YOUR-DATABASE-ID",
          "invoiceDate": "2021-01-01T00:00:00Z",
          "invoiceNumber": "INV-123",
          "lineItems": [
            {
              "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
              "currency": "USD",
              "category": "EXPENSE",
              "createdAt": "2021-01-01T00:00:00Z",
              "updatedAt": "2021-01-01T00:00:00Z",
              "amount": 100,
              "description": "Product A",
              "name": "Product A",
              "quantity": 1,
              "unitPrice": 100,
              "serviceStartDate": "2021-01-01T00:00:00Z",
              "serviceEndDate": "2021-01-31T00:00:00Z",
              "metadata": {
                "key1": "value1",
                "key2": "value2"
              },
              "glAccountId": "600394"
            }
          ],
          "noteToSelf": "For the month of January",
          "payer": {
            "acceptedTos": true,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "customer@acme.com",
            "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
            "isCustomer": true,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": false,
            "isPayor": true,
            "name": "Acme Inc.",
            "profile": {
              "business": {
                "legalBusinessName": "Acme Inc.",
                "taxIDProvided": true,
                "email": "customer@acme.com",
                "businessType": "llc",
                "phone": {
                  "countryCode": "1",
                  "number": "4155551234"
                },
                "address": {
                  "addressLine1": "123 Main St",
                  "city": "San Francisco",
                  "stateOrProvince": "CA",
                  "postalCode": "94105",
                  "addressLine2": "Unit 1",
                  "country": "US"
                },
                "ownersProvided": true,
                "taxId": {
                  "ein": {
                    "number": "12-3456789"
                  }
                }
              }
            },
            "status": "verified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "accounts": [
              {
                "accountId": "85866843",
                "postalCode": "94105",
                "nameOnAccount": "John Doe"
              }
            ],
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-12345",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              }
            ]
          },
          "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
          "paymentDestination": {
            "type": "check",
            "addressLine1": "123 Main St",
            "city": "New York",
            "country": "US",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
            "isDefaultDestination": true,
            "isDefaultSource": false,
            "metadata": {},
            "payToTheOrderOf": "John Doe",
            "postalCode": "10001",
            "stateOrProvince": "NY",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "addressLine2": "Apt 1",
            "confirmedByEntity": true
          },
          "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
          "paymentDestinationOptions": {
            "type": "check",
            "delivery": "MAIL",
            "printDescription": true
          },
          "paymentSource": {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          },
          "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
          "paymentSourceOptions": {
            "type": "bnpl",
            "acceptedTerms": true,
            "defermentWeeks": 8,
            "installmentsStartDate": "2025-06-18"
          },
          "processedAt": "2021-01-01T00:00:00Z",
          "serviceEndDate": "2021-01-31T00:00:00Z",
          "serviceStartDate": "2021-01-01T00:00:00Z",
          "settlementDate": "2021-01-03T00:00:00Z",
          "transactions": [
            {
              "type": "bankAccountToBankAccount",
              "amount": 10000,
              "createdAt": "2024-01-01T00:00:00Z",
              "currency": "USD",
              "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "payer": {
                "acceptedTos": true,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "customer@acme.com",
                "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
                "isCustomer": true,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": false,
                "isPayor": true,
                "name": "Acme Inc.",
                "profile": {
                  "business": {
                    "legalBusinessName": "Acme Inc.",
                    "taxIDProvided": true,
                    "email": "customer@acme.com",
                    "businessType": "llc",
                    "phone": {
                      "countryCode": "1",
                      "number": "4155551234"
                    },
                    "address": {
                      "addressLine1": "123 Main St",
                      "city": "San Francisco",
                      "stateOrProvince": "CA",
                      "postalCode": "94105",
                      "addressLine2": "Unit 1",
                      "country": "US"
                    },
                    "ownersProvided": true,
                    "taxId": {
                      "ein": {
                        "number": "12-3456789"
                      }
                    }
                  }
                },
                "status": "verified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "accounts": [
                  {
                    "accountId": "85866843",
                    "postalCode": "94105",
                    "nameOnAccount": "John Doe"
                  }
                ],
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-12345",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "My Checking Account",
                    "accountNumber": "99988767623",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "12345678",
                    "status": "VERIFIED",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": true
                  }
                ]
              },
              "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "paymentDestination": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "paymentSource": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "status": "COMPLETED",
              "updatedAt": "2024-01-01T00:00:00Z",
              "vendor": {
                "acceptedTos": false,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "vendor@bigboxstore.com",
                "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
                "isCustomer": false,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": true,
                "isPayor": false,
                "name": "Big Box Store",
                "profile": {
                  "business": {
                    "legalBusinessName": "Big Box Store",
                    "taxIDProvided": false,
                    "email": "vendor@bigboxstore.com",
                    "businessType": "publicCorporation",
                    "ownersProvided": false
                  }
                },
                "status": "unverified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-90909",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "Vendor Checking Account",
                    "accountNumber": "55934059697648",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "66554433",
                    "status": "NEW",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": false
                  }
                ]
              },
              "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
            }
          ],
          "vendor": {
            "acceptedTos": false,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "vendor@bigboxstore.com",
            "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
            "isCustomer": false,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": true,
            "isPayor": false,
            "name": "Big Box Store",
            "profile": {
              "business": {
                "legalBusinessName": "Big Box Store",
                "taxIDProvided": false,
                "email": "vendor@bigboxstore.com",
                "businessType": "publicCorporation",
                "ownersProvided": false
              }
            },
            "status": "unverified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-90909",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "Vendor Checking Account",
                "accountNumber": "55934059697648",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "66554433",
                "status": "NEW",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": false
              }
            ]
          },
          "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
        }
      ],
      "payer": {
        "acceptedTos": true,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "customer@acme.com",
        "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
        "isCustomer": true,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": false,
        "isPayor": true,
        "name": "Acme Inc.",
        "profile": {
          "business": {
            "legalBusinessName": "Acme Inc.",
            "taxIDProvided": true,
            "email": "customer@acme.com",
            "businessType": "llc",
            "phone": {
              "countryCode": "1",
              "number": "4155551234"
            },
            "address": {
              "addressLine1": "123 Main St",
              "city": "San Francisco",
              "stateOrProvince": "CA",
              "postalCode": "94105",
              "addressLine2": "Unit 1",
              "country": "US"
            },
            "ownersProvided": true,
            "taxId": {
              "ein": {
                "number": "12-3456789"
              }
            }
          }
        },
        "status": "verified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "accounts": [
          {
            "accountId": "85866843",
            "postalCode": "94105",
            "nameOnAccount": "John Doe"
          }
        ],
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-12345",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          }
        ]
      },
      "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "paymentDestination": {
        "type": "check",
        "addressLine1": "123 Main St",
        "city": "New York",
        "country": "US",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
        "isDefaultDestination": true,
        "isDefaultSource": false,
        "metadata": {},
        "payToTheOrderOf": "John Doe",
        "postalCode": "10001",
        "stateOrProvince": "NY",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "addressLine2": "Apt 1",
        "confirmedByEntity": true
      },
      "paymentDestinationId": "pm_68ff13bf-390d-49d3-a29a-3fe239f12b92",
      "paymentSource": {
        "type": "bankAccount",
        "accountName": "My Checking Account",
        "accountNumber": "99988767623",
        "accountType": "CHECKING",
        "bankName": "Chase",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
        "isDefaultDestination": true,
        "isDefaultSource": true,
        "metadata": {},
        "routingNumber": "12345678",
        "status": "VERIFIED",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "confirmedByEntity": true
      },
      "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
      "status": "COMPLETED",
      "updatedAt": "2024-01-01T00:00:00Z",
      "vendor": {
        "acceptedTos": false,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "vendor@bigboxstore.com",
        "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
        "isCustomer": false,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": true,
        "isPayor": false,
        "name": "Big Box Store",
        "profile": {
          "business": {
            "legalBusinessName": "Big Box Store",
            "taxIDProvided": false,
            "email": "vendor@bigboxstore.com",
            "businessType": "publicCorporation",
            "ownersProvided": false
          }
        },
        "status": "unverified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-90909",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "Vendor Checking Account",
            "accountNumber": "55934059697648",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "66554433",
            "status": "NEW",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": false
          }
        ]
      },
      "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "mailedOnDate": "2024-01-01T00:00:00Z"
    },
    {
      "type": "bankAccountToBankAccount",
      "amount": 10000,
      "createdAt": "2024-01-01T00:00:00Z",
      "currency": "USD",
      "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "invoices": [
        {
          "approvalPolicy": [],
          "approvers": [],
          "createdAt": "2021-01-01T00:00:00Z",
          "hasDocuments": true,
          "hasSourceEmail": true,
          "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
          "metadata": {},
          "paymentDestinationConfirmed": true,
          "status": "FAILED",
          "updatedAt": "2021-01-01T00:00:00Z",
          "amount": 100,
          "currency": "USD",
          "deductionDate": "2021-01-29T00:00:00Z",
          "dueDate": "2021-01-31T00:00:00Z",
          "invoiceDate": "2021-01-01T00:00:00Z",
          "invoiceNumber": "INV-123",
          "payer": {
            "acceptedTos": true,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "customer@acme.com",
            "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
            "isCustomer": true,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": false,
            "isPayor": true,
            "name": "Acme Inc.",
            "profile": {
              "business": {
                "legalBusinessName": "Acme Inc.",
                "taxIDProvided": true,
                "email": "customer@acme.com",
                "businessType": "llc",
                "phone": {
                  "countryCode": "1",
                  "number": "4155551234"
                },
                "address": {
                  "addressLine1": "123 Main St",
                  "city": "San Francisco",
                  "stateOrProvince": "CA",
                  "postalCode": "94105",
                  "addressLine2": "Unit 1",
                  "country": "US"
                },
                "ownersProvided": true,
                "taxId": {
                  "ein": {
                    "number": "12-3456789"
                  }
                }
              }
            },
            "status": "verified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "accounts": [
              {
                "accountId": "85866843",
                "postalCode": "94105",
                "nameOnAccount": "John Doe"
              }
            ],
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-12345",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              }
            ]
          },
          "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
          "paymentDestination": {
            "type": "check",
            "addressLine1": "123 Main St",
            "city": "New York",
            "country": "US",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
            "isDefaultDestination": true,
            "isDefaultSource": false,
            "metadata": {},
            "payToTheOrderOf": "John Doe",
            "postalCode": "10001",
            "stateOrProvince": "NY",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "addressLine2": "Apt 1",
            "confirmedByEntity": true
          },
          "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
          "paymentSource": {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          },
          "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
          "transactions": [
            {
              "type": "bankAccountToBankAccount",
              "amount": 10000,
              "createdAt": "2024-01-01T00:00:00Z",
              "currency": "USD",
              "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "payer": {
                "acceptedTos": true,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "customer@acme.com",
                "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
                "isCustomer": true,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": false,
                "isPayor": true,
                "name": "Acme Inc.",
                "profile": {
                  "business": {
                    "legalBusinessName": "Acme Inc.",
                    "taxIDProvided": true,
                    "email": "customer@acme.com",
                    "businessType": "llc",
                    "phone": {
                      "countryCode": "1",
                      "number": "4155551234"
                    },
                    "address": {
                      "addressLine1": "123 Main St",
                      "city": "San Francisco",
                      "stateOrProvince": "CA",
                      "postalCode": "94105",
                      "addressLine2": "Unit 1",
                      "country": "US"
                    },
                    "ownersProvided": true,
                    "taxId": {
                      "ein": {
                        "number": "12-3456789"
                      }
                    }
                  }
                },
                "status": "verified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "accounts": [
                  {
                    "accountId": "85866843",
                    "postalCode": "94105",
                    "nameOnAccount": "John Doe"
                  }
                ],
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-12345",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "My Checking Account",
                    "accountNumber": "99988767623",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "12345678",
                    "status": "VERIFIED",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": true
                  }
                ]
              },
              "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
              "paymentDestination": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "paymentSource": {
                "type": "bankAccount",
                "accountName": "My Checking Account",
                "accountNumber": "99988767623",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "12345678",
                "status": "VERIFIED",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": true
              },
              "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
              "status": "FAILED",
              "updatedAt": "2024-01-01T00:00:00Z",
              "vendor": {
                "acceptedTos": false,
                "accountType": "business",
                "createdAt": "2024-01-01T00:00:00Z",
                "email": "vendor@bigboxstore.com",
                "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
                "isCustomer": false,
                "isNetworkPayee": false,
                "isNetworkPayor": false,
                "isPayee": true,
                "isPayor": false,
                "name": "Big Box Store",
                "profile": {
                  "business": {
                    "legalBusinessName": "Big Box Store",
                    "taxIDProvided": false,
                    "email": "vendor@bigboxstore.com",
                    "businessType": "publicCorporation",
                    "ownersProvided": false
                  }
                },
                "status": "unverified",
                "updatedAt": "2024-01-02T00:00:00Z",
                "counterpartyType": [
                  "ENTITY"
                ],
                "foreignId": "MY-DB-ID-90909",
                "paymentMethods": [
                  {
                    "type": "bankAccount",
                    "accountName": "Vendor Checking Account",
                    "accountNumber": "55934059697648",
                    "accountType": "CHECKING",
                    "bankName": "Chase",
                    "createdAt": "2021-01-01T00:00:00Z",
                    "frozen": false,
                    "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                    "isDefaultDestination": true,
                    "isDefaultSource": true,
                    "metadata": {},
                    "routingNumber": "66554433",
                    "status": "NEW",
                    "supportedCurrencies": [
                      "USD"
                    ],
                    "updatedAt": "2021-01-01T00:00:00Z",
                    "confirmedByEntity": false
                  }
                ]
              },
              "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
            }
          ],
          "vendor": {
            "acceptedTos": false,
            "accountType": "business",
            "createdAt": "2024-01-01T00:00:00Z",
            "email": "vendor@bigboxstore.com",
            "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
            "isCustomer": false,
            "isNetworkPayee": false,
            "isNetworkPayor": false,
            "isPayee": true,
            "isPayor": false,
            "name": "Big Box Store",
            "profile": {
              "business": {
                "legalBusinessName": "Big Box Store",
                "taxIDProvided": false,
                "email": "vendor@bigboxstore.com",
                "businessType": "publicCorporation",
                "ownersProvided": false
              }
            },
            "status": "unverified",
            "updatedAt": "2024-01-02T00:00:00Z",
            "counterpartyType": [
              "ENTITY"
            ],
            "foreignId": "MY-DB-ID-90909",
            "paymentMethods": [
              {
                "type": "bankAccount",
                "accountName": "Vendor Checking Account",
                "accountNumber": "55934059697648",
                "accountType": "CHECKING",
                "bankName": "Chase",
                "createdAt": "2021-01-01T00:00:00Z",
                "frozen": false,
                "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
                "isDefaultDestination": true,
                "isDefaultSource": true,
                "metadata": {},
                "routingNumber": "66554433",
                "status": "NEW",
                "supportedCurrencies": [
                  "USD"
                ],
                "updatedAt": "2021-01-01T00:00:00Z",
                "confirmedByEntity": false
              }
            ]
          },
          "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
        }
      ],
      "payer": {
        "acceptedTos": true,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "customer@acme.com",
        "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
        "isCustomer": true,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": false,
        "isPayor": true,
        "name": "Acme Inc.",
        "profile": {
          "business": {
            "legalBusinessName": "Acme Inc.",
            "taxIDProvided": true,
            "email": "customer@acme.com",
            "businessType": "llc",
            "phone": {
              "countryCode": "1",
              "number": "4155551234"
            },
            "address": {
              "addressLine1": "123 Main St",
              "city": "San Francisco",
              "stateOrProvince": "CA",
              "postalCode": "94105",
              "addressLine2": "Unit 1",
              "country": "US"
            },
            "ownersProvided": true,
            "taxId": {
              "ein": {
                "number": "12-3456789"
              }
            }
          }
        },
        "status": "verified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "accounts": [
          {
            "accountId": "85866843",
            "postalCode": "94105",
            "nameOnAccount": "John Doe"
          }
        ],
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-12345",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "My Checking Account",
            "accountNumber": "99988767623",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "12345678",
            "status": "VERIFIED",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": true
          }
        ]
      },
      "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
      "paymentDestination": {
        "type": "bankAccount",
        "accountName": "My Checking Account",
        "accountNumber": "99988767623",
        "accountType": "CHECKING",
        "bankName": "Chase",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
        "isDefaultDestination": true,
        "isDefaultSource": true,
        "metadata": {},
        "routingNumber": "12345678",
        "status": "VERIFIED",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "confirmedByEntity": true
      },
      "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
      "paymentSource": {
        "type": "bankAccount",
        "accountName": "My Checking Account",
        "accountNumber": "99988767623",
        "accountType": "CHECKING",
        "bankName": "Chase",
        "createdAt": "2021-01-01T00:00:00Z",
        "frozen": false,
        "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
        "isDefaultDestination": true,
        "isDefaultSource": true,
        "metadata": {},
        "routingNumber": "12345678",
        "status": "VERIFIED",
        "supportedCurrencies": [
          "USD"
        ],
        "updatedAt": "2021-01-01T00:00:00Z",
        "confirmedByEntity": true
      },
      "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
      "status": "FAILED",
      "updatedAt": "2024-01-01T00:00:00Z",
      "vendor": {
        "acceptedTos": false,
        "accountType": "business",
        "createdAt": "2024-01-01T00:00:00Z",
        "email": "vendor@bigboxstore.com",
        "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
        "isCustomer": false,
        "isNetworkPayee": false,
        "isNetworkPayor": false,
        "isPayee": true,
        "isPayor": false,
        "name": "Big Box Store",
        "profile": {
          "business": {
            "legalBusinessName": "Big Box Store",
            "taxIDProvided": false,
            "email": "vendor@bigboxstore.com",
            "businessType": "publicCorporation",
            "ownersProvided": false
          }
        },
        "status": "unverified",
        "updatedAt": "2024-01-02T00:00:00Z",
        "counterpartyType": [
          "ENTITY"
        ],
        "foreignId": "MY-DB-ID-90909",
        "paymentMethods": [
          {
            "type": "bankAccount",
            "accountName": "Vendor Checking Account",
            "accountNumber": "55934059697648",
            "accountType": "CHECKING",
            "bankName": "Chase",
            "createdAt": "2021-01-01T00:00:00Z",
            "frozen": false,
            "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
            "isDefaultDestination": true,
            "isDefaultSource": true,
            "metadata": {},
            "routingNumber": "66554433",
            "status": "NEW",
            "supportedCurrencies": [
              "USD"
            ],
            "updatedAt": "2021-01-01T00:00:00Z",
            "confirmedByEntity": false
          }
        ]
      },
      "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
    }
  ]
}

Search transactions

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringOptional

Filter transactions by the ID or foreign ID of the entity that created the transaction.

entityGroupIdstringOptional

Filter transactions by the ID or foreign ID of the entity group that the entity belongs to.

startDatedatetimeOptional

CREATED_AT Start date filter.

endDatedatetimeOptional

CREATED_AT End date filter.

limitintegerOptional

Number of transactions to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the transactions to start after. If not provided, the first page of transactions will be returned.

searchstringOptional

Find transactions by vendor name, invoice number, check number, or amount. Partial matches are supported.

metadataobjectOptional

Filter transactions by invoice metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

lineItemMetadataobjectOptional

Filter transactions by invoice line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

lineItemGlAccountIdstringOptional

Filter transactions by invoice line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.

payerIdstringOptional

Filter transactions by payer ID or payer foreign ID.

vendorIdstringOptional

Filter transactions by vendor ID or vendor foreign ID.

invoiceIdstringOptional

Filter transactions by invoice ID or invoice foreign ID.

transactionIdstringOptional

Filter transactions by transaction ID.

statusenumOptional

Transaction status to filter on

transactionTypeenumOptional

Filter transactions by transaction type

creatorUserIdstringOptionalDeprecated

Filter transactions by creator user ID. Does not work, do not use.

Response

This endpoint returns an object.

countinteger

hasMoreboolean

datalist of objects

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented