Credit Note base

type CreditNote {
  ref: string;  
  issued: string;
  recipient: CreditNoteRecipient;
  invoiceRefs: string[];
  total: {
    amount: number;
    currency?: string;
  };
  customInfo?: StringStringTMap<string | number>;
  error?: Error;
  type?: 'Sent' | 'Received';
}

type CreditNoteRecipient {
  taxId: string;
  name: string;
  customInfo?: StringStringTMap<string | number>;
  contact?: {
    email?: string;
  };
}

Field information

Name	Type	Required	Description
ref	string	Yes	Sequential number of document
issued	string (ISO 8601 date)	Yes	Date of document (issue date)
recipient.taxId	string	Yes	TAX identification number.
recipient.name	string	Yes	Company name or name and surname
recipient.contact.email	string	No	Recipient email address
invoiceRefs	string array	Yes	Invoices associated with this document
total.amount	number	Yes	The total amount of the document, including tax charged.
total.currency	string	No	Three-letter currency code (ISO 4217-1 alpha-3 ). Defaults to organisation currency.
type	string (System generated)	No	A value from an enumerated list of types: Sent Received
error	string map (System generated)	No	When activation errors occur downstream, the transaction will have an Error status with this error object for more detail. { status?: number; message: string; description?: string; }

Example CSV file

Credit note - Generic.csv