Credit card transactions

Transaction record for charges against credit and debit cards.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List credit card transactions

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

Returns a collection with a key, ID, and link for each credit card transaction. 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 transactions
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/cash-management/credit-card-txn/2"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/cash-management/credit-card-txn/4"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/cash-management/credit-card-txn/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a credit card transaction
post/objects/cash-management/credit-card-txn
Creates a new credit card transaction.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsList, View, Add Credit card transactions







SecurityOAuth2 
Request 
Request Body schema: application/json
txnDate
required
string <date> 
Date of the credit card transaction.


 
 Example:  "2021-11-30"
object
Credit card account used for this transaction.


 
id
required
string
ID for the credit card account.


 
 Example:  "amex-card-1"
key
string
System-assigned key for the credit card account.


 
 Example:  "3"
referenceNumber
string
Reference number for the credit card transaction, such as the transaction number from the credit card statement.


 
 Example:  "Ref--cc12"
payee
string
Name of the payee for the transaction.


 
 Example:  "Vend-1"
description
string
Brief description of the purpose of the transaction.


 
 Example:  "Meals"
object
Supporting document attached to this transaction.


 
key
string
System-assigned key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 Example:  "1"
object
Currency details for the transaction.


 
txnCurrency
required
string
Transaction currency for this credit card transaction.


 
 Example:  "GBP"
baseCurrency
string
Base currency for the company.


 
 Example:  "USD"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date used to calculate the base amount from the transaction amount.


 
 Example:  "2021-01-23"
rate
number
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "Intacct Daily Rate"
isInclusiveTax
boolean
 Default:  false
Indicates whether the transaction is tax inclusive.


 
 Example:  true
object
Tax solution used to calculate and capture taxes on this transaction.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "4"
id
string
Name or other unique identifier for the tax solution.


 
 Example:  "Australia GST"
Array of objects
Line items for the credit card transaction.


 
 Array 
txnAmount
required
string <decimal-precision-2> 
For multi-currency companies, the amount in the transaction currency.


 
 Example:  "2003.00"
required
object
 
totalTxnAmount
string <decimal-precision-2> 
For multi-currency companies, amount of the credit card transaction line item.


 
 Example:  "100.99"
description
string
Memo or notes about the line item.


 
 Example:  "Entertainment charges"
isBillable
boolean
 Default:  false
Indicates whether a line item is billable.


 
 Example:  true
isBilled
boolean
 Default:  false
Indicates whether a line item is already billed.


 
 Example:  false
object
Label for the AP account associated with the line item.


 
object
Tax details from Purchasing.


 
object
 
