Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041351024.8 MB

21d41189c461

Payment methods

Get payment method

The Get payment method endpoint returns a single payment method for a given paymentMethodId.

Payment methods are used to pay a Bill. Payment Methods are referenced on Bill Payments and Payments.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/paymentMethods/{paymentMethodId}

Response

Success

idstring

Unique identifier for the payment method.

namestring nullable

Name of the payment method.

typePaymentMethodType — unresolved $ref
status'Unknown' | 'Active' | 'Archived'

Status of the Payment Method.

modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.