Skip to content

InvoicesAPI.md

Latest commit

 

History

History
154 lines (100 loc) · 5.83 KB

InvoicesAPI.md

File metadata and controls

154 lines (100 loc) · 5.83 KB

\InvoicesAPI

All URIs are relative to http://example.com/rest/default

Method HTTP request Description
GetV1Invoices Get /V1/invoices invoices
PostV1Invoices Post /V1/invoices/ invoices/

GetV1Invoices

SalesDataInvoiceSearchResultInterface GetV1Invoices(ctx).SearchCriteriaFilterGroups0Filters0Field(searchCriteriaFilterGroups0Filters0Field).SearchCriteriaFilterGroups0Filters0Value(searchCriteriaFilterGroups0Filters0Value).SearchCriteriaFilterGroups0Filters0ConditionType(searchCriteriaFilterGroups0Filters0ConditionType).SearchCriteriaSortOrders0Field(searchCriteriaSortOrders0Field).SearchCriteriaSortOrders0Direction(searchCriteriaSortOrders0Direction).SearchCriteriaPageSize(searchCriteriaPageSize).SearchCriteriaCurrentPage(searchCriteriaCurrentPage).Execute()

invoices

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/Hevelop/go-client-magento"
)

func main() {
	searchCriteriaFilterGroups0Filters0Field := "searchCriteriaFilterGroups0Filters0Field_example" // string | Field (optional)
	searchCriteriaFilterGroups0Filters0Value := "searchCriteriaFilterGroups0Filters0Value_example" // string | Value (optional)
	searchCriteriaFilterGroups0Filters0ConditionType := "searchCriteriaFilterGroups0Filters0ConditionType_example" // string | Condition type (optional)
	searchCriteriaSortOrders0Field := "searchCriteriaSortOrders0Field_example" // string | Sorting field. (optional)
	searchCriteriaSortOrders0Direction := "searchCriteriaSortOrders0Direction_example" // string | Sorting direction. (optional)
	searchCriteriaPageSize := int32(56) // int32 | Page size. (optional)
	searchCriteriaCurrentPage := int32(56) // int32 | Current page. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InvoicesAPI.GetV1Invoices(context.Background()).SearchCriteriaFilterGroups0Filters0Field(searchCriteriaFilterGroups0Filters0Field).SearchCriteriaFilterGroups0Filters0Value(searchCriteriaFilterGroups0Filters0Value).SearchCriteriaFilterGroups0Filters0ConditionType(searchCriteriaFilterGroups0Filters0ConditionType).SearchCriteriaSortOrders0Field(searchCriteriaSortOrders0Field).SearchCriteriaSortOrders0Direction(searchCriteriaSortOrders0Direction).SearchCriteriaPageSize(searchCriteriaPageSize).SearchCriteriaCurrentPage(searchCriteriaCurrentPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InvoicesAPI.GetV1Invoices``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetV1Invoices`: SalesDataInvoiceSearchResultInterface
	fmt.Fprintf(os.Stdout, "Response from `InvoicesAPI.GetV1Invoices`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetV1InvoicesRequest struct via the builder pattern

Name Type Description Notes
searchCriteriaFilterGroups0Filters0Field string Field
searchCriteriaFilterGroups0Filters0Value string Value
searchCriteriaFilterGroups0Filters0ConditionType string Condition type
searchCriteriaSortOrders0Field string Sorting field.
searchCriteriaSortOrders0Direction string Sorting direction.
searchCriteriaPageSize int32 Page size.
searchCriteriaCurrentPage int32 Current page.

Return type

SalesDataInvoiceSearchResultInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostV1Invoices

SalesDataInvoiceInterface PostV1Invoices(ctx).PostV1InvoicesRequest(postV1InvoicesRequest).Execute()

invoices/

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/Hevelop/go-client-magento"
)

func main() {
	postV1InvoicesRequest := *openapiclient.NewPostV1InvoicesRequest(*openapiclient.NewSalesDataInvoiceInterface(int32(123), float32(123), []openapiclient.SalesDataInvoiceItemInterface{*openapiclient.NewSalesDataInvoiceItemInterface("Sku_example", int32(123), float32(123))})) // PostV1InvoicesRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InvoicesAPI.PostV1Invoices(context.Background()).PostV1InvoicesRequest(postV1InvoicesRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InvoicesAPI.PostV1Invoices``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostV1Invoices`: SalesDataInvoiceInterface
	fmt.Fprintf(os.Stdout, "Response from `InvoicesAPI.PostV1Invoices`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostV1InvoicesRequest struct via the builder pattern

Name Type Description Notes
postV1InvoicesRequest PostV1InvoicesRequest

Return type

SalesDataInvoiceInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]