---
title: "Get payment"
method: GET
path: "/companies/{companyId}/data/payments/{paymentId}"
tags: ["Payments"]
---

# Get payment

`GET /companies/{companyId}/data/payments/{paymentId}`

The *Get payment* endpoint returns a single payment for a given paymentId.

[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.

Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).

## Response `200`

Success

- Payment, nullable — > **Payments or bill payments?** > > In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills. ## Overview Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote). A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to: - A payment made against an invoice, like a credit card, cheque, or cash payment. - An allocation of a customer's credit note, either to an invoice or maybe a refund. - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account. Depending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details. In Codat, a payment contains details of: - When the payment was recorded in the accounting system. - How much it is for and in what currency that amount is in. - Who the payment was _paid by_ – the _customer_. - The payment method used. - The breakdown of the types of payments – the _line items_. Payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction). ## Payment types ## Payment of an invoice A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties: - An _amount_ that indicates the amount of the invoice that was paid. This is always positive. - A **links** array containing one element with the following properties: - A **type** that indicates the type of **link**, in this case an `Invoice`. - An **id** that contains the ID of the invoice that was paid. - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`. The **amount** field on the **line** equals the **totalAmount** on the payment. ## Payment of multiple invoices A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books: - The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice). - The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available. Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment. ## Payments and refunds on account A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties: - A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive. - A **links** array containing one element with the following properties: - A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`. - The **id** containing the ID of the customer. - The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund. It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above. ## Using a credit note to pay an invoice The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties: - An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other. - A **links** array containing two elements: - The first **link** has: - A **type** that indicates the type of **link**, in this case an `Invoice`. - An **id** that contains the ID of the invoice that was paid. - The second **link** has: - A **type** that indicates the type of **link**, in this case a `CreditNote`. - An **id** that contains the ID of the credit note used by this payment. The **amount** field on the **line** equals the **totalAmount** on the payment. ## Refunding a credit note A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties: - An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund. - A **links** array that contains one element with the following properties: - A **type** that indicates the type of **link**, in this case a `CreditNote`. - An **id** that contains the ID of the credit note that was refunded. The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable. ## Refunding a payment If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records: - One for the incoming over payment. - Another for the outgoing refund. The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties: - An **amount** that indicates the amount that was refunded. This is always negative. - A **links** array that contains one element with the following properties: - A **type** that indicates the type of **link**, in this case a `Payment`. - An **id** that contains the ID of the payment that was refunded. The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable. The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice. For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines: - One for £1,000 linked to the invoice that was paid. - Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment. The **line** linked to the payment has the following properties: - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund. - A **links** array containing one element with the following properties: - A **type** that indicates the type of **link**, in this case a `Refund`. - An **id** that contains the ID of the payment that refunded this line. > **Support for linked payments** > > Not all accounting software support linking payments in this way. In some platforms, you may see a payment on account and a refund on account. ## Foreign currencies There are two types of currency rate that are included in the payments data type: Payment currency rate: - Base currency of the accounts receivable account. - Foreign currency of the payment. Payment line link currency rate: - Base currency of the item the link represents. - Foreign currency of the payment. These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either: - The base currency for the accounts receivable account. - The currency of the item. ```json title="Currency rate example" { "id": "123", "note": "", "totalAmount": 99.99, "currency": "GBP", "lines": [ { "amount": 99.99, "links": [ { "type": "Invoice", "id": "178", "amount": -50, "currencyRate": 1.9998 } ] } ] } ``` ## Example data > **Object properties** > > For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments). ## Simple examples ```json title="Payment for invoice" { "totalAmount": 1000, "lines": [ { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 } ] } ] } ``` ```json title="Allocation of credit note" { "totalAmount": 0, "lines": [ { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "y", "amount" : 1000 } ] } ] } ``` ```json title="Payment of invoice and payment on account" { "totalAmount": 2000, "lines": [ { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "PaymentOnAccount", "id" : "y", "amount" : -1000 } ] } ] } ``` ```json title="Refund of credit note" { "totalAmount": -1000, "lines": [ { "amount" : -1000, "links" : [ { "type" : "CreditNote", "id" : "y", "amount" : 1000 } ] } ] } ``` ```json title="Refund on accounts receivable account" { "totalAmount": -1000, "lines": [ { "amount" : -1000, "links" : [ { "type" : "PaymentOnAccount", "id" : "y", "amount" : 1000 } ] } ] } ``` ```json title="Linked refund on accounts receivable account" { "id" : "payment-001", "totalAmount": 1000, "lines": [ { "amount" : 1000, "links" : [ { "type" : "Refund", "id" : "refund-001", "amount" : -1000 } ] } ] } { "id" : "refund-001", "totalAmount": -1000, "lines": [ { "amount" : -1000, "links" : [ { "type" : "Payment", "id" : "payment-001", "amount" : 1000 } ] } ] } ``` ```json title="Using a credit note and cash to pay an invoice" { "totalAmount": 250, "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "x", "amount": -750 }, { "type": "CreditNote", "id": "y", "amount": 750 } ] }, { "amount": 250, "links": [ { "type": "Invoice", "id": "x", "amount": -250 } ] } ] } ``` ## Complex examples ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice" { "totalAmount": 1000, "lines": [ { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "y", "amount" : 1000 } ] }, { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "z", "amount" : 1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 } ] } ] } ``` ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'" { "totalAmount": 2000, "lines": [ { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "y", "amount" : 1000 } ] }, { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "z", "amount" : 1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "x", "amount" : -1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "PaymentOnAccount", "id" : "customer-001", "amount" : -1000 } ] } ] } ``` ```json title="Two credit notes pay two invoices with no allocation amount specified" { "totalAmount": 0, "lines": [ { "amount" : 0, "links" : [ { "type" : "Invoice", "id" : "w", "amount" : -1000 }, { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "CreditNote", "id" : "y", "amount" : 1000 }, { "type" : "CreditNote", "id" : "z", "amount" : 1000 } ] } ] } ``` ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash" { "totalAmount": 2000, "lines": [ { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "w", "amount" : -1000 }, { "type" : "Invoice", "id" : "x", "amount" : -1000 }, { "type" : "Invoice", "id" : "u", "amount" : -1000 }, { "type" : "CreditNote", "id" : "y", "amount" : 1000 }, { "type" : "CreditNote", "id" : "z", "amount" : 1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "Refund", "id" : "refund-001", "amount" : -1000 } ] } ] } { "id" : "refund-001", "totalAmount": -1000, "lines": [ { "amount" : -1000, "links" : [ { "type" : "Payment", "id" : "payment-001", "amount" : 1000 } ] } ] } ``` In this example, a payment on account is used to pay the same invoice in January and again in February. ```json title="January" { "id": "001", "totalAmount": 5000, "date" : "1901-01-01", "lines": [ { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "Invoice-x", "amount" : -1000 } ] }, { "amount" : 4000, "links" : [ { "type" : "PaymentOnAccount", "id" : "PaymentOnAccount-y", "amount" : -4000 } ] } ] } ``` ```json title="February" { "id": "001", "totalAmount": 5000, "date" : "1901-02-01", "lines": [ { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "Invoice-x", "amount" : -1000 } ] }, { "amount" : 1000, "links" : [ { "type" : "Invoice", "id" : "Invoice-y", "amount" : -1000 } ] }, { "amount" : 3000, "links" : [ { "type" : "PaymentOnAccount", "id" : "PaymentOnAccount-y", "amount" : -3000 } ] } ] } ``` ```json title="Two credit notes and some cash pay two invoices with no allocations specified" { "totalAmount": 500, "lines": [ { "amount": 500, "links": [{ "type": "Invoice", "id": "a", "amount": -1000 }, { "type": "Invoice", "id": "b", "amount": -1000 }, { "type": "CreditNote", "id": "y", "amount": 750 },{ "type": "CreditNote", "id": "z", "amount": 750 } ] } ] } ```
  - `id` string — Identifier for the payment, unique to the company in the accounting software.
  - `customerRef` AccountingCustomerRef — unresolved $ref
  - `accountRef` AccountRef — unresolved $ref
  - `paymentMethodRef` PaymentMethodRef — The payment method the record is linked to in the accounting or commerce software.
    - `id` string, required — The unique identifier of the location being referenced.
    - `name` string — Name of the location being referenced.
  - `totalAmount` number — Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account.
  - `currency` Currency — unresolved $ref
  - `currencyRate` CurrencyRate — unresolved $ref
  - `date` string, required — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
  - `note` string, nullable — Any additional information associated with the payment.
  - `lines` PaymentLine[], nullable — An array of payment lines. — unresolved $ref
  - `reference` string, nullable — Friendly reference for the payment.
  - `metadata` Metadata
    - `isDeleted` boolean, nullable — Indicates whether the record has been deleted in the third-party system this record originated from.
  - `supplementalData` SupplementalData — Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.
    - `content` object, nullable
  - `modifiedDate` string — The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.
  - `sourceModifiedDate` string — The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: - Pulling attachments - The accounting software does not provide modification dates for a data type - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

## Other responses

- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `409` — The data type's dataset has not been requested or is still syncing.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.net/codatio/apis/accounting-api.md) · [All operations](https://skmtc.net/codatio/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/accounting-api/revisions/21d41189c461/schema)