invoices_api_model_2024_06_19_models

package
v0.24.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttributeOption 

type AttributeOption struct {

	// The description of the attribute value.
	Description string `json:"description,omitempty"`

	// The possible values for the attribute option.
	Value string `json:"value,omitempty"`
}

AttributeOption The definition of the attribute option.

swagger:model AttributeOption

func (*AttributeOption) ContextValidate 

func (m *AttributeOption) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this attribute option based on context it is used

func (*AttributeOption) MarshalBinary 

func (m *AttributeOption) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AttributeOption) UnmarshalBinary 

func (m *AttributeOption) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AttributeOption) Validate 

func (m *AttributeOption) Validate(formats strfmt.Registry) error

Validate validates this attribute option

type Error 

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"`
}

Error The error response that is returned when the request is unsuccessful.

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorList 

type ErrorList struct {

	// List of errors.
	// Required: true
	Errors []*Error `json:"errors"`
}

ErrorList A list of error responses that are returned when a request is unsuccessful.

swagger:model ErrorList

func (*ErrorList) ContextValidate 

func (m *ErrorList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error list based on the context it is used

func (*ErrorList) MarshalBinary 

func (m *ErrorList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorList) UnmarshalBinary 

func (m *ErrorList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorList) Validate 

func (m *ErrorList) Validate(formats strfmt.Registry) error

Validate validates this error list

type Export 

type Export struct {

	// When the export generation fails, this attribute contains a description of the error.
	ErrorMessage string `json:"errorMessage,omitempty"`

	// The export identifier.
	ExportID string `json:"exportId,omitempty"`

	// The date and time when the export generation finished. Vales are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
	// Format: date-time
	GenerateExportFinishedAt strfmt.DateTime `json:"generateExportFinishedAt,omitempty"`

	// The date and time when the export generation started. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
	// Format: date-time
	GenerateExportStartedAt strfmt.DateTime `json:"generateExportStartedAt,omitempty"`

	// The identifier for the export documents. To get the information required to retrieve the export document's contents, pass each ID in the `getInvoicesDocument` operation.
	//
	// This list is empty until the status is `DONE`.
	InvoicesDocumentIds []string `json:"invoicesDocumentIds"`

	// status
	Status ExportStatus `json:"status,omitempty"`
}

Export Detailed information about the export.

swagger:model Export

func (*Export) ContextValidate 

func (m *Export) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this export based on the context it is used

func (*Export) MarshalBinary 

func (m *Export) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Export) UnmarshalBinary 

func (m *Export) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Export) Validate 

func (m *Export) Validate(formats strfmt.Registry) error

Validate validates this export

type ExportInvoicesRequest 

type ExportInvoicesRequest struct {

	// The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the time of the request.
	// Format: date
	DateEnd strfmt.Date `json:"dateEnd,omitempty"`

	// The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
	// Format: date
	DateStart strfmt.Date `json:"dateStart,omitempty"`

	// The external ID of the invoices you want included in the response.
	ExternalInvoiceID string `json:"externalInvoiceId,omitempty"`

	// file format
	FileFormat FileFormat `json:"fileFormat,omitempty"`

	// The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
	InvoiceType string `json:"invoiceType,omitempty"`

	// The ID of the marketplace from which you want the invoices.
	// Required: true
	MarketplaceID *string `json:"marketplaceId"`

	// The series number of the invoices you want included in the response.
	Series string `json:"series,omitempty"`

	// A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.
	//
	// Min count: 1
	// Min Items: 1
	Statuses []string `json:"statuses"`

	// transaction identifier
	TransactionIdentifier *TransactionIdentifier `json:"transactionIdentifier,omitempty"`

	// The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options
	TransactionType string `json:"transactionType,omitempty"`
}

ExportInvoicesRequest The information required to create the export request. Example: {"dateEnd":"2024-07-30T23:59:59","dateStart":"2024-07-01T00:00:00","externalInvoiceId":"1283743","fileFormat":"XML","invoiceType":"SYMBOLIC_RETURN","marketplaceId":"A2Q3Y263D00KWC","series":"32","statuses":["AUTHORIZED"],"transactionIdentifier":{"id":"94cd4e1a-5cc5-486d-b592-045a95a168e1","name":"BUSINESS_TRANSACTION_ID"},"transactionType":"CUSTOMER_SALES"}

