v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Payments

List payments

Returns the payments generated in Embat for a company. Payments you created through POST /payments/{companyId} are not included here — retrieve them by customId with GET /payments/{companyId}/{customId} instead. Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page. startDate/endDate filter by payment date, and startUpdatedAt/endUpdatedAt filter by last modification time, which is useful for incremental synchronization. startDate/startUpdatedAt are inclusive, endDate/endUpdatedAt are exclusive, and each date range spans at most 90 days. Payments missing required accounting, operation or contact information are excluded from the results.

get/payments/{companyId}

Path parameters

companyIdstring required

Query parameters

productIdstring

Filter payments linked to a given product (productId).

syncboolean

Filter by synchronization status with the accounting system. false also matches payments where the value is not set.

registeredboolean

Filter by registration status in the accounting system. false also matches payments where the value is not set.

startDatestring date

Only return payments dated on or after this date (inclusive). The range cannot exceed 90 days: if endDate is also given, the span between the two cannot exceed 90 days; if endDate is omitted, startDate cannot be more than 90 days in the past.

endDatestring date

Only return payments dated before this date (exclusive). Combined with startDate, the range cannot exceed 90 days. If used without startDate, results start 90 days before this date.

startUpdatedAtstring date-time

Only return payments last modified on or after this timestamp (inclusive). The range cannot exceed 90 days: if endUpdatedAt is also given, the span between the two cannot exceed 90 days; if endUpdatedAt is omitted, startUpdatedAt cannot be more than 90 days in the past.

endUpdatedAtstring date-time

Only return payments last modified before this timestamp (exclusive). Combined with startUpdatedAt, the range cannot exceed 90 days. If used without startUpdatedAt, results start 90 days before this timestamp.

internalAttributesboolean

Include attributes flagged as internal in the response.

limitinteger

Maximum number of objects to return in the response. Default 500, maximum 2000.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "method": "bank-transaction",
      "operations": [
        {
          "amount": 500,
          "customId": "invoice-2024-001"
        }
      ],
      "concept": "Invoice #2024-001 payment",
      "amount": 1250.5,
      "accountingAmount": 1250.5,
      "exchangeRate": 1,
      "attributes": [
        {
          "customId": "cost-center",
          "value": "Marketing",
          "valueCustomId": "marketing"
        }
      ],
      "error": "Missing account",
      "contact": {
        "tradeName": "Acme Supplies",
        "legalName": "Acme Supplies S.L.",
        "taxId": "B12345678",
        "contact": {
          "phone": "+34600000000",
          "email": "billing@acme-supplies.com",
          "name": "John",
          "surname": "Doe"
        },
        "address": {
          "postalCode": "28001",
          "address": "Calle Mayor 10, 3B",
          "province": "Madrid",
          "city": "Madrid",
          "country": "Spain"
        },
        "accounts": [
          {
            "swift": "BBVAESMMXXX",
            "iban": "ES9121000418450200051332"
          }
        ],
        "paymentsAccounts": [
          {
            "details": {
              "iban": "ES9121000418450200051332",
              "bic": "BBVAESMMXXX",
              "swift": "BBVAESMMXXX",
              "accountNumber": "123456789",
              "routingNumber": "021000021",
              "sortCode": "040004",
              "institutionNumber": "001",
              "transitNumber": "12345",
              "bsb": "062-000"
            }
          }
        ],
        "accountingCode": "4300001",
        "paymentMethod": "bank-transaction",
        "paymentTerms": 30,
        "attributes": [
          {
            "customId": "cost-center",
            "value": "Marketing",
            "valueCustomId": "marketing"
          }
        ],
        "customId": "erp-contact-001"
      },
      "intercompany": {
        "id": "proc-abc",
        "relatedPaymentPairs": [
          [
            "pay-hub-A",
            "pay-sub-1"
          ],
          [
            "pay-hub-B",
            "pay-sub-2"
          ]
        ],
        "relatedPaymentsIds": [
          "pay-hub-A"
        ],
        "counterpartyContact": "contact-sub-1"
      },
      "transactionAttributes": [
        {
          "customId": "cost-center",
          "value": "Marketing",
          "valueCustomId": "marketing"
        }
      ]
    }
  ]
}