| id |
string |
The unique identifier for the item |
[optional] |
| displayedAs |
string |
The name of the resource |
[optional] |
| path |
string |
The API path for the resource |
[optional] |
| createdAt |
\DateTime |
The datetime when the item was created |
[optional] |
| updatedAt |
\DateTime |
The datetime when the item was last updated |
[optional] |
| links |
\SynergiTech\Sage\Model\Link[] |
Links for the resource |
[optional] |
| editable |
bool |
Indicates whether artefact can be edited |
[optional] |
| vatReverseCharge |
bool |
Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business. |
[optional] |
| taxCalculationMethod |
string |
The tax calculation method, if applicable, for this sales credit note, returns invoice or cash. |
[optional] |
| destinationConsignment |
bool |
Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings. |
[optional] |
| destinationVatRatesInUse |
bool |
Indicates whether destination vat rates are in use |
[optional] |
| transaction |
\SynergiTech\Sage\Model\Transaction |
|
[optional] |
| transactionType |
\SynergiTech\Sage\Model\Base |
|
[optional] |
| deletedAt |
\DateTime |
The datetime when the item was deleted |
[optional] |
| isCis |
bool |
Identifies an artefact as CIS (Construction Industry Scheme) applicable - UK only |
[optional] |
| cisApplicableAmount |
float |
The total amount of CIS deductible labour - only applicable in UK |
[optional] |
| baseCurrencyCisApplicableAmount |
float |
The total amount of CIS deductible labour in the base currency - only applicable in UK |
[optional] |
| totalAfterCisDeduction |
float |
The total of the artefact with the total of CIS deducted - only applicable in UK |
[optional] |
| baseCurrencyTotalAfterCisDeduction |
float |
The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK |
[optional] |
| hasCisLabour |
bool |
Identifies an artefact as having CIS Labour line items |
[optional] |
| hasCisMaterials |
bool |
Identifies an artefact as having CIS Materials line items |
[optional] |
| contact |
\SynergiTech\Sage\Model\Contact |
|
[optional] |
| creditNoteNumberPrefix |
string |
The credit note number prefix |
[optional] |
| creditNoteNumber |
string |
The generated credit note number |
[optional] |
| contactName |
string |
The name of the contact when the credit note was created |
[optional] |
| contactReference |
string |
The reference of the contact when the credit note was created |
[optional] |
| date |
\DateTime |
The date of the credit note |
[optional] |
| originalInvoiceDate |
\DateTime |
The date of the original invoice |
[optional] |
| reference |
string |
The reference for the credit note |
[optional] |
| mainAddressFreeForm |
string |
The free-form main address of the credit note Note: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though. |
[optional] |
| mainAddress |
\SynergiTech\Sage\Model\SalesArtefactAddress |
|
[optional] |
| deliveryAddressFreeForm |
string |
The free-form delivery address of the credit note Note: An upper length limit of 500 characters is imposed conditionally and may not apply in every request. A hard upper limit of 65535 characters is imposed by the storage layer, though. |
[optional] |
| deliveryAddress |
\SynergiTech\Sage\Model\SalesArtefactAddress |
|
[optional] |
| notes |
string |
credit note notes |
[optional] |
| termsAndConditions |
string |
Credit note terms and conditions |
[optional] |
| shippingNetAmount |
float |
The net shipping amount |
[optional] |
| shippingTaxRate |
\SynergiTech\Sage\Model\Base |
|
[optional] |
| shippingTaxAmount |
float |
The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate. |
[optional] |
| shippingTaxBreakdown |
\SynergiTech\Sage\Model\TaxBreakdown[] |
The shipping tax breakdown for the credit note |
[optional] |
| totalQuantity |
float |
The total quantity of the credit note |
[optional] |
| shippingTotalAmount |
float |
The total shipping amount |
[optional] |
| netAmount |
float |
The net amount of the credit note |
[optional] |
| taxAmount |
float |
The tax amount of the credit note |
[optional] |
| totalAmount |
float |
The total amount of the credit note |
[optional] |
| paymentsAllocationsTotalAmount |
float |
The total amount of all payments and allocations |
[optional] |
| paymentsAllocationsTotalDiscount |
float |
The total discount of all payments and allocations |
[optional] |
| totalPaid |
float |
The total paid amount of the credit note including any payments, allocations and discounts |
[optional] |
| outstandingAmount |
float |
The outstanding amount of the credit note |
[optional] |
| currency |
\SynergiTech\Sage\Model\Base |
|
[optional] |
| exchangeRate |
float |
The exchange rate for the credit note |
[optional] |
| inverseExchangeRate |
float |
The inverse exchange rate for the credit note |
[optional] |
| baseCurrencyShippingNetAmount |
float |
The net shipping amount in base currency |
[optional] |
| baseCurrencyShippingTaxAmount |
float |
The tax shipping amount in base currency |
[optional] |
| baseCurrencyShippingTaxBreakdown |
\SynergiTech\Sage\Model\TaxBreakdown[] |
The shipping tax breakdown for the credit note in base currency |
[optional] |
| baseCurrencyShippingTotalAmount |
float |
The total shipping amount in base currency |
[optional] |
| totalDiscountAmount |
float |
The discount amount on the credit note |
[optional] |
| baseCurrencyTotalDiscountAmount |
float |
The discount amount on the credit note in base currency |
[optional] |
| baseCurrencyNetAmount |
float |
The net amount of the credit note in base currency |
[optional] |
| baseCurrencyTaxAmount |
float |
The tax amount of the credit note in base currency |
[optional] |
| baseCurrencyTotalAmount |
float |
The total amount of the credit note in base currency |
[optional] |
| baseCurrencyOutstandingAmount |
float |
The outstanding amount of the credit note in base currency |
[optional] |
| status |
\SynergiTech\Sage\Model\Base |
|
[optional] |
| sent |
bool |
Indicates whether the credit note has been sent |
[optional] |
| sentByEmail |
bool |
Indicates whether the credit note has been emailed |
[optional] |
| voidReason |
string |
The reason the credit note was voided |
[optional] |
| creditNoteLines |
\SynergiTech\Sage\Model\SalesCreditNoteLineItem[] |
The credit note lines of the credit note |
[optional] |
| taxAnalysis |
\SynergiTech\Sage\Model\ArtefactTaxAnalysis[] |
The credit note tax analysis |
[optional] |
| detailedTaxAnalysis |
\SynergiTech\Sage\Model\ArtefactDetailedTaxAnalysis |
|
[optional] |
| paymentsAllocations |
\SynergiTech\Sage\Model\PaymentAllocation[] |
The associated payments and allocations |
[optional] |
| lastPaid |
\DateTime |
The date of the last payment |
[optional] |
| taxAddressRegion |
\SynergiTech\Sage\Model\Base |
|
[optional] |
| taxReconciled |
bool |
Indicates if the sales credit note is tax reconciled or not. |
[optional] |
| migrated |
bool |
Indicates if the sales credit note was migrated from another system. |
[optional] |
| withholdingTaxRate |
float |
The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate) |
[optional] |
| withholdingTaxAmount |
float |
The withheld Tax Amount - only applicable in UK (CIS subcontractor tax) |
[optional] |
| baseCurrencyWithholdingTaxAmount |
float |
The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax) |
[optional] |
