Credit Notes

Get a credit note

get/credit-notes/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/credit-notes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The credit note uuid

Response

200

idstring

The unique identifier for the object.

companyNamestring nullable

The company name printed on the credit note.

companyStreetAddressstring nullable

The company street address printed on the credit note.

numberstring

The credit note number (e.g. CN-0042).

statusId'draft' | 'open' | 'applied'

The current status of the credit note.

adjustEarnedRevenueboolean

Whether publishing this credit note reduced the earned revenue of the credited projects.

billTostring

The billing address or recipient text printed on the credit note.

creditNoteForstring nullable

A brief description of what the credit note is for.

issuedOnstring date

The date the credit note was issued (YYYY-MM-DD).

poNumberstring nullable

The purchase order number associated with the credit note.

notesstring nullable

Internal or external notes on the credit note.

emailSubjectstring nullable

The email subject used when sending the credit note.

emailsstring[]

The list of recipient email addresses.

ccEmailsstring[]

The list of CC email addresses.

emailBodystring nullable

The email body used when sending the credit note.

emailFromNamestring nullable

The sender display name used when sending the credit note.

replyTostring nullable

The reply-to email address used when sending the credit note.

sendBccboolean

Whether the workspace is BCC'd when the credit note is sent.

sentOnstring date nullable

The date the credit note was sent (YYYY-MM-DD).

currencystring

The ISO 4217 currency code for the credit note (e.g. USD).

subtotalnumber

The sum of all line item amounts before tax.

taxRatenumber

The tax rate applied to taxable line items, expressed as a decimal (e.g. 0.0775 for 7.75%).

totalTaxnumber

The total tax amount calculated from taxable line items.

totalnumber

The total amount of the credit note including tax.

appliedCreditnumber

The total amount of credit that has been applied to invoices or payments.

remainingCreditnumber

The remaining unapplied credit balance.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

Changes

No recorded changes to this operation across all 1 revision of this API.