--- title: "Create credit note" method: POST path: "/companies/{companyId}/connections/{connectionId}/push/creditNotes" tags: ["Credit notes"] --- # Create credit note `POST /companies/{companyId}/connections/{connectionId}/push/creditNotes` The *Create credit note* endpoint creates a new [credit note](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection. [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. **Integration-specific behavior** Required data may vary by integration. To see what data to post, first call [Get create/update credit note model](https://docs.codat.io/accounting-api#/operations/get-create-update-creditNotes-model). ## Query parameters - `timeoutInMinutes` integer ## Request body - CreditNote, nullable — ## 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 either reduce the amount owed or cancel out an invoice entirely. In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. It contains details of: * The amount of credit remaining and its status. * Payment allocations against the payments type, in this case an invoice. * Which customers the credit notes have been issued to. - `id` string — Identifier for the credit note, unique to the company in the accounting software. - `creditNoteNumber` string, nullable — Friendly reference for the credit note. - `customerRef` AccountingCustomerRef — unresolved $ref - `withholdingTax` Items[], nullable — unresolved $ref - `totalAmount` number, required — Total amount of credit that has been applied to the customer's accounts receivable - `totalDiscount` number, required — Any discounts applied to the credit note amount. - `subTotal` number, required — Value of the credit note, including discounts and excluding tax. - `additionalTaxAmount` number — Additional tax amount applied to credit note. - `additionalTaxPercentage` number — Percentage rate of any additional tax applied to the credit note. - `totalTaxAmount` number, required — Any tax applied to the credit note amount. - `discountPercentage` number, required — Percentage rate (from 0 to 100) of discounts applied to the credit note. - `remainingCredit` number, required — Unused balance of totalAmount originally raised. - `status` CreditNoteStatus, required — unresolved $ref - `issueDate` 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: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. - `allocatedOnDate` 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: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. - `currency` Currency — unresolved $ref - `currencyRate` CurrencyRate — unresolved $ref - `lineItems` CreditNoteLineItem[], nullable — unresolved $ref - `paymentAllocations` Items[], nullable — An array of payment allocations. — unresolved $ref - `note` string, nullable — Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer. - `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 ISO 8601 standard. - `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 ISO 8601 standard. ## Response `200` Success - CreateCreditNoteResponse - `data` object, nullable — ## 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 either reduce the amount owed or cancel out an invoice entirely. In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. It contains details of: * The amount of credit remaining and its status. * Payment allocations against the payments type, in this case an invoice. * Which customers the credit notes have been issued to. - `id` string — Identifier for the credit note, unique to the company in the accounting software. - `creditNoteNumber` string, nullable — Friendly reference for the credit note. - `customerRef` AccountingCustomerRef — unresolved $ref - `withholdingTax` Items[], nullable — unresolved $ref - `totalAmount` number, required — Total amount of credit that has been applied to the customer's accounts receivable - `totalDiscount` number, required — Any discounts applied to the credit note amount. - `subTotal` number, required — Value of the credit note, including discounts and excluding tax. - `additionalTaxAmount` number — Additional tax amount applied to credit note. - `additionalTaxPercentage` number — Percentage rate of any additional tax applied to the credit note. - `totalTaxAmount` number, required — Any tax applied to the credit note amount. - `discountPercentage` number, required — Percentage rate (from 0 to 100) of discounts applied to the credit note. - `remainingCredit` number, required — Unused balance of totalAmount originally raised. - `status` CreditNoteStatus, required — unresolved $ref - `issueDate` 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: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. - `allocatedOnDate` 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: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. - `currency` Currency — unresolved $ref - `currencyRate` CurrencyRate — unresolved $ref - `lineItems` CreditNoteLineItem[], nullable — unresolved $ref - `paymentAllocations` Items[], nullable — An array of payment allocations. — unresolved $ref - `note` string, nullable — Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer. - `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 ISO 8601 standard. - `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 ISO 8601 standard. - `changes` PushOperationChange[], nullable — Contains a single entry that communicates which record has changed and the manner in which it changed. — unresolved $ref - `dataType` 'accountTransactions' | 'balanceSheet' | 'bankAccounts' | 'bankTransactions' | 'billCreditNotes' | 'billPayments' | 'bills' | 'cashFlowStatement' | 'chartOfAccounts' | 'company' | 'creditNotes' | 'customers' | 'directCosts' | 'directIncomes' | 'invoices' | 'itemReceipts' | 'items' | 'journalEntries' | 'journals' | 'paymentMethods' | 'payments' | 'profitAndLoss' | 'purchaseOrders' | 'salesOrders' | 'suppliers' | 'taxRates' | 'trackingCategories' | 'transfers' | 'banking-accountBalances' | 'banking-accounts' | 'banking-transactionCategories' | 'banking-transactions' | 'commerce-companyInfo' | 'commerce-customers' | 'commerce-disputes' | 'commerce-locations' | 'commerce-orders' | 'commerce-paymentMethods' | 'commerce-payments' | 'commerce-productCategories' | 'commerce-products' | 'commerce-taxComponents' | 'commerce-transactions' — Available data types - `companyId` Schema, required — unresolved $ref - `pushOperationKey` string, uuid, required — A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. - `dataConnectionKey` Schema, required — unresolved $ref - `requestedOnUtc` string, required — 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: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. - `completedOnUtc` 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: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. - `timeoutInMinutes` integer, nullable — Number of minutes the push operation must complete within before it times out. - `timeoutInSeconds` integer, nullable — Number of seconds the push operation must complete within before it times out. - `status` PushOperationStatus, required — unresolved $ref - `errorMessage` string, nullable — A message about the error. - `validation` Validation — unresolved $ref - `statusCode` integer, required — Push status code. ## Other responses - `400` — The request made is not valid. - `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. - `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)