vendor_invoices_models

type AdditionalDetails struct {

	// The detail of the additional information provided by the selling party.
	// Required: true
	Detail *string `json:"detail"`

	// The language code of the additional information detail.
	LanguageCode string `json:"languageCode,omitempty"`

	// The type of the additional information provided by the selling party.
	// Required: true
	// Enum: [SUR OCR CartonCount]
	Type *string `json:"type"`
}

type Address struct {

	// First line of street address.
	// Required: true
	AddressLine1 *string `json:"addressLine1"`

	// Additional address information, if required.
	AddressLine2 string `json:"addressLine2,omitempty"`

	// Additional address information, if required.
	AddressLine3 string `json:"addressLine3,omitempty"`

	// The city where the person, business or institution is located.
	City string `json:"city,omitempty"`

	// The two digit country code. In ISO 3166-1 alpha-2 format.
	// Required: true
	// Max Length: 2
	CountryCode *string `json:"countryCode"`

	// The county where person, business or institution is located.
	County string `json:"county,omitempty"`

	// The district where person, business or institution is located.
	District string `json:"district,omitempty"`

	// The name of the person, business or institution at that address.
	// Required: true
	Name *string `json:"name"`

	// The phone number of the person, business or institution located at that address.
	Phone string `json:"phone,omitempty"`

	// The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
	PostalOrZipCode string `json:"postalOrZipCode,omitempty"`

	// The state or region where person, business or institution is located.
	StateOrRegion string `json:"stateOrRegion,omitempty"`
}

type AllowanceDetails struct {

	// Total monetary amount related to this allowance.
	// Required: true
	AllowanceAmount *Money `json:"allowanceAmount"`

	// Description of the allowance.
	Description string `json:"description,omitempty"`

	// Tax amount details applied on this allowance.
	TaxDetails []*TaxDetails `json:"taxDetails"`

	// Type of the allowance applied.
	// Required: true
	// Enum: [Discount DiscountIncentive Defective Promotional UnsaleableMerchandise Special]
	Type *string `json:"type"`
}

type ChargeDetails struct {

	// Total monetary amount related to this charge.
	// Required: true
	ChargeAmount *Money `json:"chargeAmount"`

	// Description of the charge.
	Description string `json:"description,omitempty"`

	// Tax amount details applied on this charge.
	TaxDetails []*TaxDetails `json:"taxDetails"`

	// Type of the charge applied.
	// Required: true
	// Enum: [Freight Packing Duty Service SmallOrder InsurancePlacementCost InsuranceFee SpecialHandlingService CollectionAndRecyclingService EnvironmentalProtectionService TaxCollectedAtSource]
	Type *string `json:"type"`
}

type CreditNoteDetails struct {

	// Identifies the consignor reference number (VRET number), if generated by Amazon.
	ConsignorsReferenceNumber string `json:"consignorsReferenceNumber,omitempty"`

	// Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note.
	CoopReferenceNumber string `json:"coopReferenceNumber,omitempty"`

	// Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes.
	DebitNoteNumber string `json:"debitNoteNumber,omitempty"`

	// Date that a return is received by the vendor. It is mandatory for Returns Credit Note.
	// Format: date-time
	GoodsReturnDate DateTime `json:"goodsReturnDate,omitempty"`

	// Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes.
	ReferenceInvoiceNumber string `json:"referenceInvoiceNumber,omitempty"`

	// Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes.
	ReturnsReferenceNumber string `json:"returnsReferenceNumber,omitempty"`

	// Identifies the Returned Merchandise Authorization ID, if generated.
	RmaID string `json:"rmaId,omitempty"`
}

type DateTime strfmt.DateTime

type Decimal string

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition.
	// Required: true
	Message *string `json:"message"`
}

type ErrorList []*Error

type Invoice struct {

	// Additional details provided by the selling party, for tax related or other purposes.
	AdditionalDetails []*AdditionalDetails `json:"additionalDetails"`

	// Total allowance amount details for all line items.
	AllowanceDetails []*AllowanceDetails `json:"allowanceDetails"`

	// Name, address and tax details of the party to whom this invoice is issued.
	BillToParty *PartyIdentification `json:"billToParty,omitempty"`

	// Total charge amount details for all line items.
	ChargeDetails []*ChargeDetails `json:"chargeDetails"`

	// Date when the invoice/credit note information was generated in the origin's accounting system. The invoice date should be on or after the purchase order creation date.
	// Required: true
	// Format: date-time
	Date *DateTime `json:"date"`

	// Unique number relating to the charges defined in this document. This will be invoice number if the document type is Invoice or CreditNote number if the document type is Credit Note. Failure to provide this reference will result in a rejection.
	// Required: true
	ID *string `json:"id"`

	// Total monetary amount charged in the invoice or full value of credit note to be paid including all relevant taxes. It is the total amount of invoice (including charges, less allowances) before terms discount (if discount is applicable).
	// Required: true
	InvoiceTotal *Money `json:"invoiceTotal"`

	// Identifies the type of invoice.
	// Required: true
	// Enum: [Invoice CreditNote]
	InvoiceType *string `json:"invoiceType"`

	// The list of invoice items.
	Items []*InvoiceItem `json:"items"`

	// The payment terms for the invoice.
	PaymentTerms *PaymentTerms `json:"paymentTerms,omitempty"`

	// An additional unique reference number used for regulatory or other purposes.
	ReferenceNumber string `json:"referenceNumber,omitempty"`

	// Name, address and tax details of the party receiving the payment of this invoice.
	// Required: true
	RemitToParty *PartyIdentification `json:"remitToParty"`

	// Name, address and tax details of the party sending a shipment of products.
	ShipFromParty *PartyIdentification `json:"shipFromParty,omitempty"`

	// Name, address and tax details of the party receiving a shipment of products.
	ShipToParty *PartyIdentification `json:"shipToParty,omitempty"`

	// Total tax amount details for all line items.
	TaxDetails []*TaxDetails `json:"taxDetails"`
}

