Alokai

OrgDocument

Representation of an organizational document. OrgDocument

export interface OrgDocument {
	'amount': number;
	'attachments'?: Array<OrgDocumentAttachment>;
	'createdAtDate'?: string;
	'currency': Currency;
	'dueAtDate'?: string;
	'formattedAmount': string;
	'formattedOpenAmount'?: string;
	'id': string;
	'openAmount'?: number;
	'orgDocumentType'?: OrgDocumentType;
	'status': string;
}

Properties

NameRequiredTypeDescription
amountRequirednumberOriginal amount due for the organizational document. {number} OrgDocument
attachmentsOptionalArray<OrgDocumentAttachment>Attachments associated to the organizational document. {Array<OrgDocumentAttachment>} OrgDocument
createdAtDateOptionalstringCreation date for the organizational document. {string} OrgDocument
currencyRequiredCurrency{Currency} OrgDocument
dueAtDateOptionalstringDue date for the organizational document. {string} OrgDocument
formattedAmountRequiredstringOriginal amount due for the organizational document, formatted as per the selected currency. {string} OrgDocument
formattedOpenAmountOptionalstringOpen amount due for the organizational document, formatted as per the selected currency. {string} OrgDocument
idRequiredstringUnique identifier for the organizational document. {string} OrgDocument
openAmountOptionalnumberOpen amount due for the organizational document. {number} OrgDocument
orgDocumentTypeOptionalOrgDocumentType{OrgDocumentType} OrgDocument
statusRequiredstringOrganizational document status. Possible values are: open, closed. {string} OrgDocument

Referenced Types

On this page