How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Codat Accounts receivable API

Data from a linked accounting software representing money owed to the business for sold goods or services.

Codat Accounts receivable API is one of 40 APIs that Codat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Accounts Receivable. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 23 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.codat.io.

23 operations 23 paths 34 schemas 23 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://api.codat.io
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Codat Accounts receivable API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (auth_header). By default, every request must be authenticated.

  • auth_header — The word "Basic" followed by a space and your API key. [API keys](https://docs.codat.io/platform-api/schemas/ApiKeyDetails) are tokens used to control access t…

Paths & Operations 23

Across 23 paths, the API surfaces 23 operations — 23 GET. Each is listed below with its method, path, parameters, and response codes.

Accounts receivable 23

Data from a linked accounting software representing money owed to the business for sold goods or services.

GET
/companies/{companyId}/reports/enhancedInvoices
List reconciled invoices
list-reconciled-invoices 4 params → 200400401402403404429500
GET
/companies/{companyId}/data/creditNotes
List credit notes
list-accounting-credit-notes 5 params → 200400401402403404409429
GET
/companies/{companyId}/data/creditNotes/{creditNoteId}
Get credit note
get-accounting-credit-note 2 params → 200401402403404409429500
GET
/companies/{companyId}/data/customers
List customers
list-accounting-customers 5 params → 200400401402403404409429
GET
/companies/{companyId}/data/customers/{customerId}
Get customer
get-accounting-customer 2 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments
List customer attachments
list-accounting-customer-attachments 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}
Get customer attachment
get-accounting-customer-attachment 4 params → 200401402403404429500503
GET
/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download
Download customer attachment
download-accounting-customer-attachment 4 params → 200401402403404429500503
GET
/companies/{companyId}/connections/{connectionId}/data/directIncomes
List direct incomes
list-accounting-direct-incomes 6 params → 200400401402403404409429
GET
/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}
Get direct income
get-accounting-direct-income 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}
Get direct income attachment
get-accounting-direct-income-attachment 5 params → 200401402403404429500503
GET
/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download
Download direct income attachment
download-accounting-direct-income-attachment 5 params → 200401402403404429500503
GET
/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments
List direct income attachments
list-accounting-direct-income-attachments 3 params → 200401402403404409429500
GET
/companies/{companyId}/data/invoices
List invoices
list-accounting-invoices 5 params → 200400401402403404409429
GET
/companies/{companyId}/data/invoices/{invoiceId}
Get invoice
get-accounting-invoice 2 params → 200401402403404409429500
GET
/companies/{companyId}/data/invoices/{invoiceId}/pdf
Get invoice as PDF
download-accounting-invoice-pdf 2 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments
List invoice attachments
list-accounting-invoice-attachments 3 params → 200401402403404409429500
GET
/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}
Get invoice attachment
get-accounting-invoice-attachment 4 params → 200401402403404429500503
GET
/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download
Download invoice attachment
download-accounting-invoice-attachment 4 params → 200401402403404429500503
GET
/companies/{companyId}/data/payments
List payments
list-accounting-payments 5 params → 200400401402403404409429
GET
/companies/{companyId}/data/payments/{paymentId}
Get payment
get-accounting-payment 2 params → 200401402403404409429500
GET
/companies/{companyId}/reports/agedDebtor/available
Aged debtors report available
is-aged-debtors-report-available 1 param → 200401402403404429500503
GET
/companies/{companyId}/reports/agedDebtor
Aged debtors report
get-accounting-aged-debtors-report 4 params → 200401402403404429500503

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are SourceAccount (10 properties), ErrorMessage (7 properties), AccountingAddress (7 properties), AccountsReceivableTracking (6 properties). Each schema is shown below with its type and property counts.

AccountingJournalEntry
object
Language tip: For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api/schemas/Journal) data t…
AgedCurrencyOutstanding
object
2 properties
EnhancedInvoicesReport
object
The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by…
2 properties
DateTime
string
In Codat's data model, dates and times are represented using the ISO 8601 standard . Date and time fields are formatted as strings; for example: 2020-10-08T22:…
AccountingRecordRef
object
Links the current record to the underlying record or data type that created it. For example, if a journal entry is generated based on an invoice, this property…
2 properties
AccountingInvoice
object
Invoices or bills? We distinguish between invoices where the company owes money vs. is owed money. If the company issued an invoice, and is owed money (account…
5 required
AccountingPayment
object
 Payments or bill payments? In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api…
1 required
AccountingCustomer
object
Overview A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a c…
1 required
AccountingAgedDebtorReport
object
The Aged Debtors report shows the total outstanding balance due from customers to the business over time. You can generate it for a company based on recently s…
3 properties
AccountingTrackingCategory
object
Details of a category used for tracking transactions. Language tip Parameters used to track types of spend in various parts of an organization can be called di…
PagingInfo
object
4 properties 4 required
AccountsReceivableTracking
object
Categories, and a project and customer, against which the item is tracked.
6 properties 3 required
AccountingCreditNote
object
Overview Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can ei…
7 required
Attachments
object
1 property
AccountingPaymentAllocation
object
2 properties 2 required
PhoneNumber
object
2 properties 1 required
ErrorMessage
object
7 properties
PaymentMethodRef
object
The payment method the record is linked to in the accounting or commerce software.
2 properties 1 required
CommerceOrder
object
Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each o…
Metadata
object
1 property
AccountingBillCreditNote
object
Bill credit notes or credit notes? In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.…
6 required
AccountingAccount
object
 Language tip: Accounts are also referred to as chart of accounts, nominal accounts, and general ledger. Overview Accounts are the categories a business uses…
AccountingDirectIncome
object
Language tip: Direct incomes may also be referred to as Receive transactions, Receive money transactions, Sales receipts, or Cash sales in various accounting s…
7 required
AccountingAddress
object
7 properties 1 required
AccountingInvoices
AccountingCustomers
SourceAccount
object
The target bank account in a supported accounting software for ingestion into a bank feed.
10 properties 1 required
SupplementalData
object
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…
1 property
AccountingDirectIncomes
AccountingBill
object
Invoices or bills? We distinguish between invoices where the company owes money vs. is owed money. If the company has received an invoice, and owes money to so…
5 required
AccountingCreditNotes
AccountingPayments
AccountingAttachment
object
The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. Retrieving attachments If a company is au…
ProjectRef
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codat-accounts-receivable-api-openapi.yml Raw ↑

Other APIs Codat publishes across the network.

Codat Sync for Expenses API
Codat Bill Pay API
Codat Spend Insights API
Codat Sync for Commerce API
Codat Sync for Payroll API
Codat Account mapping API
Codat Accounting bank data API
Codat Accounts payable API
Codat Bank accounts API
Codat Bank statements API
Codat Companies API
Codat Company info API
Where this information came from

This is an independent, third-party profile of Codat Accounts receivable API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.