type InvoiceItem struct {

	// Individual allowance details per line item.
	AllowanceDetails []*AllowanceDetails `json:"allowanceDetails"`

	// Amazon Standard Identification Number (ASIN) of an item.
	AmazonProductIdentifier string `json:"amazonProductIdentifier,omitempty"`

	// Individual charge details per line item.
	ChargeDetails []*ChargeDetails `json:"chargeDetails"`

	// Details required in order to process a credit note. This information is required only if invoiceType is CreditNote.
	CreditNoteDetails *CreditNoteDetails `json:"creditNoteDetails,omitempty"`

	// HSN Tax code. The HSN number cannot contain alphabets.
	HsnCode string `json:"hsnCode,omitempty"`

	// Invoiced quantity of this item. Quantity must be greater than zero.
	// Required: true
	InvoicedQuantity *ItemQuantity `json:"invoicedQuantity"`

	// Unique number related to this line item.
	// Required: true
	ItemSequenceNumber *int64 `json:"itemSequenceNumber"`

	// The item cost to Amazon, which should match the cost on the order. Price information should not be zero or negative. It indicates net unit price. Net cost means VAT is not included in cost.
	// Required: true
	NetCost *Money `json:"netCost"`

	// The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote.
	PurchaseOrderNumber string `json:"purchaseOrderNumber,omitempty"`

	// Individual tax details per line item.
	TaxDetails []*TaxDetails `json:"taxDetails"`

	// The vendor selected product identifier of the item. Should be the same as was provided in the purchase order.
	VendorProductIdentifier string `json:"vendorProductIdentifier,omitempty"`
}

type ItemQuantity struct {

	// Quantity of an item. This value should not be zero.
	// Required: true
	Amount *int64 `json:"amount"`

	// Unit of measure for the quantity.
	// Required: true
	// Enum: [Cases Eaches]
	UnitOfMeasure *string `json:"unitOfMeasure"`

	// The case size, if the unit of measure value is Cases.
	UnitSize int64 `json:"unitSize,omitempty"`
}

type Money struct {

	// amount
	Amount Decimal `json:"amount,omitempty"`

	// Three-digit currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode,omitempty"`
}

type PartyIdentification struct {

	// Identification of the party by address.
	Address *Address `json:"address,omitempty"`

	// Assigned identification for the party.
	// Required: true
	PartyID *string `json:"partyId"`

	// Tax registration details of the party.
	TaxRegistrationDetails []*TaxRegistrationDetails `json:"taxRegistrationDetails"`
}

type PaymentTerms struct {

	// The number of calendar days from the Base date (Invoice date) until the discount is no longer valid.
	DiscountDueDays float64 `json:"discountDueDays,omitempty"`

	// The discount percent value, which is good until the discount due date.
	DiscountPercent Decimal `json:"discountPercent,omitempty"`

	// The number of calendar days from the base date (invoice date) until the total amount on the invoice is due.
	NetDueDays float64 `json:"netDueDays,omitempty"`

	// The payment term type for the invoice.
	// Enum: [Basic EndOfMonth FixedDate Proximo PaymentDueUponReceiptOfInvoice LetterofCredit]
	Type string `json:"type,omitempty"`
}

type SubmitInvoicesRequest struct {

	// invoices
	Invoices []*Invoice `json:"invoices"`
}

type SubmitInvoicesResponse struct {

	// errors
	Errors ErrorList `json:"errors,omitempty"`

	// The response payload for the submitInvoices operation.
	Payload *TransactionID `json:"payload,omitempty"`
}

type TaxDetails struct {

	// Total tax amount applied on invoice total or an item total.
	// Required: true
	TaxAmount *Money `json:"taxAmount"`

	// Tax percentage applied. Percentage must be expressed in decimal.
	TaxRate Decimal `json:"taxRate,omitempty"`

	// Type of the tax applied.
	// Required: true
	// Enum: [CGST SGST CESS UTGST IGST MwSt. PST TVA VAT GST ST Consumption MutuallyDefined DomesticVAT]
	TaxType *string `json:"taxType"`

	// The invoice amount that is taxable at the rate specified in the tax rate field.
	TaxableAmount *Money `json:"taxableAmount,omitempty"`
}

type TaxRegistrationDetails struct {

	// The tax registration number for the entity. For example, VAT ID, Consumption Tax ID.
	// Required: true
	TaxRegistrationNumber *string `json:"taxRegistrationNumber"`

	// The tax registration type for the entity.
	// Required: true
	// Enum: [VAT GST]
	TaxRegistrationType *string `json:"taxRegistrationType"`
}

type TransactionID struct {

	// GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
	TransactionID string `json:"transactionId,omitempty"`
}