Direct incomes
Income from payments received at the point of sale, cash refunds or deposits into a bank account
Language tip
Direct incomes may also be referred to as Receive transactions, Receive money transactions, Sales receipts, or Cash sales in various accounting platforms.
Explore the Direct Incomes endpoints in Swagger.
View the coverage for direct incomes in the Data Coverage Explorer.
Overview
Direct incomes include:
- Selling an item directly to a contact, and receiving payment at the point of the sale.
- Refunding an item in cash to a contact.
- Depositing money into a bank account.
From the Direct Incomes endpoints, you can:
- Get a list of all direct incomes for a specific company
- Get a single direct income for a specific company and connection
- Add a new direct income to a specific company's accounting package
Direct incomes is a child data type of account transactions.
Data model
Field | Type | Description |
---|---|---|
id | string | Identifier of the direct income, unique for the company. |
reference | string | User-friendly reference for the direct income. |
contactRef | A customer or supplier associated with the direct income. | |
issueDate | string | The date of the direct income as recorded in the accounting platform. |
currency | string | The currency of the direct income. |
currencyRate | decimal | The conversion rate between the currency of the direct incomes and the base currency of the company. |
lineItems | array | An array of directIncomelineItems. |
paymentAllocations | array | An array of paymentAllocations. |
subTotal | decimal | The total amount of the direct incomes, excluding any taxes. |
taxAmount | decimal | The total amount of tax on the direct incomes. |
totalAmount | decimal | The amount of the direct incomes, inclusive of tax. |
modifiedDate | string | The date the record was last updated in the Codat system. |
sourceModifiedDate | string | The date the record was last changed in the accounting system. |
Direct income line items
Field | Type | Description |
---|---|---|
description | string | A user-friendly name of the goods or services. |
accountRef | Reference to the account to which the line item is linked. | |
unitAmount | decimal | The price of each unit of goods or services. |
quantity | decimal | The number of units of goods or services received. Note: If the platform does not provide this information, the quantity will be mapped as 1. |
discountAmount | decimal | Discount amount for the line before tax. |
discountPercentage | decimal | Discount percentage for the line before tax. |
subTotal | decimal | The amount of the line, inclusive of discounts, but exclusive of tax. |
taxAmount | decimal | The amount of tax for the line. |
totalAmount | decimal | The total amount of the line, including tax. |
taxRateRef | Reference to the tax rate to which the line item is linked. | |
itemRef | Reference to the product, service type, or inventory item to which the direct cost is linked. | |
trackingCategoryRefs | array | An array of categories against which this direct cost is tracked. |
Payment allocations
Field | Type | Description |
---|---|---|
payment | ||
id | string | The identifier of the allocated payment. |
accountRef | The account that the allocated payment is made from or to. | |
currency | See currency | The currency the payment has been made in. |
currencyRate | decimal | The conversion rate between the currency of the allocated payment and the currency of the company. |
paidOnDate | string | The date the payment was made. |
totalAmount | decimal | The total amount that was paid. |
allocation | ||
currency | string | The currency of the transaction. |
currencyRate | number | The conversion rate between the currency of the allocated payment and the currency of the transaction. |
allocatedOnDate | string | The date the payment was allocated. |
totalAmount | decimal | The total amount that has been allocated. |
Example data
{
"directIncomes": [
{
"id": "f3a0edb6-4c53-49ea-83ed-b6fc63f16a9a",
"reference": "ref_test_income",
"contactRef" : {
"id" : "00000-0000-00001",
"dataType" : "customers"
}
"issueDate": "2021-06-11T00:00:00",
"currency": "GBP",
"currencyRate": 1.0,
"lineItems": [
{
"description": "line item desription",
"accountRef": {
"id": "6c05cfb6-1d36-4c5c-895b-4ad999ad94ae",
"name": "Plant & Machinery"
},
"unitAmount": 100.00,
"quantity": 1.00,
"discountAmount": 0,
"discountPercentage": 0,
"subTotal": 100.00,
"taxAmount": 0.00,
"totalAmount": 100.00,
"itemRef": {
"id": "1dbc92da-ca7b-4ad3-baa0-24e2f30c8a1f",
"name": "Golf balls - white 9 pack"
},
"trackingCategoryRefs": []
}
],
"paymentAllocations": [
{
"payment": {
"id": "f3a0edb6-4c53-49ea-83ed-b6fc63f16a9a",
"accountRef": {
"id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
"name": "Business Bank Account"
},
"currency": "GBP",
"currencyRate": 1.0,
"paidOnDate": "2021-06-11T00:00:00",
"totalAmount": 100.00
},
"allocation": {
"currency": "GBP",
"currencyRate": 1.0,
"allocatedOnDate": "2021-06-11T00:00:00",
"totalAmount": 100.00
}
}
],
"subTotal": 100.00,
"taxAmount": 0.00,
"totalAmount": 100.00,
"modifiedDate": "2021-06-11T13:52:45.18",
"sourceModifiedDate": "2021-06-11T13:52:45.18"
},
Updated 22 days ago