swagger:model ExportInvoicesRequest

func (*ExportInvoicesRequest) ContextValidate 

func (m *ExportInvoicesRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this export invoices request based on the context it is used

func (*ExportInvoicesRequest) MarshalBinary 

func (m *ExportInvoicesRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExportInvoicesRequest) UnmarshalBinary 

func (m *ExportInvoicesRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExportInvoicesRequest) Validate 

func (m *ExportInvoicesRequest) Validate(formats strfmt.Registry) error

Validate validates this export invoices request

type ExportInvoicesResponse 

type ExportInvoicesResponse struct {

	// The export identifier.
	ExportID string `json:"exportId,omitempty"`
}

ExportInvoicesResponse Success.

swagger:model ExportInvoicesResponse

func (*ExportInvoicesResponse) ContextValidate 

func (m *ExportInvoicesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this export invoices response based on context it is used

func (*ExportInvoicesResponse) MarshalBinary 

func (m *ExportInvoicesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExportInvoicesResponse) UnmarshalBinary 

func (m *ExportInvoicesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExportInvoicesResponse) Validate 

func (m *ExportInvoicesResponse) Validate(formats strfmt.Registry) error

Validate validates this export invoices response

type ExportStatus 

type ExportStatus string

ExportStatus The current status of the request.

swagger:model ExportStatus 

const (

	// ExportStatusREQUESTED captures enum value "REQUESTED"
	ExportStatusREQUESTED ExportStatus = "REQUESTED"

	// ExportStatusPROCESSING captures enum value "PROCESSING"
	ExportStatusPROCESSING ExportStatus = "PROCESSING"

	// ExportStatusDONE captures enum value "DONE"
	ExportStatusDONE ExportStatus = "DONE"

	// ExportStatusERROR captures enum value "ERROR"
	ExportStatusERROR ExportStatus = "ERROR"
)

func NewExportStatus 

func NewExportStatus(value ExportStatus) *ExportStatus

func (ExportStatus) ContextValidate 

func (m ExportStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this export status based on context it is used

func (ExportStatus) Pointer 

func (m ExportStatus) Pointer() *ExportStatus

Pointer returns a pointer to a freshly-allocated ExportStatus.

func (ExportStatus) Validate 

func (m ExportStatus) Validate(formats strfmt.Registry) error

Validate validates this export status

type FileFormat 

type FileFormat string

FileFormat Supported invoice file extensions.

swagger:model FileFormat 

const (

	// FileFormatXML captures enum value "XML"
	FileFormatXML FileFormat = "XML"
)

func NewFileFormat 

func NewFileFormat(value FileFormat) *FileFormat

func (FileFormat) ContextValidate 

func (m FileFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this file format based on context it is used

func (FileFormat) Pointer 

func (m FileFormat) Pointer() *FileFormat

Pointer returns a pointer to a freshly-allocated FileFormat.

func (FileFormat) Validate 

func (m FileFormat) Validate(formats strfmt.Registry) error

Validate validates this file format

type GetInvoiceResponse 

type GetInvoiceResponse struct {

	// invoice
	Invoice *Invoice `json:"invoice,omitempty"`
}

GetInvoiceResponse Success.

swagger:model GetInvoiceResponse

func (*GetInvoiceResponse) ContextValidate 

func (m *GetInvoiceResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoice response based on the context it is used

func (*GetInvoiceResponse) MarshalBinary 

func (m *GetInvoiceResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoiceResponse) UnmarshalBinary 

func (m *GetInvoiceResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoiceResponse) Validate 

func (m *GetInvoiceResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoice response

type GetInvoicesAttributesResponse 

type GetInvoicesAttributesResponse struct {

	// invoices attributes
	InvoicesAttributes *InvoicesAttributes `json:"invoicesAttributes,omitempty"`
}

GetInvoicesAttributesResponse Success.

swagger:model GetInvoicesAttributesResponse

func (*GetInvoicesAttributesResponse) ContextValidate 

func (m *GetInvoicesAttributesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoices attributes response based on the context it is used

func (*GetInvoicesAttributesResponse) MarshalBinary 

func (m *GetInvoicesAttributesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoicesAttributesResponse) UnmarshalBinary 

func (m *GetInvoicesAttributesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoicesAttributesResponse) Validate 

func (m *GetInvoicesAttributesResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoices attributes response

type GetInvoicesDocumentResponse 

type GetInvoicesDocumentResponse struct {

	// invoices document
	InvoicesDocument *InvoicesDocument `json:"invoicesDocument,omitempty"`
}

GetInvoicesDocumentResponse Success.

swagger:model GetInvoicesDocumentResponse

func (*GetInvoicesDocumentResponse) ContextValidate 

func (m *GetInvoicesDocumentResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoices document response based on the context it is used

func (*GetInvoicesDocumentResponse) MarshalBinary 

func (m *GetInvoicesDocumentResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoicesDocumentResponse) UnmarshalBinary 

func (m *GetInvoicesDocumentResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoicesDocumentResponse) Validate 

func (m *GetInvoicesDocumentResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoices document response

type GetInvoicesExportResponse 

type GetInvoicesExportResponse struct {

	// export
	Export *Export `json:"export,omitempty"`
}

GetInvoicesExportResponse Success.

swagger:model GetInvoicesExportResponse

func (*GetInvoicesExportResponse) ContextValidate 

func (m *GetInvoicesExportResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoices export response based on the context it is used

func (*GetInvoicesExportResponse) MarshalBinary 

func (m *GetInvoicesExportResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoicesExportResponse) UnmarshalBinary 

func (m *GetInvoicesExportResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoicesExportResponse) Validate 

func (m *GetInvoicesExportResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoices export response

type GetInvoicesExportsResponse 

type GetInvoicesExportsResponse struct {

	// A list of exports.
	// Max Items: 100
	Exports []*Export `json:"exports"`

	// This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters.
	NextToken string `json:"nextToken,omitempty"`
}

GetInvoicesExportsResponse Success.

swagger:model GetInvoicesExportsResponse

func (*GetInvoicesExportsResponse) ContextValidate 

func (m *GetInvoicesExportsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoices exports response based on the context it is used

func (*GetInvoicesExportsResponse) MarshalBinary 

func (m *GetInvoicesExportsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoicesExportsResponse) UnmarshalBinary 

func (m *GetInvoicesExportsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoicesExportsResponse) Validate 

func (m *GetInvoicesExportsResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoices exports response

type GetInvoicesResponse 

type GetInvoicesResponse struct {

	// A list of invoices.
	// Max Items: 100
	Invoices []*Invoice `json:"invoices"`

	// This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters.
	NextToken string `json:"nextToken,omitempty"`
}

GetInvoicesResponse Success.

swagger:model GetInvoicesResponse

func (*GetInvoicesResponse) ContextValidate 

func (m *GetInvoicesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get invoices response based on the context it is used

func (*GetInvoicesResponse) MarshalBinary 

func (m *GetInvoicesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetInvoicesResponse) UnmarshalBinary 

func (m *GetInvoicesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetInvoicesResponse) Validate 

func (m *GetInvoicesResponse) Validate(formats strfmt.Registry) error

Validate validates this get invoices response

type Invoice 

type Invoice struct {

	// The date and time the invoice is issued. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
	// Format: date-time
	Date strfmt.DateTime `json:"date,omitempty"`

	// If the invoice is in an error state, this attribute displays the error code.
	ErrorCode string `json:"errorCode,omitempty"`

	// The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice.
	ExternalInvoiceID string `json:"externalInvoiceId,omitempty"`

	// The response message from the government authority when there is an error during invoice issuance.
	GovResponse string `json:"govResponse,omitempty"`

	// The invoice identifier.
	ID string `json:"id,omitempty"`

	// The classification of the invoice type. This varies across marketplaces. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
	InvoiceType string `json:"invoiceType,omitempty"`

	// Use this identifier in conjunction with `externalInvoiceId` to identify invoices from the same seller.
	Series string `json:"series,omitempty"`

	// The invoice status classification. Use the `getInvoicesAttributes` operation to check invoice status options.
	Status string `json:"status,omitempty"`

	// List with identifiers for the transactions associated to the invoice.
	TransactionIds []*TransactionIdentifier `json:"transactionIds"`

	// Classification of the transaction that originated this invoice. Use the `getInvoicesAttributes` operation to check `transactionType` options.
	TransactionType string `json:"transactionType,omitempty"`
}

Invoice Provides detailed information about an invoice.

swagger:model Invoice

func (*Invoice) ContextValidate 

func (m *Invoice) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this invoice based on the context it is used

func (*Invoice) MarshalBinary 

func (m *Invoice) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Invoice) UnmarshalBinary 

func (m *Invoice) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Invoice) Validate 

func (m *Invoice) Validate(formats strfmt.Registry) error

Validate validates this invoice

type InvoicesAttributes 

type InvoicesAttributes struct {

	// A list of all the options that are available for the invoice status attribute.
	InvoiceStatusOptions []*AttributeOption `json:"invoiceStatusOptions"`

	// A list of all the options that are available for the invoice type attribute.
	InvoiceTypeOptions []*AttributeOption `json:"invoiceTypeOptions"`

	// A list of all the options that are available for the transaction identifier name attribute.
	TransactionIdentifierNameOptions []*AttributeOption `json:"transactionIdentifierNameOptions"`

	// A list of all the options that are available for the transaction type attribute.
	TransactionTypeOptions []*AttributeOption `json:"transactionTypeOptions"`
}

InvoicesAttributes An object that contains the invoice attributes definition.

swagger:model InvoicesAttributes

func (*InvoicesAttributes) ContextValidate 

func (m *InvoicesAttributes) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this invoices attributes based on the context it is used

func (*InvoicesAttributes) MarshalBinary 

func (m *InvoicesAttributes) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InvoicesAttributes) UnmarshalBinary 

func (m *InvoicesAttributes) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InvoicesAttributes) Validate 

func (m *InvoicesAttributes) Validate(formats strfmt.Registry) error

Validate validates this invoices attributes

type InvoicesDocument 

type InvoicesDocument struct {

	// The identifier of the export document.
	InvoicesDocumentID string `json:"invoicesDocumentId,omitempty"`

	// A pre-signed URL that you can use to download the invoices document in zip format. This URL expires after 30 seconds.
	InvoicesDocumentURL string `json:"invoicesDocumentUrl,omitempty"`
}

InvoicesDocument An object that contains the `documentId` and an S3 pre-signed URL that you can use to download the specified file.

swagger:model InvoicesDocument

func (*InvoicesDocument) ContextValidate 

func (m *InvoicesDocument) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this invoices document based on context it is used

func (*InvoicesDocument) MarshalBinary 

func (m *InvoicesDocument) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InvoicesDocument) UnmarshalBinary 

func (m *InvoicesDocument) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InvoicesDocument) Validate 

func (m *InvoicesDocument) Validate(formats strfmt.Registry) error

Validate validates this invoices document

type TransactionIdentifier 

type TransactionIdentifier struct {

	// The transaction identifier.
	ID string `json:"id,omitempty"`

	// The transaction identifier name. Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
	Name string `json:"name,omitempty"`
}

TransactionIdentifier The identifier for a transaction.

swagger:model TransactionIdentifier

func (*TransactionIdentifier) ContextValidate 

func (m *TransactionIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction identifier based on context it is used

func (*TransactionIdentifier) MarshalBinary 

func (m *TransactionIdentifier) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionIdentifier) UnmarshalBinary 

func (m *TransactionIdentifier) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionIdentifier) Validate 

func (m *TransactionIdentifier) Validate(formats strfmt.Registry) error

Validate validates this transaction identifier

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.