Account transactions2

Accounts4

Bank account transactions3

Bank accounts5

Bill credit notes6

Bill payments5

Bills10

Company info2

Credit notes5

Customers8

Direct costs9

Direct incomes8

Invoices11

Item receipts2

Items4

Journal entries5

Journals4

Payment methods2

Payments5

Purchase orders9

Reports7

Sales orders2

Suppliers8

Tax rates2

Tracking categories2

Transfers5

Bill credit notes

Update bill credit note

The Update bill credit note endpoint updates an existing bill credit note for a given company's connection.

Bill credit notes are issued by a supplier for the purpose of recording credit.

Integration-specific behavior

Required data may vary by integration. To see what data to post, first call Get create/update bill credit note model.

put/companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}

Query parameters

timeoutInMinutesinteger

Time limit for the push operation to complete before it is timed out.

forceUpdateboolean

When updating data in the destination platform Codat checks the sourceModifiedDate against the lastupdated date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to true then the update will override this check.

Request body

idstring

Identifier for the bill credit note that is unique to a company in the accounting software.

billCreditNoteNumberstring nullable

Friendly reference for the bill credit note.

supplierRefSupplierRef — unresolved $ref

withholdingTaxItems[] nullable— unresolved $ref

totalAmountnumber required

Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax.

totalDiscountnumber required

Total value of any discounts applied.

subTotalnumber required

Total amount of the bill credit note, including discounts but excluding tax.

totalTaxAmountnumber required

Amount of tax included in the bill credit note.

discountPercentagenumber required

Percentage rate of any discount applied to the bill credit note.

remainingCreditnumber

Amount of the bill credit note that is still outstanding.

statusBillCreditNoteStatus required— unresolved $ref

issueDatestring

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.

allocatedOnDatestring

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.

currencyCurrency — unresolved $ref

currencyRateCurrencyRate — unresolved $ref

lineItemsBillCreditNoteLineItem[] nullable— unresolved $ref

An array of line

paymentAllocationsItems[] nullable— unresolved $ref

An array of payment allocations.

createdFromRefsInvoiceTo[] nullable— unresolved $ref

An array of records the credit note was created from.

notestring nullable

Any additional information about the bill credit note.

modifiedDatestring

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).

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>.

sourceModifiedDatestring

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) 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>.

Example request

{
  "id": "6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d",
  "billCreditNoteNumber": "14763237",
  "totalAmount": 693,
  "remainingCredit": 693,
  "status": "Submitted",
  "issueDate": "2019-02-18T16:03:07.268Z",
  "note": "Track separately",
  "currency": "USD",
  "lineItems": [
    {
      "description": "AcmeMagnet",
      "unitAmount": 25,
      "discountAmount": 0,
      "quantity": 4,
      "subTotal": 100,
      "taxAmount": 10,
      "totalAmount": 110,
      "itemRef": {
        "id": "3"
      },
      "taxRateRef": {
        "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
      },
      "accountRef": {
        "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
      },
      "trackingCategoryRefs": [
        {
          "id": "department_1",
          "name": "ACMERockets"
        },
        {
          "id": "costcode_2",
          "name": "ACM2-ACMESigns"
        }
      ],
      "createdFromLineRef": [
        {
          "id": "8462",
          "dataType": "bill",
          "lineNumber": 1
        }
      ]
    },
    {
      "description": "ACMEDisintegratingPistol",
      "unitAmount": 25,
      "discountAmount": 0,
      "quantity": 3,
      "subTotal": 75,
      "taxAmount": 7.5,
      "totalAmount": 82.5,
      "itemRef": {
        "id": "3abf0883-03f7-44c6-bc15-1372522d25e1"
      },
      "taxRateRef": {
        "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
      },
      "accountRef": {
        "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
      }
    },
    {
      "description": "ACMEWhippedCreamDispenser",
      "unitAmount": 52,
      "discountAmount": 0,
      "quantity": 6,
      "subTotal": 312,
      "taxAmount": 31.2,
      "totalAmount": 343.2,
      "itemRef": {
        "id": "3691f3d9-0ff7-4358-8a93-bed31c1b4b03"
      },
      "taxRateRef": {
        "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498"
      },
      "accountRef": {
        "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
      }
    },
    {
      "description": "ACMEJetPropelledPogoStick",
      "unitAmount": 130,
      "discountAmount": 0,
      "quantity": 1,
      "subTotal": 130,
      "taxAmount": 27.3,
      "totalAmount": 157.3,
      "itemRef": {
        "id": "075410d4-7edc-4936-ba52-9e1e43cbe300"
      },
      "taxRateRef": {
        "id": "d606732b-db18-44d7-823b-7f15f42c32ea"
      },
      "accountRef": {
        "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3"
      }
    }
  ],
  "supplierRef": {
    "id": "67C6A7A1-5E84-4AC4-B950-24A114E379D0",
    "supplierName": "Chin's Gas and Oil"
  },
  "createdFromLineRef": {
    "id": "8462",
    "dataType": "bills",
    "line": 1
  }
}

Response

Success

changesPushOperationChange[] nullable— unresolved $ref

Contains a single entry that communicates which record has changed and the manner in which it changed.

Available data types

companyIdSchema required— unresolved $ref

pushOperationKeystring 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.

dataConnectionKeySchema required— unresolved $ref

requestedOnUtcstring required

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.

completedOnUtcstring

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.

timeoutInMinutesinteger nullable

Number of minutes the push operation must complete within before it times out.

timeoutInSecondsinteger nullable

Number of seconds the push operation must complete within before it times out.

statusPushOperationStatus required— unresolved $ref

errorMessagestring nullable

A message about the error.

validationValidation — unresolved $ref

statusCodeinteger required

Push status code.

Changes

Changed in 4 of the 51 revisions of this API.22017

Mar 11, 20242faca70130544See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Feb 22, 2024947edb6b06df2See the full diff
- ○
  added the new optional request property ///
  new-optional-request-property
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Feb 13, 20244bfab0afa6ca8See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 11, 20243bc6baa032532203See the full diff
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added to the / response property allOf list for the response status
  response-property-all-of-added
- ○
  removed from the / response property allOf list for the response status
  response-property-all-of-removed
- ○
  response property allOf[subschema #1]/data/allOf[subschema #1 -> subschema #2]/ deprecated
  response-property-deprecated

Full history

Update bill credit note

Query parameters

Request body

Overview

Example request

Response

Overview

Changes