Other receipts

Other receipt transactions represent incoming payments that are not linked to specific customers or invoices. They are typically used to record miscellaneous income or non-invoice related deposits. These transactions may include cash deposits, credit card payments, bank transfers or check receipts.

List other receipts

get/objects/cash-management/other-receipt

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "182",
      • "id": "182",
      • "href": "/objects/cash-management/other-receipt/182"
      },
    • {
      • "key": "193",
      • "id": "193",
      • "href": "/objects/cash-management/other-receipt/193"
      },
    • {
      • "key": "501",
      • "id": "501",
      • "href": "/objects/cash-management/other-receipt/501"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Create an other receipt

post/objects/cash-management/other-receipt

Creates a new other receipt.

SecurityOAuth2
Request
Request Body schema: application/json
required
payer
required
string

The individual or entity from whom the payment was received.

Example: "John Smith"
txnDate
required
string <date>

Date the payment was received or initiated. Typically, this is the check date, but it may also reflect the date of a credit card charge, bank transfer, or cash transaction.

Example: "2021-01-23"
depositDate
required
string <date>

Date payments are deposited into a bank account.

Example: "2021-01-23"
txnPaidDate
required
string <date>

The actual date the payment was made or funds were received.

Example: "2021-01-23"
paymentMethod
required
string

Paymennt method used to make the payment for the transaction.

Enum: "cash" "creditCard" "eft" "printedCheck"
Example: "creditCard"
required
object

Specifies the bank account that receives the payments recorded in the receipt. This field is required if undepositedAccount is not specified.

key
string

System-assigned key for the receiving bank account.

Example: "1002"
id
string

Identifier of the receiving bank account.

Example: "BOA"
name
string

Name of the receiving bank account.

Example: "Bank of America"
currency
string

Currency of the receiving bank account.

Example: "USD"
txnNumber
string

Transaction number. Typically, this is the check number, but may be the transaction number for the credit card, bank transfer, or cash transaction.

Example: "22365"
description
string

Brief explanation or reference to identify the purpose or context of the transaction.

Example: "Refund for overpayment"
object

Accounts receivable (AR) summary in which the receipt is included.

key
string

System-assigned key for the AR summary.

Example: "100"
id
string

Identifier for the AR summary.

Example: "100"
date
string <date>

Date of the AR summary.

Example: "2023-10-10"
baseCurrency
string

The operating and reporting currency for the Sage Intacct company or entity. In a multi-entity company, you can choose to assign a different base currency to each entity.

Example: "USD"
currency
string

For multi-currency companies, the currency in which the transaction was incurred.

Example: "USD"
reconciliationDate
string <date>

Date the transaction was reconciled with a bank statement or bank transaction import file.

Example: "2021-01-23"
state
string

Current state of the other receipt transaction.

When an other receipt has been issued and is in an approved state, it can be reversed. When an other receipt is reversed, the original approved transaction immediately enters the reversal state and transitions to the reversed state once the reversal date is reached.

A reversal transaction is also created in the reversal state when you reverse an other receipt. The state of the reversal transaction does not change.

Enum: "approved" "deposited" "reconciled" "reversal" "reversed"
Example: "approved"
reconciliationState
string
Default: "uncleared"

Indicates the reconciliation state of the other receipt transaction, if this transaction has been cleared or matched for financial account reconciliation.

Enum: "cleared" "matched" "uncleared"
Example: "cleared"
object

References the parent deposit record associated with the receipt.

key
string

System-assigned key for the parent deposit record.

Example: "3319"
id
string

Identifier of the parent deposit record.

Example: "3319"
isInclusiveTax
boolean
Default: false

Indicates that line item amounts on the receipt include tax.

Example: true
object

Specifies the undeposited funds account used to hold receipts temporarily prior to being deposited into a bank account. This field is required if bankAccount is not specified.

key
string

System-assigned key for the undeposited funds account.

Example: "19"
id
string

Identifier of the undeposited funds account.

Example: "1020 Uncleared Receipts"
object

Details of the exchange rate used to calculate the base amount from the transaction amount.

date
string <date>

Date used to apply the exchange rate to the transaction. This can be the current date, the date the transaction was issued, or the date the transaction will be paid.

Example: "2021-01-23"
rate
number

Exchange rate used to calculate the base amount.

Example: 1.0789
typeId
string

Exchange rate type used to calculate the base amount.

Example: "1"
object

Tax solution used to calculate and capture taxes on this transaction.

key
string

System-assigned key for the tax solution.

Example: "123"
id
string

Identifier of the tax solution.

Example: "CATAXSOLUTIONID"
enableMultilineTax
boolean
Default: false

Indicates whether to allow multiple tax entries for each line item. When true allows you to apply multiple tax entries to each line item.

Example: false
taxCalculationMethod
string

Calculation method used by the tax solution to apply sales tax to the transaction.

Example: "Simple"
sourceModule
string
Default: "cashManagement"

Indicates the originating Sage Intacct module from which the other receipt was created.

Enum: "cashManagement" "loanManagement"
Example: "cashManagement"
Array of objects

Line items associated with the other receipt.

Array
txnAmount
required
string <decimal-precision-2>

For multi-currency companies, amount of the line item.

Example: "100.99"
required
object

General ledger (GL) account for the line item.

amount
string <decimal-precision-2>

For single-currency companies, amount of the line item.

Example: "100.99"
totalTxnAmount
string <decimal-precision-2>

For multi-currency companies, total amount of the line item.

Example: "100.99"
description
string

Description of the line item.

Example: "Cash receipt for rental of conferencing facilities"
object

Exchange rate used to calculate the base amount.

lineNumber
integer

Line number for the line item.

Example: 1
isTax
boolean
Default: false

Indicates whether the line item amount includes taxes.

Example: false
object

Label for the Accounts Receivable (AR) account associated with the line item.

object
object

Other receipt object that contains the line item.

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"
Array of objects

Details of tax entries associated with the line item.

Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "payer": "Benson Hugo",
  • "txnDate": "2022-01-23",
  • "txnPaidDate": "2022-01-23",
  • "txnNumber": "22365",
  • "description": "Refund for overpayment",
  • "baseCurrency": "USD",
  • "currency": "USD",
  • "state": "approved",
  • "reconciliationState": "uncleared",
  • "isInclusiveTax": false,
  • "bankAccount": {
    • "id": "BOA-REC-01"
    },
  • "depositDate": "2022-01-23",
  • "exchangeRate": {
    • "date": "2022-01-23",
    • "typeId": null,
    • "rate": 1
    },
  • "paymentMethod": "eft",
  • "reversalDate": "2022-01-23",
  • "reversedDate": "2022-01-23",
  • "reversedVoidPaymentKey": "1400",
  • "voidPaymentKey": "1923",
  • "sourceModule": "cashManagement",
  • "lines": [
    • {
      • "status": "active",
      • "amount": "100.00",
      • "txnAmount": "100.00",
      • "description": "description",
      • "lineNumber": 1,
      • "baseCurrency": "USD",
      • "currency": "USD",
      • "isTax": false,
      • "arAccountLabel": {
        },
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "500",
    • "id": "500",
    • "href": "/objects/cash-management/other-receipt/500"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get an other receipt

get/objects/cash-management/other-receipt/{key}

Returns detailed information for a specified other receipt.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the other receipt.

Example: 103
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "557",
    • "key": "557",
    • "txnDate": "2022-01-23",
    • "recordType": "cr",
    • "payer": "Alan Smith-Jones",
    • "txnPaidDate": "2022-01-23",
    • "paymentMethod": "creditCard",
    • "txnNumber": "2251",
    • "description": "Conference booth fee",
    • "bankAccount": {
      • "key": "45",
      • "id": "BOA-REC-01",
      • "name": "Bank of America Receipts Account",
      • "currency": "USD",
      • "href": "/objects/cash-management/bank-account/45"
      },
    • "depositDate": "2022-01-23",
    • "arSummary": {
      • "key": "315",
      • "id": "315",
      • "href": "/objects/accounts-receivable/summary/315"
      },
    • "baseCurrency": "USD",
    • "currency": "USD",
    • "exchangeRate": {
      • "date": null,
      • "typeId": null,
      • "rate": null
      },
    • "totalEntered": "150.00",
    • "txnTotalEntered": "150.00",
    • "reconciliationDate": null,
    • "state": "approved",
    • "reconciliationState": "uncleared",
    • "parentDeposit": {
      • "key": null,
      • "id": null
      },
    • "audit": {
      • "createdDateTime": "2025-02-15T03:03:31Z",
      • "modifiedDateTime": "2025-02-15T03:03:32Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "isInclusiveTax": false,
    • "taxSolution": {
      • "key": null,
      • "id": null,
      • "enableMultilineTax": null,
      • "taxCalculationMethod": null
      },
    • "voidPaymentKey": null,
    • "reversalDate": null,
    • "reversedVoidPaymentKey": null,
    • "reversedDate": null,
    • "sourceModule": "cashManagement",
    • "entity": {
      • "key": "1",
      • "id": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/entity/1"
      },
    • "lines": [
      • {
        }
      ],
    • "undepositedAccount": {
      • "id": null
      },
    • "href": "/objects/cash-management/other-receipt/557"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an other receipt

patch/objects/cash-management/other-receipt/{key}

Updates an existing other receipt by setting field values. Any fields not provided remain unchanged. Only transactions in an open sub-ledger period, which have not yet been deposited, can be updated.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the other receipt.

Example: 103
Request Body schema: application/json
payer
string

The individual or entity from whom the payment was received.

Example: "John Smith"
txnDate
string <date>

Date the payment was received or initiated. Typically, this is the check date, but it may also reflect the date of a credit card charge, bank transfer, or cash transaction.

Example: "2021-01-23"
txnPaidDate
string <date>

The actual date the payment was made or funds were received.

Example: "2021-01-23"
txnNumber
string

Transaction number. Typically, this is the check number, but may be the transaction number for the credit card, bank transfer, or cash transaction.

Example: "22365"
description
string

Brief explanation or reference to identify the purpose or context of the transaction.

Example: "Refund for overpayment"
object

Accounts receivable (AR) summary in which the receipt is included.

key
string

System-assigned key for the AR summary.

Example: "100"
id
string

Identifier for the AR summary.

Example: "100"
date
string <date>

Date of the AR summary.

Example: "2023-10-10"
baseCurrency
string

The operating and reporting currency for the Sage Intacct company or entity. In a multi-entity company, you can choose to assign a different base currency to each entity.

Example: "USD"
currency
string

For multi-currency companies, the currency in which the transaction was incurred.

Example: "USD"
reconciliationDate
string <date>

Date the transaction was reconciled with a bank statement or bank transaction import file.

Example: "2021-01-23"
state
string

Current state of the other receipt transaction.

When an other receipt has been issued and is in an approved state, it can be reversed. When an other receipt is reversed, the original approved transaction immediately enters the reversal state and transitions to the reversed state once the reversal date is reached.

A reversal transaction is also created in the reversal state when you reverse an other receipt. The state of the reversal transaction does not change.

Enum: "approved" "deposited" "reconciled" "reversal" "reversed"
Example: "approved"
reconciliationState
string
Default: "uncleared"

Indicates the reconciliation state of the other receipt transaction, if this transaction has been cleared or matched for financial account reconciliation.

Enum: "cleared" "matched" "uncleared"
Example: "cleared"
object

References the parent deposit record associated with the receipt.

key
string

System-assigned key for the parent deposit record.

Example: "3319"
id
string

Identifier of the parent deposit record.

Example: "3319"
isInclusiveTax
boolean
Default: false

Indicates that line item amounts on the receipt include tax.

Example: true
object

Specifies the bank account that receives the payments recorded in the receipt. This field is required if undepositedAccount is not specified.

key
string

System-assigned key for the receiving bank account.

Example: "1002"
id
string

Identifier of the receiving bank account.

Example: "BOA"
name
string

Name of the receiving bank account.

Example: "Bank of America"
currency
string

Currency of the receiving bank account.

Example: "USD"
object

Specifies the undeposited funds account used to hold receipts temporarily prior to being deposited into a bank account. This field is required if bankAccount is not specified.

key
string

System-assigned key for the undeposited funds account.

Example: "19"
id
string

Identifier of the undeposited funds account.

Example: "1020 Uncleared Receipts"
depositDate
string <date>

Date payments are deposited into a bank account.

Example: "2021-01-23"
object

Details of the exchange rate used to calculate the base amount from the transaction amount.

date
string <date>

Date used to apply the exchange rate to the transaction. This can be the current date, the date the transaction was issued, or the date the transaction will be paid.

Example: "2021-01-23"
rate
number

Exchange rate used to calculate the base amount.

Example: 1.0789
typeId
string

Exchange rate type used to calculate the base amount.

Example: "1"
paymentMethod
string

Paymennt method used to make the payment for the transaction.

Enum: "cash" "creditCard" "eft" "printedCheck"
Example: "creditCard"
object

Tax solution used to calculate and capture taxes on this transaction.

key
string

System-assigned key for the tax solution.

Example: "123"
id
string

Identifier of the tax solution.

Example: "CATAXSOLUTIONID"
enableMultilineTax
boolean
Default: false

Indicates whether to allow multiple tax entries for each line item. When true allows you to apply multiple tax entries to each line item.

Example: false
taxCalculationMethod
string

Calculation method used by the tax solution to apply sales tax to the transaction.

Example: "Simple"
sourceModule
string
Default: "cashManagement"

Indicates the originating Sage Intacct module from which the other receipt was created.

Enum: "cashManagement" "loanManagement"
Example: "cashManagement"
Array of objects

Line items associated with the other receipt.

Array
amount
string <decimal-precision-2>

For single-currency companies, amount of the line item.

Example: "100.99"
totalTxnAmount
string <decimal-precision-2>

For multi-currency companies, total amount of the line item.

Example: "100.99"
txnAmount
string <decimal-precision-2>

For multi-currency companies, amount of the line item.

Example: "100.99"
description
string

Description of the line item.

Example: "Cash receipt for rental of conferencing facilities"
object

Exchange rate used to calculate the base amount.

lineNumber
integer

Line number for the line item.

Example: 1
isTax
boolean
Default: false

Indicates whether the line item amount includes taxes.

Example: false
object

Label for the Accounts Receivable (AR) account associated with the line item.

object

General ledger (GL) account for the line item.

object
object

Other receipt object that contains the line item.

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"
Array of objects

Details of tax entries associated with the line item.

Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "description": "2025 Conference booth fee"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "500",
    • "id": "500",
    • "href": "/objects/cash-management/other-receipt/500"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete an other receipt

delete/objects/cash-management/other-receipt/{key}

Deletes an other receipt. Only those receipts that have not yet been deposited or reconciled that are in an open period can be deleted.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the other receipt.

Example: 103
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 an other receipt

post/workflows/cash-management/other-receipt/reverse

Reverses an other receipt. When an other receipt has been issued and is in an approved state, it can be reversed.

When an other receipt is reversed, the original approved transaction immediately enters the reversal state. It transitions to the reversed state once the reversal date is reached.

A reversal transaction is also created in the reversal state when you reverse an other receipt. The state of the reversal transaction does not change.

For more information, see reverse other receipts in the Sage Intacct Help Center.

SecurityOAuth2
Request
Request Body schema: application/json
key
required
string

System-assigned key for the other receipt.

Example: "49"
reversedDate
required
string <date>

Date this transaction is reversed.

Example: "2024-04-15"
notes
string

Notes or comments about the reason for the reverse of other receipt.

Example: "Reversed the other receipt due to duplicate entry"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "key": "49",
  • "reversedDate": "2024-04-15",
  • "notes": "Reversed the other receipt due to duplicate entry"
}
Response samples
application/json
{
  • "key": "50",
  • "id": "50",
  • "href": "/objects/cash-management/other-receipt/50",
  • "state": "reversed"
}