Skip to content

ReceivedDocumentsAPI.md

Latest commit

 

History

History
1261 lines (832 loc) · 41.5 KB

ReceivedDocumentsAPI.md

File metadata and controls

1261 lines (832 loc) · 41.5 KB

\ReceivedDocumentsAPI

All URIs are relative to https://api-v2.fattureincloud.it

Method HTTP request Description
CreateReceivedDocument Post /c/{company_id}/received_documents Create Received Document
DeleteBinReceivedDocument Delete /c/{company_id}/bin/received_documents/{document_id} Delete Bin Received Document
DeleteReceivedDocument Delete /c/{company_id}/received_documents/{document_id} Delete Received Document
DeleteReceivedDocumentAttachment Delete /c/{company_id}/received_documents/{document_id}/attachment Delete Received Document Attachment
GetBinReceivedDocument Get /c/{company_id}/bin/received_documents/{document_id} Get Bin Received Documents List
GetExistingReceivedDocumentTotals Post /c/{company_id}/received_documents/{document_id}/totals Get Existing Received Document Totals
GetNewReceivedDocumentTotals Post /c/{company_id}/received_documents/totals Get New Received Document Totals
GetPendingReceivedDocument Get /c/{company_id}/received_documents/pending/{document_id} Get Pending Received Document
GetReceivedDocument Get /c/{company_id}/received_documents/{document_id} Get Received Document
GetReceivedDocumentPreCreateInfo Get /c/{company_id}/received_documents/info Get Received Document Pre-Create Info
ListBinReceivedDocuments Get /c/{company_id}/bin/received_documents Get Bin Received Documents List
ListPendingReceivedDocuments Get /c/{company_id}/received_documents/pending List Pending Received Documents
ListReceivedDocuments Get /c/{company_id}/received_documents List Received Documents
ModifyReceivedDocument Put /c/{company_id}/received_documents/{document_id} Modify Received Document
RecoverBinReceivedDocument Post /c/{company_id}/bin/received_documents/{document_id}/recover Recover Received Document From The Bin
UploadReceivedDocumentAttachment Post /c/{company_id}/received_documents/attachment Upload Received Document Attachment

CreateReceivedDocument

CreateReceivedDocumentResponse CreateReceivedDocument(ctx, companyId).CreateReceivedDocumentRequest(createReceivedDocumentRequest).Execute()

Create Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	createReceivedDocumentRequest := *fattureincloud.NewCreateReceivedDocumentRequest() // CreateReceivedDocumentRequest | Document to create (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.CreateReceivedDocument(auth, companyId).CreateReceivedDocumentRequest(createReceivedDocumentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.CreateReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateReceivedDocument`: CreateReceivedDocumentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

createReceivedDocumentRequest | CreateReceivedDocumentRequest | Document to create |

Return type

CreateReceivedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

DeleteBinReceivedDocument

DeleteBinReceivedDocument(ctx, companyId, documentId).Execute()