object
Base location for the line item in multi-entity companies.


 
Array of objects
Tax Entries of the credit card transaction


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "txnDate": "2024-04-5",
  • "creditCardAccount": {
    • "id": "A0000001"
    },
  • "referenceNumber": "CCTxn-001",
  • "payee": "Vendor-AAA",
  • "description": "Travel expenses",
  • "isInclusiveTax": true,
  • "currency": {
    • "baseCurrency": "USD",
    • "txnCurrency": "CAD",
    • "exchangeRate": {
      • "date": "2023-12-04",
      • "typeId": "Intacct Daily Rate",
      • "rate": 0.7306
      }
    },
  • "taxSolution": {
    • "key": "5",
    • "id": "Canadian Sales Tax - SYS"
    },
  • "attachment": {
    • "id": "111",
    • "key": "2"
    },
  • "lines": [
    • {
      • "glAccount": {
        },
      • "totalTxnAmount": "500.00",
      • "dimensions": {
        },
      • "description": "Travel expenses - Eberhardt",
      • "taxEntries": [
        ],
      • "isBillable": false,
      • "isBilled": false
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "12",
    • "key": "12",
    • "href": "/objects/cash-management/credit-card-txn/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a credit card transaction
get/objects/cash-management/credit-card-txn/{key}
Returns detailed information for a specified credit card transaction.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness


PermissionsList, View Credit card transactions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "27",
    • "key": "27",
    • "creditCardAccount": {
      • "id": "A0000001",
      • "key": "1",
      • "href": "/objects/cash-management/credit-card-account/1"
      },
    • "txnDate": "2024-04-05",
    • "audit": {
      • "createdDateTime": "2024-04-05T00:00:00Z",
      • "modifiedDateTime": "2024-04-05T06:18:08Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "referenceNumber": "CCTxn-001",
    • "payee": "Vendor-AAA",
    • "description": "Travel expenses in december",
    • "currency": {
      • "baseCurrency": "USD",
      • "txnCurrency": "CAD",
      • "exchangeRate": {
        }
      },
    • "totalEntered": "365.30",
    • "txnTotalEntered": "500.00",
    • "totalPaid": "0.00",
    • "txnTotalPaid": "0.00",
    • "totalSelected": "0.00",
    • "txnTotalSelected": "0.00",
    • "totalDue": "365.30",
    • "txnTotalDue": "500.00",
    • "whenPaid": null,
    • "reversedBy": {
      • "id": null,
      • "key": null,
      • "reversalDate": null
      },
    • "reversalOf": {
      • "id": null,
      • "key": null,
      • "txnDate": null
      },
    • "state": "posted",
    • "reconciliationState": "uncleared",
    • "isInclusiveTax": true,
    • "taxSolution": {
      • "key": "5",
      • "id": "Canadian Sales Tax - SYS",
      • "href": "/objects/tax/tax-solution/5"
      },
    • "transactionSource": null,
    • "attachment": {
      • "id": "111",
      • "key": "20",
      • "href": "/objects/company-config/attachment/20"
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/credit-card-txn/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a credit card transaction
patch/objects/cash-management/credit-card-txn/{key}
Updates an existing credit card transaction by setting field values. Any fields not provided remain unchanged. Credit card transactions can be updated if they are:


    

  • Not yet included in a charge payoff
    • 

  • Not included in an employee expense report
    • 

  • Not yet reconciled
    • 



For more information, see Edit a credit card transaction in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness, Employee


PermissionsList, View, Edit Credit card transactions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction.


 
Request Body schema: application/json
txnDate
string <date> 
Date of the credit card transaction.


 
 Example:  "2021-11-30"
object
Credit card account used for this transaction.


 
key
string
System-assigned key for the credit card account.


 
 Example:  "3"
id
string
ID for the credit card account.


 
 Example:  "amex-card-1"
referenceNumber
string
Reference number for the credit card transaction, such as the transaction number from the credit card statement.


 
 Example:  "Ref--cc12"
payee
string
Name of the payee for the transaction.


 
 Example:  "Vend-1"
description
string
Brief description of the purpose of the transaction.


 
 Example:  "Meals"
object
Supporting document attached to this transaction.


 
key
string
System-assigned key for the attachment.


 
 Example:  "1"
id
string
ID for the attachment.


 
 Example:  "1"
object
Currency details for the transaction.


 
baseCurrency
string
Base currency for the company.


 
 Example:  "USD"
txnCurrency
string
Transaction currency for this credit card transaction.


 
 Example:  "GBP"
object
Exchange rate details used to calculate the base amount.


 
date
string <date> 
Exchange rate date used to calculate the base amount from the transaction amount.


 
 Example:  "2021-01-23"
rate
number
Exchange rate used to calculate the base amount from the transaction amount.


 
 Example:  1.0789
typeId
string
Exchange rate type used to calculate the base amount from the transaction amount.


 
 Example:  "Intacct Daily Rate"
isInclusiveTax
boolean
 Default:  false
Indicates whether the transaction is tax inclusive.


 
 Example:  true
object
Tax solution used to calculate and capture taxes on this transaction.


 
key
string
System-assigned key for the tax solution.


 
 Example:  "4"
id
string
Name or other unique identifier for the tax solution.


 
 Example:  "Australia GST"
Array of objects
Line items for the credit card transaction.


 
 Array 
totalTxnAmount
string <decimal-precision-2> 
For multi-currency companies, amount of the credit card transaction line item.


 
 Example:  "100.99"
txnAmount
string <decimal-precision-2> 
For multi-currency companies, the amount in the transaction currency.


 
 Example:  "2003.00"
description
string
Memo or notes about the line item.


 
 Example:  "Entertainment charges"
isBillable
boolean
 Default:  false
Indicates whether a line item is billable.


 
 Example:  true
isBilled
boolean
 Default:  false
Indicates whether a line item is already billed.


 
 Example:  false
object
Label for the AP account associated with the line item.


 
object
 
object
Tax details from Purchasing.


 
object
 
object
Base location for the line item in multi-entity companies.


 
Array of objects
Tax Entries of the credit card transaction


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Travel expenses in december",
  • "attachment": {
    • "id": "travel-receipt"
    },
  • "isInclusiveTax": true,
  • "lines": [
    • {
      • "key": "92",
      • "creditCardTxn": {
        },
      • "description": "Travel expenses - Eberhardt",
      • "totalTxnAmount": "500.00",
      • "taxEntries": [
        ]
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "12",
    • "key": "12",
    • "href": "/objects/cash-management/credit-card-txn/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a credit card transaction
delete/objects/cash-management/credit-card-txn/{key}
Deletes a credit card transaction. You can delete a credit card transaction if it is:


    

  • Associated with a credit card, not a debit card
    • 

  • Not included in a charge payoff or an expense report
    • 

  • Not paid or partially paid
    • 

  • Not reconciled or matched for reconciliation
    • 



For more information, see Delete or reverse a credit card transaction in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness, Employee


PermissionsList, View, Delete Credit card transactions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the credit card transaction.


 
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
    }
}
Reverse a credit card transaction
post/workflows/cash-management/credit-card-txn/reverse
Reverses a credit card transaction. You can reverse a credit card transaction when:


    

  • You have permission to reverse.
    • 

  • The transaction is included in a charge payoff, but the associated bill in Accounts Payable has not yet been paid.
    • 

  • The transaction is not included in an expense report.
    • 

  • The transaction has not been reconciled or matched for reconciliation.
    • 



For more information, see Reverse a credit card transaction in the Sage Intacct Help Center.



Permissions and other requirements



SubscriptionCash Management


User typeBusiness, Employee


PermissionsList, View, Reverse Credit card transactions







SecurityOAuth2 
Request 
Request Body schema: application/json
key
string
System-assigned key for the credit card transaction.


 
 Example:  "49"
reversedDate
string <date> 
Date this transactions is reversed.


 
 Example:  "2024-04-15"
memo
string
Notes or comments about the reason for the reverse of credit card transaction.


 
 Example:  "Reversed the credit card transaction for duplicate entry"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "49",
  • "reversedDate": "2024-04-15",
  • "memo": "Reversed the credit card transaction for duplicate entry"
}
Response samples 
application/json
{
  • "key": "50",
  • "id": "50",
  • "href": "/objects/cash-management/credit-card-txn/50",
  • "state": "reversed"
}
Query credit card transactions
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-txn"
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-txn",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "whenPaid",
    • "totalPaid"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1092",
      • "id": "1092",
      • "whenPaid": "2023-12-15",
      • "totalPaid": "100.00"
      },
    • {
      • "key": "1148",
      • "id": "1148",
      • "whenPaid": "2024-01-01",
      • "totalPaid": "500.00"
      },
    • {
      • "key": "1330",
      • "id": "1330",
      • "whenPaid": "2024-02-15",
      • "totalPaid": "1000.00"
      },
    • {
      • "key": "1332",
      • "id": "1332",
      • "whenPaid": "2024-04-30",
      • "totalPaid": "2000.00"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}