Sign in

v2

latestSwagger 2.02026-08-04108164321.0 KB
CreditNote

Retrieves a single credit note by its Transaction ID, including line items and invoice allocations.

get/api/CreditNote/{id}

Path parameters

idinteger required

Credit Note ID Number

Response

Returns the credit note details with line items and allocations.

TransactionIDinteger

Unique identifier for the credit note transaction.

TransactionPrefixstring

Prefix used in the credit note number.

CreditNoteNumberstring

The full credit note number including prefix.

CustomerIDFKinteger

The customer company ID this credit note is issued to.

DateIssuedstring date-time

The date the credit note was issued.

TransactionStatusCodestring

Current status of the credit note.

Balancenumber double

Unallocated balance remaining on the credit note.

CurrencyCodestring

ISO 3-character currency code for the credit note.

TotalAmountnumber double

Total credit note amount.

Notesstring

Additional notes on the credit note.

DateCreatedstring date-time

Date and time the record was created.

DateUpdatedstring date-time

Date and time the record was last updated.

ViewCreditNoteURLstring

URL to view this credit note in the Avaza web application.