Delete Bin Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.DeleteBinReceivedDocument(auth, companyId, documentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.DeleteBinReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

DeleteReceivedDocument

DeleteReceivedDocument(ctx, companyId, documentId).Execute()

Delete Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.DeleteReceivedDocument(auth, companyId, documentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.DeleteReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

DeleteReceivedDocumentAttachment

DeleteReceivedDocumentAttachment(ctx, companyId, documentId).Execute()

Delete Received Document Attachment

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.DeleteReceivedDocumentAttachment(auth, companyId, documentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.DeleteReceivedDocumentAttachment``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetBinReceivedDocument

GetBinReceivedDocumentResponse GetBinReceivedDocument(ctx, companyId, documentId).Execute()

Get Bin Received Documents List

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetBinReceivedDocument(auth, companyId, documentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetBinReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetBinReceivedDocument`: GetBinReceivedDocumentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

Return type

GetBinReceivedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetExistingReceivedDocumentTotals

GetExistingReceivedDocumentTotalsResponse GetExistingReceivedDocumentTotals(ctx, companyId, documentId).GetExistingReceivedDocumentTotalsRequest(getExistingReceivedDocumentTotalsRequest).Execute()

Get Existing Received Document Totals

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.
	getExistingReceivedDocumentTotalsRequest := *fattureincloud.NewGetExistingReceivedDocumentTotalsRequest() // GetExistingReceivedDocumentTotalsRequest | Received document. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetExistingReceivedDocumentTotals(auth, companyId, documentId).GetExistingReceivedDocumentTotalsRequest(getExistingReceivedDocumentTotalsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetExistingReceivedDocumentTotals``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetExistingReceivedDocumentTotals`: GetExistingReceivedDocumentTotalsResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

getExistingReceivedDocumentTotalsRequest | GetExistingReceivedDocumentTotalsRequest | Received document. |

Return type

GetExistingReceivedDocumentTotalsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetNewReceivedDocumentTotals

GetNewReceivedDocumentTotalsResponse GetNewReceivedDocumentTotals(ctx, companyId).GetNewReceivedDocumentTotalsRequest(getNewReceivedDocumentTotalsRequest).Execute()

Get New Received Document Totals

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	getNewReceivedDocumentTotalsRequest := *fattureincloud.NewGetNewReceivedDocumentTotalsRequest() // GetNewReceivedDocumentTotalsRequest | Received document. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetNewReceivedDocumentTotals(auth, companyId).GetNewReceivedDocumentTotalsRequest(getNewReceivedDocumentTotalsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetNewReceivedDocumentTotals``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetNewReceivedDocumentTotals`: GetNewReceivedDocumentTotalsResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

getNewReceivedDocumentTotalsRequest | GetNewReceivedDocumentTotalsRequest | Received document. |

Return type

GetNewReceivedDocumentTotalsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetPendingReceivedDocument

GetPendingReceivedDocumentResponse GetPendingReceivedDocument(ctx, companyId, documentId).Fields(fields).Fieldset(fieldset).Execute()

Get Pending Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.
	fields := "fields_example" // string | List of comma-separated fields. (optional)
	fieldset := "fieldset_example" // string | Name of the fieldset. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetPendingReceivedDocument(auth, companyId, documentId).Fields(fields).Fieldset(fieldset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetPendingReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPendingReceivedDocument`: GetPendingReceivedDocumentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

fields | string | List of comma-separated fields. | fieldset | string | Name of the fieldset. |

Return type

GetPendingReceivedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetReceivedDocument

GetReceivedDocumentResponse GetReceivedDocument(ctx, companyId, documentId).Fields(fields).Fieldset(fieldset).Execute()

Get Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.
	fields := "fields_example" // string | List of comma-separated fields. (optional)
	fieldset := "fieldset_example" // string | Name of the fieldset. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetReceivedDocument(auth, companyId, documentId).Fields(fields).Fieldset(fieldset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetReceivedDocument`: GetReceivedDocumentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

fields | string | List of comma-separated fields. | fieldset | string | Name of the fieldset. |

Return type

GetReceivedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

GetReceivedDocumentPreCreateInfo

GetReceivedDocumentPreCreateInfoResponse GetReceivedDocumentPreCreateInfo(ctx, companyId).Type_(type_).Execute()

Get Received Document Pre-Create Info

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	type_ := "type__example" // string | The type of the received document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.GetReceivedDocumentPreCreateInfo(auth, companyId).Type_(type_).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.GetReceivedDocumentPreCreateInfo``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetReceivedDocumentPreCreateInfo`: GetReceivedDocumentPreCreateInfoResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

type_ | string | The type of the received document. |

Return type

GetReceivedDocumentPreCreateInfoResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

ListBinReceivedDocuments

ListBinReceivedDocuments ListBinReceivedDocuments(ctx, companyId).Execute()

Get Bin Received Documents List

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.ListBinReceivedDocuments(auth, companyId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.ListBinReceivedDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListBinReceivedDocuments`: ListBinReceivedDocuments
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

Return type

ListBinReceivedDocuments

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

ListPendingReceivedDocuments

ListPendingReceivedDocumentsResponse ListPendingReceivedDocuments(ctx, companyId).Type_(type_).Fields(fields).Fieldset(fieldset).Sort(sort).Page(page).PerPage(perPage).Q(q).Execute()

List Pending Received Documents

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	type_ := "type__example" // string | The type of the pending received document.
	fields := "fields_example" // string | List of comma-separated fields. (optional)
	fieldset := "fieldset_example" // string | Name of the fieldset. (optional)
	sort := "sort_example" // string | List of comma-separated fields for result sorting (minus for desc sorting). (optional)
	page := int32(56) // int32 | The page to retrieve. (optional) (default to 1)
	perPage := int32(56) // int32 | The size of the page. (optional) (default to 5)
	q := "q_example" // string | Query for filtering the results. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.ListPendingReceivedDocuments(auth, companyId).Type_(type_).Fields(fields).Fieldset(fieldset).Sort(sort).Page(page).PerPage(perPage).Q(q).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.ListPendingReceivedDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListPendingReceivedDocuments`: ListPendingReceivedDocumentsResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

type_ | string | The type of the pending received document. | fields | string | List of comma-separated fields. | fieldset | string | Name of the fieldset. | sort | string | List of comma-separated fields for result sorting (minus for desc sorting). | page | int32 | The page to retrieve. | [default to 1] perPage | int32 | The size of the page. | [default to 5] q | string | Query for filtering the results. |

Return type

ListPendingReceivedDocumentsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

ListReceivedDocuments

ListReceivedDocumentsResponse ListReceivedDocuments(ctx, companyId).Type_(type_).Fields(fields).Fieldset(fieldset).Sort(sort).Page(page).PerPage(perPage).Q(q).Execute()

List Received Documents

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	type_ := "type__example" // string | The type of the received document.
	fields := "fields_example" // string | List of comma-separated fields. (optional)
	fieldset := "fieldset_example" // string | Name of the fieldset. (optional)
	sort := "sort_example" // string | List of comma-separated fields for result sorting (minus for desc sorting). (optional)
	page := int32(56) // int32 | The page to retrieve. (optional) (default to 1)
	perPage := int32(56) // int32 | The size of the page. (optional) (default to 5)
	q := "q_example" // string | Query for filtering the results. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.ListReceivedDocuments(auth, companyId).Type_(type_).Fields(fields).Fieldset(fieldset).Sort(sort).Page(page).PerPage(perPage).Q(q).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.ListReceivedDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListReceivedDocuments`: ListReceivedDocumentsResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

type_ | string | The type of the received document. | fields | string | List of comma-separated fields. | fieldset | string | Name of the fieldset. | sort | string | List of comma-separated fields for result sorting (minus for desc sorting). | page | int32 | The page to retrieve. | [default to 1] perPage | int32 | The size of the page. | [default to 5] q | string | Query for filtering the results. |

Return type

ListReceivedDocumentsResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

ModifyReceivedDocument

ModifyReceivedDocumentResponse ModifyReceivedDocument(ctx, companyId, documentId).ModifyReceivedDocumentRequest(modifyReceivedDocumentRequest).Execute()

Modify Received Document

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.
	modifyReceivedDocumentRequest := *fattureincloud.NewModifyReceivedDocumentRequest() // ModifyReceivedDocumentRequest | Modified document. (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.ModifyReceivedDocument(auth, companyId, documentId).ModifyReceivedDocumentRequest(modifyReceivedDocumentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.ModifyReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ModifyReceivedDocument`: ModifyReceivedDocumentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

modifyReceivedDocumentRequest | ModifyReceivedDocumentRequest | Modified document. |

Return type

ModifyReceivedDocumentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

RecoverBinReceivedDocument

RecoverBinReceivedDocument(ctx, companyId, documentId).Execute()

Recover Received Document From The Bin

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	documentId := int32(56) // int32 | The ID of the document.

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.RecoverBinReceivedDocument(auth, companyId, documentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.RecoverBinReceivedDocument``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.
documentId int32 The ID of the document.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

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

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

UploadReceivedDocumentAttachment

UploadReceivedDocumentAttachmentResponse UploadReceivedDocumentAttachment(ctx, companyId).Filename(filename).Attachment(attachment).Execute()

Upload Received Document Attachment

Example

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	fattureincloudapi "github.com/fattureincloud/fattureincloud-go-sdk/v2/api"
	fattureincloud "github.com/fattureincloud/fattureincloud-go-sdk/v2/model"
)

func main() {
	companyId := int32(12345) // int32 | The ID of the company.
	filename := "filename_example" // string | Attachment file name (optional)
	attachment := os.NewFile(1234, "some_file") // *os.File | Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] (optional)

	auth := context.WithValue(context.Background(), fattureincloudapi.ContextAccessToken, "ACCESS_TOKEN")
	configuration := fattureincloudapi.NewConfiguration()
	apiClient := fattureincloudapi.NewAPIClient(configuration)
	resp, r, err := apiClient.ReceivedDocumentsAPI.UploadReceivedDocumentAttachment(auth, companyId).Filename(filename).Attachment(attachment).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReceivedDocumentsAPI.UploadReceivedDocumentAttachment``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadReceivedDocumentAttachment`: UploadReceivedDocumentAttachmentResponse
	json.NewEncoder(os.Stdout).Encode(resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId int32 The ID of the company.

Other Parameters

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

Name Type Description Notes

filename | string | Attachment file name | attachment | *os.File | Attachment file [.png, .jpg, .gif, .pdf, .zip, .xls, .xlsx, .doc, .docx] |

Return type

UploadReceivedDocumentAttachmentResponse

Authorization

OAuth2AuthenticationCodeFlow

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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