//native
type Xero = {
token: string
}
/**
* Updates a specific expense claims
*
*/
export async function main(
auth: Xero,
ExpenseClaimID: string,
xero_tenant_id: string,
Idempotency_Key: string,
body: {
ExpenseClaims?: {
ExpenseClaimID?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED'
Payments?: {
Invoice?: {
Type?:
| 'ACCPAY'
| 'ACCPAYCREDIT'
| 'APOVERPAYMENT'
| 'APPREPAYMENT'
| 'ACCREC'
| 'ACCRECCREDIT'
| 'AROVERPAYMENT'
| 'ARPREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
Date?: string
DueDate?: string
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
InvoiceNumber?: string
Reference?: string
BrandingThemeID?: string
Url?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
CurrencyRate?: number
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
SentToContact?: false | true
ExpectedPaymentDate?: string
PlannedPaymentDate?: string
CISDeduction?: number
CISRate?: number
SubTotal?: number
TotalTax?: number
Total?: number
TotalDiscount?: number
InvoiceID?: string
RepeatingInvoiceID?: string
HasAttachments?: never
IsDiscounted?: false | true
Payments?: {}[]
Prepayments?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {}
Overpayment?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
Prepayment?: {}
CreditNote?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
Overpayments?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {}
Overpayment?: {}
Prepayment?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
CreditNote?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
AmountDue?: number
AmountPaid?: number
FullyPaidOnDate?: string
AmountCredited?: number
UpdatedDateUTC?: string
CreditNotes?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {}
Overpayment?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
Prepayment?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
CreditNote?: {}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}[]
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasErrors?: never
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
CreditNote?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {
Type?:
| 'ACCPAY'
| 'ACCPAYCREDIT'
| 'APOVERPAYMENT'
| 'APPREPAYMENT'
| 'ACCREC'
| 'ACCRECCREDIT'
| 'AROVERPAYMENT'
| 'ARPREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
Date?: string
DueDate?: string
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
InvoiceNumber?: string
Reference?: string
BrandingThemeID?: string
Url?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
CurrencyRate?: number
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
SentToContact?: false | true
ExpectedPaymentDate?: string
PlannedPaymentDate?: string
CISDeduction?: number
CISRate?: number
SubTotal?: number
TotalTax?: number
Total?: number
TotalDiscount?: number
InvoiceID?: string
RepeatingInvoiceID?: string
HasAttachments?: never
IsDiscounted?: false | true
Payments?: {}[]
Prepayments?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
Overpayments?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
AmountDue?: number
AmountPaid?: number
FullyPaidOnDate?: string
AmountCredited?: number
UpdatedDateUTC?: string
CreditNotes?: {}[]
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasErrors?: never
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Overpayment?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
Prepayment?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
CreditNote?: {}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Prepayment?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {
Type?:
| 'ACCPAY'
| 'ACCPAYCREDIT'
| 'APOVERPAYMENT'
| 'APPREPAYMENT'
| 'ACCREC'
| 'ACCRECCREDIT'
| 'AROVERPAYMENT'
| 'ARPREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
Date?: string
DueDate?: string
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
InvoiceNumber?: string
Reference?: string
BrandingThemeID?: string
Url?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
CurrencyRate?: number
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
SentToContact?: false | true
ExpectedPaymentDate?: string
PlannedPaymentDate?: string
CISDeduction?: number
CISRate?: number
SubTotal?: number
TotalTax?: number
Total?: number
TotalDiscount?: number
InvoiceID?: string
RepeatingInvoiceID?: string
HasAttachments?: never
IsDiscounted?: false | true
Payments?: {}[]
Prepayments?: {}[]
Overpayments?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
AmountDue?: number
AmountPaid?: number
FullyPaidOnDate?: string
AmountCredited?: number
UpdatedDateUTC?: string
CreditNotes?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}[]
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasErrors?: never
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Overpayment?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
Prepayment?: {}
CreditNote?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
Overpayment?: {
Type?: 'AROVERPAYMENT' | 'RECEIVE-OVERPAYMENT' | 'SPEND-OVERPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
OverpaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {
AllocationID?: string
Invoice: {
Type?:
| 'ACCPAY'
| 'ACCPAYCREDIT'
| 'APOVERPAYMENT'
| 'APPREPAYMENT'
| 'ACCREC'
| 'ACCRECCREDIT'
| 'AROVERPAYMENT'
| 'ARPREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
Date?: string
DueDate?: string
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
InvoiceNumber?: string
Reference?: string
BrandingThemeID?: string
Url?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
CurrencyRate?: number
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
SentToContact?: false | true
ExpectedPaymentDate?: string
PlannedPaymentDate?: string
CISDeduction?: number
CISRate?: number
SubTotal?: number
TotalTax?: number
Total?: number
TotalDiscount?: number
InvoiceID?: string
RepeatingInvoiceID?: string
HasAttachments?: never
IsDiscounted?: false | true
Payments?: {}[]
Prepayments?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
Overpayments?: {}[]
AmountDue?: number
AmountPaid?: number
FullyPaidOnDate?: string
AmountCredited?: number
UpdatedDateUTC?: string
CreditNotes?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: {
Outstanding?: number
Overdue?: number
}
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}[]
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasErrors?: never
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Overpayment?: {}
Prepayment?: {
Type?: 'APPREPAYMENT' | 'ARPREPAYMENT' | 'RECEIVE-PREPAYMENT' | 'SPEND-PREPAYMENT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
Status?: 'AUTHORISED' | 'PAID' | 'VOIDED'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
Reference?: string
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
PrepaymentID?: string
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
Payments?: {}[]
AppliedAmount?: number
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
CreditNote?: {
Type?: 'ACCPAYCREDIT' | 'ACCRECCREDIT'
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: {
Outstanding?: number
Overdue?: number
}
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
Date?: string
DueDate?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'PAID' | 'VOIDED' | 'DELETED' | 'DRAFT'
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?:
| 'TAXABLE'
| 'NON_TAXABLE'
| 'EXEMPT'
| 'PART_TAXABLE'
| 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
SubTotal?: number
TotalTax?: number
Total?: number
CISDeduction?: number
CISRate?: number
UpdatedDateUTC?: string
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
FullyPaidOnDate?: string
CreditNoteID?: string
CreditNoteNumber?: string
Reference?: string
SentToContact?: false | true
CurrencyRate?: number
RemainingCredit?: number
Allocations?: {}[]
AppliedAmount?: number
Payments?: {}[]
BrandingThemeID?: string
StatusAttributeString?: string
HasAttachments?: never
HasErrors?: never
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
InvoiceAddresses?: {
InvoiceAddressType?: 'FROM' | 'TO'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
}[]
}
Amount: number
Date: string
IsDeleted?: false | true
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
}[]
AppliedAmount?: number
Payments?: {}[]
HasAttachments?: never
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}
InvoiceNumber?: string
CreditNoteNumber?: string
BatchPayment?: {
Account?: {
Code?: string
Name?: string
AccountID?: string
Type?:
| 'BANK'
| 'CURRENT'
| 'CURRLIAB'
| 'DEPRECIATN'
| 'DIRECTCOSTS'
| 'EQUITY'
| 'EXPENSE'
| 'FIXED'
| 'INVENTORY'
| 'LIABILITY'
| 'NONCURRENT'
| 'OTHERINCOME'
| 'OVERHEADS'
| 'PREPAYMENT'
| 'REVENUE'
| 'SALES'
| 'TERMLIAB'
| 'PAYG'
BankAccountNumber?: string
Status?: 'DELETED' | 'ACTIVE' | 'ARCHIVED'
Description?: string
BankAccountType?: '' | 'NONE' | 'BANK' | 'CREDITCARD' | 'PAYPAL'
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
TaxType?: string
EnablePaymentsToAccount?: false | true
ShowInExpenseClaims?: false | true
Class?: 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' | 'ASSET'
SystemAccount?:
| ''
| 'DEBTORS'
| 'CREDITORS'
| 'BANKCURRENCYGAIN'
| 'GST'
| 'GSTONIMPORTS'
| 'HISTORICAL'
| 'REALISEDCURRENCYGAIN'
| 'RETAINEDEARNINGS'
| 'ROUNDING'
| 'TRACKINGTRANSFERS'
| 'UNPAIDEXPCLM'
| 'UNREALISEDCURRENCYGAIN'
| 'WAGEPAYABLES'
| 'CISASSETS'
| 'CISASSET'
| 'CISLABOUR'
| 'CISLABOUREXPENSE'
| 'CISLABOURINCOME'
| 'CISLIABILITY'
| 'CISMATERIALS'
ReportingCode?: string
ReportingCodeName?: string
HasAttachments?: never
UpdatedDateUTC?: string
AddToWatchlist?: false | true
ValidationErrors?: { Message?: string }[]
}
Reference?: string
Particulars?: string
Code?: string
Details?: string
Narrative?: string
BatchPaymentID?: string
DateString?: string
Date?: string
Amount?: number
Payments?: {}[]
Type?: 'PAYBATCH' | 'RECBATCH'
Status?: 'AUTHORISED' | 'DELETED'
TotalAmount?: number
UpdatedDateUTC?: string
IsReconciled?: false | true
ValidationErrors?: { Message?: string }[]
}
Account?: {
Code?: string
Name?: string
AccountID?: string
Type?:
| 'BANK'
| 'CURRENT'
| 'CURRLIAB'
| 'DEPRECIATN'
| 'DIRECTCOSTS'
| 'EQUITY'
| 'EXPENSE'
| 'FIXED'
| 'INVENTORY'
| 'LIABILITY'
| 'NONCURRENT'
| 'OTHERINCOME'
| 'OVERHEADS'
| 'PREPAYMENT'
| 'REVENUE'
| 'SALES'
| 'TERMLIAB'
| 'PAYG'
BankAccountNumber?: string
Status?: 'DELETED' | 'ACTIVE' | 'ARCHIVED'
Description?: string
BankAccountType?: '' | 'NONE' | 'BANK' | 'CREDITCARD' | 'PAYPAL'
CurrencyCode?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
TaxType?: string
EnablePaymentsToAccount?: false | true
ShowInExpenseClaims?: false | true
Class?: 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' | 'ASSET'
SystemAccount?:
| ''
| 'DEBTORS'
| 'CREDITORS'
| 'BANKCURRENCYGAIN'
| 'GST'
| 'GSTONIMPORTS'
| 'HISTORICAL'
| 'REALISEDCURRENCYGAIN'
| 'RETAINEDEARNINGS'
| 'ROUNDING'
| 'TRACKINGTRANSFERS'
| 'UNPAIDEXPCLM'
| 'UNREALISEDCURRENCYGAIN'
| 'WAGEPAYABLES'
| 'CISASSETS'
| 'CISASSET'
| 'CISLABOUR'
| 'CISLABOUREXPENSE'
| 'CISLABOURINCOME'
| 'CISLIABILITY'
| 'CISMATERIALS'
ReportingCode?: string
ReportingCodeName?: string
HasAttachments?: never
UpdatedDateUTC?: string
AddToWatchlist?: false | true
ValidationErrors?: { Message?: string }[]
}
Code?: string
Date?: string
CurrencyRate?: number
Amount?: number
BankAmount?: number
Reference?: string
IsReconciled?: false | true
Status?: 'AUTHORISED' | 'DELETED'
PaymentType?:
| 'ACCRECPAYMENT'
| 'ACCPAYPAYMENT'
| 'ARCREDITPAYMENT'
| 'APCREDITPAYMENT'
| 'AROVERPAYMENTPAYMENT'
| 'ARPREPAYMENTPAYMENT'
| 'APPREPAYMENTPAYMENT'
| 'APOVERPAYMENTPAYMENT'
UpdatedDateUTC?: string
PaymentID?: string
BatchPaymentID?: string
BankAccountNumber?: string
Particulars?: string
Details?: string
HasAccount?: never
HasValidationErrors?: never
StatusAttributeString?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
}[]
User?: {
UserID?: string
EmailAddress?: string
FirstName?: string
LastName?: string
UpdatedDateUTC?: string
IsSubscriber?: false | true
OrganisationRole?:
| 'READONLY'
| 'INVOICEONLY'
| 'STANDARD'
| 'FINANCIALADVISER'
| 'MANAGEDCLIENT'
| 'CASHBOOKCLIENT'
| 'UNKNOWN'
}
Receipts?: {
Date?: string
Contact?: {
ContactID?: string
MergedToContactID?: string
ContactNumber?: string
AccountNumber?: string
ContactStatus?: 'ACTIVE' | 'ARCHIVED' | 'GDPRREQUEST'
Name?: string
FirstName?: string
LastName?: string
CompanyNumber?: string
EmailAddress?: string
ContactPersons?: {
FirstName?: string
LastName?: string
EmailAddress?: string
IncludeInEmails?: false | true
}[]
BankAccountDetails?: string
TaxNumber?: string
AccountsReceivableTaxType?: string
AccountsPayableTaxType?: string
Addresses?: {
AddressType?: 'POBOX' | 'STREET'
AddressLine1?: string
AddressLine2?: string
AddressLine3?: string
AddressLine4?: string
City?: string
Region?: string
PostalCode?: string
Country?: string
AttentionTo?: string
}[]
Phones?: {
PhoneType?: 'DEFAULT' | 'DDI' | 'MOBILE' | 'FAX' | 'OFFICE'
PhoneNumber?: string
PhoneAreaCode?: string
PhoneCountryCode?: string
}[]
IsSupplier?: false | true
IsCustomer?: false | true
SalesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
PurchasesDefaultLineAmountType?: 'INCLUSIVE' | 'EXCLUSIVE' | 'NONE'
DefaultCurrency?:
| 'AED'
| 'AFN'
| 'ALL'
| 'AMD'
| 'ANG'
| 'AOA'
| 'ARS'
| 'AUD'
| 'AWG'
| 'AZN'
| 'BAM'
| 'BBD'
| 'BDT'
| 'BGN'
| 'BHD'
| 'BIF'
| 'BMD'
| 'BND'
| 'BOB'
| 'BRL'
| 'BSD'
| 'BTN'
| 'BWP'
| 'BYN'
| 'BYR'
| 'BZD'
| 'CAD'
| 'CDF'
| 'CHF'
| 'CLF'
| 'CLP'
| 'CNY'
| 'COP'
| 'CRC'
| 'CUC'
| 'CUP'
| 'CVE'
| 'CZK'
| 'DJF'
| 'DKK'
| 'DOP'
| 'DZD'
| 'EEK'
| 'EGP'
| 'ERN'
| 'ETB'
| 'EUR'
| 'FJD'
| 'FKP'
| 'GBP'
| 'GEL'
| 'GHS'
| 'GIP'
| 'GMD'
| 'GNF'
| 'GTQ'
| 'GYD'
| 'HKD'
| 'HNL'
| 'HRK'
| 'HTG'
| 'HUF'
| 'IDR'
| 'ILS'
| 'INR'
| 'IQD'
| 'IRR'
| 'ISK'
| 'JMD'
| 'JOD'
| 'JPY'
| 'KES'
| 'KGS'
| 'KHR'
| 'KMF'
| 'KPW'
| 'KRW'
| 'KWD'
| 'KYD'
| 'KZT'
| 'LAK'
| 'LBP'
| 'LKR'
| 'LRD'
| 'LSL'
| 'LTL'
| 'LVL'
| 'LYD'
| 'MAD'
| 'MDL'
| 'MGA'
| 'MKD'
| 'MMK'
| 'MNT'
| 'MOP'
| 'MRO'
| 'MRU'
| 'MUR'
| 'MVR'
| 'MWK'
| 'MXN'
| 'MXV'
| 'MYR'
| 'MZN'
| 'NAD'
| 'NGN'
| 'NIO'
| 'NOK'
| 'NPR'
| 'NZD'
| 'OMR'
| 'PAB'
| 'PEN'
| 'PGK'
| 'PHP'
| 'PKR'
| 'PLN'
| 'PYG'
| 'QAR'
| 'RON'
| 'RSD'
| 'RUB'
| 'RWF'
| 'SAR'
| 'SBD'
| 'SCR'
| 'SDG'
| 'SEK'
| 'SGD'
| 'SHP'
| 'SKK'
| 'SLE'
| 'SLL'
| 'SOS'
| 'SRD'
| 'STD'
| 'STN'
| 'SVC'
| 'SYP'
| 'SZL'
| 'THB'
| 'TJS'
| 'TMT'
| 'TND'
| 'TOP'
| 'TRY'
| 'TTD'
| 'TWD'
| 'TZS'
| 'UAH'
| 'UGX'
| 'USD'
| 'UYU'
| 'UZS'
| 'VEF'
| 'VES'
| 'VND'
| 'VUV'
| 'WST'
| 'XAF'
| 'XCD'
| 'XOF'
| 'XPF'
| 'YER'
| 'ZAR'
| 'ZMW'
| 'ZMK'
| 'ZWD'
XeroNetworkKey?: string
SalesDefaultAccountCode?: string
PurchasesDefaultAccountCode?: string
SalesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
PurchasesTrackingCategories?: {
TrackingCategoryName?: string
TrackingOptionName?: string
}[]
TrackingCategoryName?: string
TrackingCategoryOption?: string
PaymentTerms?: {
Bills?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
Sales?: {
Day?: number
Type?:
| 'DAYSAFTERBILLDATE'
| 'DAYSAFTERBILLMONTH'
| 'OFCURRENTMONTH'
| 'OFFOLLOWINGMONTH'
}
}
UpdatedDateUTC?: string
ContactGroups?: {
Name?: string
Status?: 'DELETED' | 'ACTIVE'
ContactGroupID?: string
Contacts?: {}[]
}[]
Website?: string
BrandingTheme?: {
BrandingThemeID?: string
Name?: string
LogoUrl?: string
Type?: 'INVOICE'
SortOrder?: number
CreatedDateUTC?: string
}
BatchPayments?: {
BankAccountNumber?: string
BankAccountName?: string
Details?: string
Code?: string
Reference?: string
}
Discount?: number
Balances?: {
AccountsReceivable?: { Outstanding?: number; Overdue?: number }
AccountsPayable?: { Outstanding?: number; Overdue?: number }
}
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
HasAttachments?: never
ValidationErrors?: { Message?: string }[]
HasValidationErrors?: never
StatusAttributeString?: string
}
LineItems?: {
LineItemID?: string
Description?: string
Quantity?: number
UnitAmount?: number
ItemCode?: string
AccountCode?: string
AccountID?: string
TaxType?: string
TaxAmount?: number
Item?: { Code?: string; Name?: string; ItemID?: string }
LineAmount?: number
Tracking?: {
TrackingCategoryID?: string
TrackingOptionID?: string
Name?: string
Option?: string
}[]
DiscountRate?: number
DiscountAmount?: number
RepeatingInvoiceID?: string
Taxability?: 'TAXABLE' | 'NON_TAXABLE' | 'EXEMPT' | 'PART_TAXABLE' | 'NOT_APPLICABLE'
SalesTaxCodeId?: number
TaxBreakdown?: {
TaxComponentId?: string
Type?:
| 'SYSGST/USCOUNTRY'
| 'SYSGST/USSTATE'
| 'SYSGST/USCOUNTY'
| 'SYSGST/USCITY'
| 'SYSGST/USSPECIAL'
Name?: string
TaxPercentage?: number
TaxAmount?: number
TaxableAmount?: number
NonTaxableAmount?: number
ExemptAmount?: number
StateAssignedNo?: string
JurisdictionRegion?: string
}[]
}[]
User?: {
UserID?: string
EmailAddress?: string
FirstName?: string
LastName?: string
UpdatedDateUTC?: string
IsSubscriber?: false | true
OrganisationRole?:
| 'READONLY'
| 'INVOICEONLY'
| 'STANDARD'
| 'FINANCIALADVISER'
| 'MANAGEDCLIENT'
| 'CASHBOOKCLIENT'
| 'UNKNOWN'
}
Reference?: string
LineAmountTypes?: 'Exclusive' | 'Inclusive' | 'NoTax'
SubTotal?: number
TotalTax?: number
Total?: number
ReceiptID?: string
Status?: 'SUBMITTED' | 'AUTHORISED' | 'VOIDED' | 'DRAFT' | 'DECLINED'
ReceiptNumber?: string
UpdatedDateUTC?: string
HasAttachments?: never
Url?: string
ValidationErrors?: { Message?: string }[]
Warnings?: { Message?: string }[]
Attachments?: {
AttachmentID?: string
FileName?: string
Url?: string
MimeType?: string
ContentLength?: number
IncludeOnline?: false | true
}[]
}[]
UpdatedDateUTC?: string
Total?: number
AmountDue?: number
AmountPaid?: number
PaymentDueDate?: string
ReportingDate?: string
ReceiptID?: string
}[]
}
) {
const url = new URL(`https://api.xero.com/api.xro/2.0/ExpenseClaims/${ExpenseClaimID}`)
const response = await fetch(url, {
method: 'POST',
headers: {
Accept: 'application/json',
'xero-tenant-id': xero_tenant_id,
'Idempotency-Key': Idempotency_Key,
'Content-Type': 'application/json',
Authorization: 'Bearer ' + auth.token
},
body: JSON.stringify(body)
})
if (!response.ok) {
const text = await response.text()
throw new Error(`${response.status} ${text}`)
}
return await response.json()
}
Submitted by hugo697 448 days ago