Credit card accounts

Sage Intacct defines credit card accounts as including both credit cards and debit cards. In Accounts Payable, there's a difference between the two.

  • A credit card is a cash account that's related to a credit card vendor. The credit card account in Sage Intacct represents the actual credit card in the real world. Record charges made on this card in the Cash Management application.

  • A debit card is associated with a checking account and is another way to debit that account. When a debit card charge is recorded, the bank account is debited and the transaction is final.

Although treated differently in Accounts Payable, credit and debit cards are treated the same way in Accounts Receivable. A customer payment made with either type of credit card debits that customer account and deposits the payment into your account.

List credit card accounts

get/objects/cash-management/credit-card-account

Returns a collection with a key, ID, and link for each credit card account. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness
PermissionsList, View Credit card accounts
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "MC001",
      • "href": "/objects/cash-management/credit-card-account/1"
      },
    • {
      • "key": "2",
      • "id": "MC002",
      • "href": "/objects/cash-management/credit-card-account/2"
      },
    • {
      • "key": "3",
      • "id": "AMEX_CARD_1",
      • "href": "/objects/cash-management/credit-card-account/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Create a credit card account

post/objects/cash-management/credit-card-account

Creates a new credit card account.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness, Employee, Project Manager
PermissionsList, View, Add Credit card accounts
SecurityOAuth2
Request
Request Body schema: application/json
id
required
string

Name or other unique identifier for the credit card account. The account ID cannot be modified.

Example: "Card101"
required
object

The vendor is the credit card provider. Associate the credit card with a vendor to pay off the credit card in accounts payable. All credit card charges and payments go to the ledger for this vendor. Use a unique vendor for each credit card account. The vendor cannot be changed after the credit card account is created.

key
string

System-assigned key for the credit card vendor.

Example: "122"
id
string

ID for the credit card vendor.

Example: "Amex 1"
object

Credit/debit card account details.

accountType
required
string

Account type, credit or debit. Credit cards require an associated vendor and offset GL account. Debit cards used to pay bills require an associated checking account and vendor.

Enum: "credit" "debit"
Example: "credit"
cardType
required
string

Specifies the card type. The card type cannot be changed after the account is created.

Enum: "americanExpress" "dinersClub" "discover" "mastercard" "otherChargeCard" "visa"
Example: "visa"
expirationMonth
required
string

Month when the credit card expires.

Enum: "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "11" "12"
Example: "11"
expirationYear
required
string

Year when the credit card expires.

Example: "2032"
description
string

Optional description about how this card is used.

Example: "Travel Visa card 1"
number
string

Required only if the cardType is americanExpress. This is a 16-digit card number without spaces or hyphens.

Example: "xxxxxxxxxxxx1111"
object

Billing address for the credit card.

addressLine1
string

Street address

Example: "300 Park Ave"
addressLine2
string

Suite or unit number

Example: "1400"
addressLine3
string

Address line 3

Example: "Western industrial area"
city
string

City

Example: "San Jose"
state
string

State

Example: "CA"
postCode
string

Zip or postal code

Example: "10001"
country
string

Country

Example: "USA"
countryCode
string

ISO country code. When ISO country codes are enabled for a company, both country and countryCode must be provided.

Example: "US"
object

Accounting information for the credit card account.

required
object

Credit card offset GL account, which is the offset account used to track the credit card liability.

key
string

System-assigned key of the offset GL account.

Example: "155"
id
string

ID for the offset GL account.

Example: "11000"
object

GL account to use for finance charges and other fees during reconciliation if those fees are to be tracked separately.

key
string

System-assigned key for the GL account.

Example: "201"
id
string

ID for the GL account.

Example: "4562.67"
object

Finance charges AP account label.

key
string

System-assigned key for the AP account label.

Example: "22"
id
string

ID for the AP account label.

Example: "Finance Charges"
object

Other fees GL account used only for credit card reconciliation; does not apply to debit cards.

key
string

System-assigned key for the GL account.

Example: "33"
id
string

ID for the GL account.

Example: "3556.1"
object

Other fees AP account label.

key
string

System-assigned key for the AP account label.

Example: "5"
id
string

ID for the AP account label.

Example: "Other fees"
object

Default accrual basis journal.

key
string

System-assigned key for the GL journal.

Example: "13"
id
string

ID for the GL journal.

Example: "GJ"
object

Default cash basis journal. For dual-method reporting, separate accrual and cash journals can be specified.

key
string

System-assigned key for the GL journal.

Example: "33"
id
string

ID for the GL journal.

Example: "IJ"
object

GL account to use for employee expense.

key
string

System-assigned key for the GL account.

Example: "201"
id
string

ID for the GL account.

Example: "4562.67"
object

Employee expense AP account label.

key
string

System-assigned key for the AP account label.

Example: "22"
id
string

ID for the AP account label.

Example: "Employee Expense"
bankingTimeZone
string or null
Default: null

Time zone

Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "GMT+04:30 Kabul" "GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent" "GMT+05:30 Bombay, Calcutta, Madras, New Delhi" "GMT+06:00 Almaty, Dhaka" "GMT+07:00 Bangkok, Jakarta, Hanoi" "GMT+08:00 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight Time" "GMT+11:00 (Australian) Eastern Daylight Time" "GMT+12:00 Fiji Islands, Marshall Islands" "GMT+12:00 Kamchatka" "GMT+12:00 Magadan, Solomon Islands, New Caledonia" "GMT+12:00 Wellington, Auckland" "GMT+13:00 Nuku`alofa" "GMT+13:00 Samoa" "GMT-01:00 Azores, Cape Verde Island" "GMT-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null
Example: "GMT+02:00 Eastern Europe Time"
disableInterEntityTransfer
boolean
Default: false

Set to true to disable inter-entity transfers.

Example: false
useInEmployeeExpense
boolean
Default: false

Set to true to use this credit card account for employee expense.

Example: false
object

Reconciliation information for the credit card account; does not apply to debit card accounts.

object

Reconciliation match sequence. This is a document sequence that tracks matches in reconciliation.

key
string or null

System-assigned key for the document sequence number.

Example: "2"
id
string or null

Document sequence ID

Example: "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
Default: true

Use sequence number for transactions that were matched automatically with a rule set.

Example: false
useMatchSequenceForManualMatch
boolean
Default: true

Use sequence number for manually matched transactions.

Example: false
object

Default department to associate with this card account.

key
string

System-assigned key for the department.

Example: "11"
id
string

ID for the department.

Example: "8"
object

Default location for transactions that draw on this account.

key
string

System-assigned key for the location.

Example: "5"
id
string

ID for the location.

Example: "CA"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
object
object

Rule set to use during reconciliation. If the credit card will be reconciled using a bank feed, this rule set matches incoming bank transactions to Sage Intacct transactions.

key
string

System-assigned key for the rule set.

Example: "36"
id
string

ID for the rule set.

Example: "36--RuleSetToMatch"
Responses
201

Created

Request samples
application/json
{
  • "id": "V002",
  • "accountDetails": {
    • "description": "Card for employee expense",
    • "cardType": "visa",
    • "expirationMonth": "01",
    • "expirationYear": "2028",
    • "billingAddress": {
      • "addressLine1": "1295",
      • "addressLine2": null,
      • "addressLine3": "Adobe Ave",
      • "city": "San Jose",
      • "country": "United States",
      • "countryCode": "US",
      • "postCode": "978754",
      • "state": "CA"
      },
    • "accountType": "credit",
    • "currency": "USD"
    },
  • "status": "active",
  • "accounting": {
    • "offsetGLAccount": {
      • "id": "4564.44.44",
      • "key": "561"
      },
    • "otherFeesGLAccount": {
      • "id": "0077",
      • "key": "432"
      },
    • "defaultAccrualBasisGLJournal": {
      • "id": "DISB",
      • "key": "14"
      },
    • "disableInterEntityTransfer": false
    },
  • "vendor": {
    • "id": "First Security - Gold",
    • "key": "263"
    },
  • "department": {
    • "id": "CHS--Channel Sales",
    • "key": "34"
    },
  • "location": {
    • "id": "San Francisco"
    },
  • "reconciliation": {
    • "matchSequence": {
      • "id": "48--bankseq-1"
      },
    • "useMatchSequenceForAutoMatch": true,
    • "useMatchSequenceForManualMatch": true
    },
  • "ruleSet": {
    • "key": "35",
    • "id": "35--creditcard"
    }
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "34",
    • "id": "V002",
    • "href": "/objects/cash-management/credit-card-account/34"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a credit card account

get/objects/cash-management/credit-card-account/{key}

Returns detailed information for a specified credit card account.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness, Employee, Project Manager
PermissionsList, View Credit card accounts
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the credit card account.

Example: 81
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "106",
    • "id": "V002",
    • "accountDetails": {
      • "description": "card for employee expense",
      • "cardType": "visa",
      • "expirationMonth": "01",
      • "expirationYear": "2028",
      • "billingAddress": {
        },
      • "accountType": "credit",
      • "debitCardCheckingAccount": {
        },
      • "currency": "USD"
      },
    • "status": "active",
    • "accounting": {
      • "offsetGLAccount": {
        },
      • "otherFeesGLAccount": {
        },
      • "defaultAccrualBasisGLJournal": {
        },
      • "defaultCashBasisGLJournal": {
        },
      • "bankingTimeZone": "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels",
      • "disableInterEntityTransfer": false,
      • "otherFeesAPAccountLabel": {
        },
      • "financeChargeGLAccount": {
        },
      • "financeChargeAPAccountLabel": {
        },
      • "useInEmployeeExpense": true,
      • "employeeExpenseGLAccount": {
        },
      • "employeeExpenseAccountLabel": {
        }
      },
    • "vendor": {
      • "id": "First Security - Gold",
      • "key": "35",
      • "href": "/objects/accounts-payable/vendor/35"
      },
    • "department": {
      • "id": "COMP--Compliance",
      • "key": "16",
      • "href": "/objects/company-config/department/16"
      },
    • "location": {
      • "id": "San Francisco",
      • "key": "24",
      • "href": "/objects/company-config/location/24"
      },
    • "reconciliation": {
      • "lastReconciledDate": null,
      • "lastReconciledBalance": null,
      • "inProgressDate": null,
      • "inProgressBalance": null,
      • "matchSequence": {
        },
      • "useMatchSequenceForAutoMatch": true,
      • "useMatchSequenceForManualMatch": true,
      • "cutOffDate": null
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "audit": {
      • "modifiedDateTime": "2024-03-12T23:46:56Z",
      • "createdDateTime": "2024-03-04T20:33:04Z",
      • "modifiedBy": "1",
      • "createdBy": "1"
      },
    • "bankingCloudConnection": {
      • "status": null,
      • "bankName": null,
      • "name": null,
      • "lastBankTxnDateTime": null,
      • "lastRefreshedDateTime": null,
      • "refreshStatus": null,
      • "supportMultiAccountLinking": null
      },
    • "financialInstitution": {
      • "key": null,
      • "id": null
      },
    • "ruleSet": {
      • "id": "35--creditcard",
      • "key": "35",
      • "href": "/objects/cash-management/bank-txn-rule-set/35"
      },
    • "href": "/objects/cash-management/credit-card-account/106"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update a credit card account

patch/objects/cash-management/credit-card-account/{key}

Updates an existing credit card account by setting field values. Any fields not provided remain unchanged.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness
PermissionsList, Edit Credit card accounts
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the credit card account.

Example: 81
Request Body schema: application/json
object

Credit/debit card account details.

description
string

Optional description about how this card is used.

Example: "Travel Visa card 1"
cardType
string

Specifies the card type. The card type cannot be changed after the account is created.

Enum: "americanExpress" "dinersClub" "discover" "mastercard" "otherChargeCard" "visa"
Example: "visa"
number
string

Required only if the cardType is americanExpress. This is a 16-digit card number without spaces or hyphens.

Example: "xxxxxxxxxxxx1111"
accountType
string

Account type, credit or debit. Credit cards require an associated vendor and offset GL account. Debit cards used to pay bills require an associated checking account and vendor.

Enum: "credit" "debit"
Example: "credit"
expirationMonth
string

Month when the credit card expires.

Enum: "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "11" "12"
Example: "11"
expirationYear
string

Year when the credit card expires.

Example: "2032"
object

Billing address for the credit card.

addressLine1
string

Street address

Example: "300 Park Ave"
addressLine2
string

Suite or unit number

Example: "1400"
addressLine3
string

Address line 3

Example: "Western industrial area"
city
string

City

Example: "San Jose"
state
string

State

Example: "CA"
postCode
string

Zip or postal code

Example: "10001"
country
string

Country

Example: "USA"
countryCode
string

ISO country code. When ISO country codes are enabled for a company, both country and countryCode must be provided.

Example: "US"
object

Accounting information for the credit card account.

object

Credit card offset GL account, which is the offset account used to track the credit card liability.

key
string

System-assigned key of the offset GL account.

Example: "155"
id
string

ID for the offset GL account.

Example: "11000"
object

GL account to use for finance charges and other fees during reconciliation if those fees are to be tracked separately.

key
string

System-assigned key for the GL account.

Example: "201"
id
string

ID for the GL account.

Example: "4562.67"
object

Finance charges AP account label.

key
string

System-assigned key for the AP account label.

Example: "22"
id
string

ID for the AP account label.

Example: "Finance Charges"
object

Other fees GL account used only for credit card reconciliation; does not apply to debit cards.

key
string

System-assigned key for the GL account.

Example: "33"
id
string

ID for the GL account.

Example: "3556.1"
object

Other fees AP account label.

key
string

System-assigned key for the AP account label.

Example: "5"
id
string

ID for the AP account label.

Example: "Other fees"
object

Default accrual basis journal.

key
string

System-assigned key for the GL journal.

Example: "13"
id
string

ID for the GL journal.

Example: "GJ"
object

Default cash basis journal. For dual-method reporting, separate accrual and cash journals can be specified.

key
string

System-assigned key for the GL journal.

Example: "33"
id
string

ID for the GL journal.

Example: "IJ"
object

GL account to use for employee expense.

key
string

System-assigned key for the GL account.

Example: "201"
id
string

ID for the GL account.

Example: "4562.67"
object

Employee expense AP account label.

key
string

System-assigned key for the AP account label.

Example: "22"
id
string

ID for the AP account label.

Example: "Employee Expense"
bankingTimeZone
string or null
Default: null

Time zone

Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "GMT+04:30 Kabul" "GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent" "GMT+05:30 Bombay, Calcutta, Madras, New Delhi" "GMT+06:00 Almaty, Dhaka" "GMT+07:00 Bangkok, Jakarta, Hanoi" "GMT+08:00 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight Time" "GMT+11:00 (Australian) Eastern Daylight Time" "GMT+12:00 Fiji Islands, Marshall Islands" "GMT+12:00 Kamchatka" "GMT+12:00 Magadan, Solomon Islands, New Caledonia" "GMT+12:00 Wellington, Auckland" "GMT+13:00 Nuku`alofa" "GMT+13:00 Samoa" "GMT-01:00 Azores, Cape Verde Island" "GMT-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null
Example: "GMT+02:00 Eastern Europe Time"
disableInterEntityTransfer
boolean
Default: false

Set to true to disable inter-entity transfers.

Example: false
useInEmployeeExpense
boolean
Default: false

Set to true to use this credit card account for employee expense.

Example: false
object

Reconciliation information for the credit card account; does not apply to debit card accounts.

object

Reconciliation match sequence. This is a document sequence that tracks matches in reconciliation.

key
string or null

System-assigned key for the document sequence number.

Example: "2"
id
string or null

Document sequence ID

Example: "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
Default: true

Use sequence number for transactions that were matched automatically with a rule set.

Example: false
useMatchSequenceForManualMatch
boolean
Default: true

Use sequence number for manually matched transactions.

Example: false
object

Default department to associate with this card account.

key
string

System-assigned key for the department.

Example: "11"
id
string

ID for the department.

Example: "8"
object

Default location for transactions that draw on this account.

key
string

System-assigned key for the location.

Example: "5"
id
string

ID for the location.

Example: "CA"
object

The vendor is the credit card provider. Associate the credit card with a vendor to pay off the credit card in accounts payable. All credit card charges and payments go to the ledger for this vendor. Use a unique vendor for each credit card account. The vendor cannot be changed after the credit card account is created.

key
string

System-assigned key for the credit card vendor.

Example: "122"
id
string

ID for the credit card vendor.

Example: "Amex 1"
status
string
Default: "active"

Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.

Enum: "active" "inactive"
Example: "active"
object
object

Rule set to use during reconciliation. If the credit card will be reconciled using a bank feed, this rule set matches incoming bank transactions to Sage Intacct transactions.

key
string

System-assigned key for the rule set.

Example: "36"
id
string

ID for the rule set.

Example: "36--RuleSetToMatch"
Responses
200

OK

Request samples
application/json
{
  • "accountDetails": {
    • "description": "Card for employee expenses",
    • "expirationMonth": "01",
    • "expirationYear": "2030"
    }
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "32",
    • "id": "V002",
    • "href": "/objects/cash-management/credit-card-account/32"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a credit card account

delete/objects/cash-management/credit-card-account/{key}

Deletes a credit card account. You cannot delete a credit card account that has subledger transactions associated with it.

Permissions and other requirements
SubscriptionCash Management
User typeBusiness, Project Manager
PermissionsList, Delete Credit card accounts
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the credit card account.

Example: 81
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}

Query credit card accounts

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "cash-management/credit-card-account"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

Example: ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
Array
Any of:

Field value must be equal to this specified value.

For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
Array of objects

Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.

Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
Array
property name*
additional property
string
Enum: "asc" "desc"
start
integer

First record of the result set to include in the response.

Example: 1
size
integer

Number of records to include in the response.

Example: 100
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "cash-management/credit-card-account",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "accountDetails.accountType",
    • "status"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "6",
      • "id": "Bonus Points Card",
      • "accountDetails.accountType": "credit",
      • "status": "active"
      },
    • {
      • "key": "4",
      • "id": "Utilities Card",
      • "accountDetails.accountType": "credit",
      • "status": "active"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}