Payment Methods

Explore the PaymentMethods endpoint in Swagger.

Overview

A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on Bill Payments.

From the Payment Methods endpoints you can retrieve:

  • A list of all the Payment Methods of used by a company: GET/companies/{companyId}/data/paymentMethods.
  • The details of an individual Payment Method:
    GET /companies/{companyId}/data/paymentMethods/{paymentMethodId}.

Data model

Field

Type

Decription

id

string

Unique identifier for the payment method.

name

string

Name of the payment method

type

string

Method of payment:

  • Cash
  • Check
  • CreditCard
  • DebitCard
  • BankTransfer
  • Unknown
  • Other

status

string

Status of the Payment Method:

  • Active: Available for use
  • Archived: Unavailable
  • Unknown

modifiedDate

string
See date

Date the payment method details were last updated in the Codat system.

sourceModifiedDate

string
See date

Date the payment method details were last changed in the accounting system.

Example data

{
    "id": "15",
    "name": "Team Credit Card", 
    "type": "CreditCard",
    "status": "Active",
    "modifiedDate": null , 
    "sourceModifiedDate": "2020-08-12T14:37:37"  
}

Did this page help you?