Versions in this module Expand all Collapse all v0 v0.0.1 Mar 24, 2026 Changes in this version + const DefaultClientCredentialsGrantType + const DefaultClientCredentialsScope + const DefaultLegacyClientID + const DefaultLegacyClientSecret + const DefaultLegacyGrantType + const DefaultLegacyScope + const DefaultRefreshTokenGrantType + func IsForbidden(err error) bool + func IsNotFound(err error) bool + func IsRateLimited(err error) bool + func IsServerError(err error) bool + func IsUnauthorized(err error) bool + type APIError struct + Messages []APIMessage + RawBody []byte + StatusCode int + func (e *APIError) Error() string + type APIMessage struct + Code *int + Message string + Type string + type APIResponse struct + DataResponseType *string + ElapsedTime *float64 + Messages []APIMessage + Response T + Success bool + type AccessPointStatus struct + Active bool + InMaintenance bool + Maintenance any + Title string + type AddContractServicesRequest struct + CRMCampaignCode string + CRMPriceListCode string + ContractNumber string + GenerateProportionality bool + NewServices []NewContractService + type AddNoteToSolicitationRequest struct + AssignmentID int + Description string + PersonID int + Title string + type ApproveContractData struct + PersonUsers []any + Proportionalities []ProportionalityItem + type ApproveContractRequest struct + ApprovalDate string + ChangeBeginningDateOnApproval bool + ChangeLoyaltyDateOnApproval bool + ProportionalityType int + type ApproveContractResponse struct + Data ApproveContractData + ElapsedTime float64 + Success bool + type AssignmentReport struct + BeginningDate string + Description string + FinalDate string + type Campaign struct + Code string + Description string + PriceLists []CampaignPriceList + Regions []CampaignRegion + Title string + type CampaignCity struct + Code string + Name string + type CampaignPriceList struct + Code string + Description *string + Products []CampaignPriceListProduct + Title string + type CampaignPriceListProduct struct + Code string + Description *string + Price float64 + Title string + type CampaignRegion struct + Cities []CampaignCity + Code string + Name string + type CancelSaleRequest struct + Description string + ProtocolID int + type ChangeContractServicesRequest struct + CRMCampaignCode string + CRMPriceListCode string + ChangedServices []ContractServiceModification + ContractNumber string + GenerateProportionality bool + type Client struct + func NewClient(cfg Config) (*Client, error) + func (c *Client) AddContractServices(ctx context.Context, req AddContractServicesRequest) (*ContractServiceOperationResult, error) + func (c *Client) AddNoteToSolicitation(ctx context.Context, req AddNoteToSolicitationRequest) (*APIResponse[any], error) + func (c *Client) ApproveContract(ctx context.Context, contractID int, req ApproveContractRequest) (*ApproveContractResponse, error) + func (c *Client) AuthenticateClientCredentials(ctx context.Context, req ClientCredentialsRequest) (*TokenResponse, error) + func (c *Client) AuthenticateLegacy(ctx context.Context, req LegacyAuthRequest) (*TokenResponse, error) + func (c *Client) CancelSale(ctx context.Context, req CancelSaleRequest) (*APIResponse[string], error) + func (c *Client) ChangeContractServices(ctx context.Context, req ChangeContractServicesRequest) (*ContractServiceOperationResult, error) + func (c *Client) CloseSolicitationForAccessPoint(ctx context.Context, integrationCode string) (*APIResponse[any], error) + func (c *Client) CloseSolicitationForClient(ctx context.Context, clientID int) (*APIResponse[any], error) + func (c *Client) ConfirmInvoiceIssuance(ctx context.Context, req ConfirmInvoiceIssuanceRequest) (*APIResponse[any], error) + func (c *Client) ConsultPaymentStatus(ctx context.Context, synGWTransactionID string) (*APIResponse[PaymentStatusResult], error) + func (c *Client) CreateContract(ctx context.Context, req CreateContractRequest) (*CreateContractResponse, error) + func (c *Client) CreateEventualValue(ctx context.Context, req CreateEventualValueRequest) (*APIResponse[any], error) + func (c *Client) CreateLead(ctx context.Context, req CreateLeadRequest) (*APIResponse[any], error) + func (c *Client) CreateSolicitationReport(ctx context.Context, req CreateSolicitationReportRequest) (*APIResponse[any], error) + func (c *Client) DownloadAttachmentFromSolicitation(ctx context.Context, attachmentID, assignmentID int) ([]byte, string, error) + func (c *Client) DownloadContractAttachment(ctx context.Context, attachmentID, contractID int) ([]byte, string, error) + func (c *Client) DownloadDANFE(ctx context.Context, documentID int) ([]byte, string, error) + func (c *Client) GeneratePix(ctx context.Context, receivableID int) (*APIResponse[GeneratePixResult], error) + func (c *Client) GenerateSaleOrder(ctx context.Context, req GenerateSaleOrderRequest) (*APIResponse[any], error) + func (c *Client) GetAccessPointStatusByClient(ctx context.Context, clientID int) (*APIResponse[[]AccessPointStatus], error) + func (c *Client) GetAccessPointStatusByContract(ctx context.Context, contractID int) (*APIResponse[AccessPointStatus], error) + func (c *Client) GetAccessToken() string + func (c *Client) GetAllInvoicesByTxID(ctx context.Context, txID string) (*APIResponse[[]Invoice], error) + func (c *Client) GetCampaignsAndPriceListServices(ctx context.Context) (*APIResponse[[]Campaign], error) + func (c *Client) GetContractTypesAndServices(ctx context.Context) (*APIResponse[[]ContractType], error) + func (c *Client) GetElectronicSignatureByContract(ctx context.Context, contractID int) ([]ElectronicSignatureDocument, error) + func (c *Client) GetInvoicePDF(ctx context.Context, invoiceID int) ([]byte, string, error) + func (c *Client) GetOpenInvoicesByContract(ctx context.Context, contractID int) (*APIResponse[[]ContractBillet], error) + func (c *Client) GetOpenInvoicesByTxID(ctx context.Context, txID string) (*APIResponse[[]Invoice], error) + func (c *Client) GetPersonByTxID(ctx context.Context, txID string) (*APIResponse[PersonDetail], error) + func (c *Client) GetRefreshToken() string + func (c *Client) GetRenegotiationInfo(ctx context.Context, req RenegotiationInfoRequest) (*APIResponse[RenegotiationInfoResult], error) + func (c *Client) IsHoliday(ctx context.Context, req HolidayCheckRequest) (*APIResponse[HolidayCheckResult], error) + func (c *Client) ListCustomers(ctx context.Context, params PaginationParams) (*APIResponse[PagedData[Customer]], error) + func (c *Client) ListDocumentationTypes(ctx context.Context, filter, orderBy string) (*APIResponse[PagedData[DocumentationType]], error) + func (c *Client) ListDocumentsByContract(ctx context.Context, contractNumber string, documentationTypeID int) (*APIResponse[[]ContractDocument], error) + func (c *Client) ListLocations(ctx context.Context, params PaginationParams) (*APIResponse[PagedData[Location]], error) + func (c *Client) MaintainSolicitation(ctx context.Context, req MaintainSolicitationRequest) (*APIResponse[any], error) + func (c *Client) OpenCRMSolicitation(ctx context.Context, req OpenCRMSolicitationRequest) (*APIResponse[any], error) + func (c *Client) OpenDetailedSolicitation(ctx context.Context, req OpenDetailedSolicitationRequest) (*APIResponse[any], error) + func (c *Client) OpenSimpleSolicitation(ctx context.Context, req OpenSimpleSolicitationRequest) (*APIResponse[any], error) + func (c *Client) OpenSolicitationForAccessPoint(ctx context.Context, integrationCode string) (*APIResponse[any], error) + func (c *Client) OpenSolicitationForClient(ctx context.Context, clientID int) (*APIResponse[any], error) + func (c *Client) RefreshToken(ctx context.Context, req RefreshTokenRequest) (*TokenResponse, error) + func (c *Client) RegisterPayment(ctx context.Context, req RegisterPaymentRequest) (*APIResponse[RegisterPaymentResult], error) + func (c *Client) RegisterPerson(ctx context.Context, req RegisterPersonRequest) (*APIResponse[*RegisterPersonResult], error) + func (c *Client) RegisterRenegotiation(ctx context.Context, req RegisterRenegotiationRequest) (*RegisterRenegotiationResult, error) + func (c *Client) RegisterUserTraffic(ctx context.Context, req RegisterUserTrafficRequest) (*TrafficResponse, error) + func (c *Client) RemoveContractServices(ctx context.Context, req RemoveContractServicesRequest) (*ContractServiceOperationResult, error) + func (c *Client) ResendElectronicSignature(ctx context.Context, req ResendSignatureRequest) error + func (c *Client) SetAccessToken(token string) + func (c *Client) SetTokenResponse(tr *TokenResponse) + func (c *Client) StartSale(ctx context.Context, req StartSaleRequest) (*APIResponse[StartSaleResult], error) + func (c *Client) TokenExpiresAt() time.Time + func (c *Client) UnlockContract(ctx context.Context, contractNumber string) (*APIResponse[any], error) + func (c *Client) UpdateConnection(ctx context.Context, connectionID int, req UpdateConnectionRequest) (*APIResponse[bool], error) + func (c *Client) UpdateCustomerAddress(ctx context.Context, clientID int, req UpdateAddressRequest) (*APIResponse[UpdateAddressResult], error) + func (c *Client) UpdatePerson(ctx context.Context, personID int, req UpdatePersonRequest) (*APIResponse[UpdatePersonResult], error) + func (c *Client) UploadAttachmentToContract(ctx context.Context, contractNumber string, documentationTypeCode string, ...) (*APIResponse[any], error) + func (c *Client) UploadAttachmentToSolicitation(ctx context.Context, protocol int, documentationTypeCode string, ...) (*APIResponse[any], error) + func (c *Client) VerifyViability(ctx context.Context, req VerifyViabilityRequest) (*APIResponse[ViabilityResult], error) + type ClientCredentialsRequest struct + ClientID string + ClientSecret string + GrantType string + Scope string + SynData string + type Config struct + APIPort string + APIURL string + AccessToken string + AuthPort string + AuthURL string + BaseURL string + HTTPClient *http.Client + MaxRetries int + RetryWaitMax time.Duration + RetryWaitMin time.Duration + Timeout time.Duration + type ConfirmInvoiceIssuanceRequest struct + AccessKey string + ID string + IssueDate string + type ContractActivationInfo struct + FinancialCollectionTypeCode string + FirstParcelDate string + GroupInMonthlyFee bool + IncidentTypeCode string + PaymentConditionCode string + PaymentFormCode string + type ContractBillet struct + ExpirationDate string + ID int + Link string + Parcel int + PixQRCode string + Title string + TypefulLine string + type ContractClientInfo struct + TxID string + type ContractDocument struct + Description string + DocumentationType string + File string + Title string + Validity struct{ ... } + type ContractInfo struct + CRMCampaignCode string + CRMPriceListCode string + CollectionDay int + CompanyPlaceTxID string + ContractType string + DateManagementCode string + FinancialCollectionTypeCode string + PaymentFormCode string + type ContractIntegratorInfo struct + IntegrationCode string + IntegrationTeamCode string + IntegratorAlias string + type ContractServiceInfo struct + Code string + PaymentFormCode string + Price float64 + Quantity int + type ContractServiceModification struct + OldContractItemID int + type ContractServiceOperationResult struct + Message string + Success bool + type ContractServicePhoneInfo struct + IsPortability bool + PhoneNumber string + PhoneNumberType int + type ContractType struct + Code string + CollectionDays []int + ContractTypesServiceProduct []ContractTypeService + Description string + Title string + type ContractTypeService struct + Code string + Description *string + Title string + type CreateContractRequest struct + ActivationInformation ContractActivationInfo + ClientInformation ContractClientInfo + ContractInformation ContractInfo + IntegratorInformation ContractIntegratorInfo + ServicesInformation []ContractServiceInfo + type CreateContractResponse struct + DataResponseType string + ElapsedTime *float64 + Message *string + Response CreateContractResult + Success bool + type CreateContractResult struct + ActivationAssignment int + ContractNumber string + type CreateEventualValueRequest struct + ContractConfigurationBillingID int + ContractID int + ContractItemID int + Description string + FinalMonthYear string + InitialMonthYear string + MonthYear string + MonthYearType int + PresentInvoiceNote bool + ServiceProductCode string + Type EventualValueType + UnitAmount float64 + Units int + type CreateLeadRequest struct + Address LeadAddress + Contact LeadContact + IntegratorData LeadIntegratorData + PersonalData LeadPersonalData + type CreateSolicitationReportRequest struct + AssignmentID int + Description string + IncidentStatusID int + NotificationTarget int + Priority int + PrivateReport bool + Progress int + Protocol int + type Customer struct + AddressComplement string + AddressReference string + BirthDate *string + Candidate bool + Carrier bool + CellPhone1 string + City string + CivilStatus int + Client bool + CodeCityID int + CodeCountry string + Collaborator bool + Competitor bool + Country string + Email string + EmailNfe string + Expert bool + Gender int + HouseLawyer bool + ID any + Identity string + MunicipalRegistration string + Name string + Name2 string + Neighborhood string + Number string + ParentsName string + PeopleAddressMainID int + Phone string + PostalCode string + Situation int + State string + StateRegistration string + StateRegistrationType int + Status int + Street string + StreetType string + TxID string + TxIDFormatted string + TypeTxID int + UserID int + Vendor bool + type DocumentationType struct + Active bool + Code string + DefaultText string + Description string + ID int + SynSuiteCode *string + Title string + UseType UseTypeItem + type ElectronicSignatureDocument struct + AssignmentID *int + ContractID int + Created string + Description string + ExpirationDate *string + IntegrationCode string + IntegrationType int + IntegrationTypeDescription string + LinkToSign string + PersonID int + PersonName string + SignatureID int + Status string + type EventualValueType int + const EventualValueTypeCredit + const EventualValueTypeDebit + type GeneratePixResult struct + FineAmount float64 + HybridBillet bool + InterestAmount float64 + QRCode string + RegisterID int + TotalAmount float64 + TransactionID string + type GenerateSaleOrderRequest struct + ClientTxID string + CompanyPlaceTxID string + ContractNumber string + FinancialCollectionTypeID string + Items []SaleOrderItem + PaymentConditionID string + PriceListID string + type HolidayCheckRequest struct + City string + Date string + UF string + type HolidayCheckResult struct + City string + Date string + IsHoliday bool + Name string + Scope string + UF string + type Invoice struct + Bank any + Billet InvoiceBillet + Client any + CollectionType any + CompanyPlace any + ID int + Status string + type InvoiceAmount struct + Discount float64 + FinalValue float64 + Fine float64 + Interest float64 + Value float64 + type InvoiceBillet struct + Amount InvoiceAmount + BankTitleNumber *string + Barcode *string + ExpirationDate string + IssueDate string + PixQRCode string + ProcessingDate string + Title string + TypefulLine string + type LeadAddress struct + AddressComplement string + AddressReference string + City string + CodeCityID int + Country string + Neighborhood string + Number string + PostalCode string + State string + Street string + StreetType string + type LeadContact struct + CellPhone string + CellPhoneHasTelegram bool + CellPhoneHasWhatsApp bool + Email string + Phone string + Website string + type LeadIntegratorData struct + CRMContactOriginCode string + CRMFormCode string + IntegrationCode string + IntegrationSellerTxID string + IntegrationTeamCode string + IntegratorAlias string + type LeadPersonalData struct + BirthDate string + CivilStatus *int + Gender *int + Identity string + Name string + Name2 string + ParentsName string + TxID string + TypeTxID int + type LegacyAuthRequest struct + ClientID string + ClientSecret string + GrantType string + Password string + Scope string + SynData string + Username string + type Location struct + City string + Code string + Description string + ID int + Street string + TxID string + TxIDFormatted string + type MaintainSolicitationRequest struct + IncidentTypeCode string + Protocol string + Report string + SolicitationServiceMatrixCode string + type MatrixType int + const MatrixTypeExternal + const MatrixTypeInternal + type NewContractService struct + Code string + ContractServiceTag string + ContractServiceTagDescription string + PaymentFormCode string + PhoneGroupID string + PhoneNumberInformations []ContractServicePhoneInfo + Price float64 + Quantity int + ServiceTagOption int + type OpenCRMSolicitationRequest struct + ContractID int + ContractServiceTagID int + Description string + type OpenDetailedSolicitationRequest struct + Assignment SolicitationAssignment + AuthenticationAccessPointCode string + CatalogServiceID int + CatalogServiceItemClassID int + CatalogServiceItemID int + ClientID int + ContractServiceTagCategory string + ContractServiceTagID int + IncidentStatusID int + IncidentTypeID int + MatrixType MatrixType + PersonID int + ServiceLevelAgreementID int + SolicitationServiceCategory1 string + SolicitationServiceCategory2 string + SolicitationServiceCategory3 string + SolicitationServiceCategory4 string + SolicitationServiceCategory5 string + TeamCode string + type OpenSimpleSolicitationRequest struct + ClientID int + Close bool + ContractID int + ContractServiceTagID int + Description string + type PagedData struct + Data []T + Page int + PageSize int + TotalPages int + TotalRecords int + type PaginationParams struct + Filter string + OrderBy string + Page int + PageSize int + type PaymentStatus struct + Label string + Value int + type PaymentStatusResult struct + IntegratorTransactionID string + Message string + Processed string + Status PaymentStatus + type PersonAddress struct + AddressComplement string + AddressReference string + City string + CodeCityID int + Latitude string + Longitude string + Neighborhood string + Number string + PostalCode string + State string + Street string + StreetType string + type PersonDetail struct + BirthDate string + CellPhone string + Email string + ID int + MainAddress PersonAddress + Name string + Name2 string + Phone string + Status int + Titles []PersonTitle + TxID string + type PersonTitle struct + Billet TitleBillet + ID int + type ProportionalityItem struct + Amount float64 + Competence string + CompetenceType int + Description string + ServiceDescription string + Type int + type RefreshTokenRequest struct + ClientID string + ClientSecret string + GrantType string + RefreshToken string + type RegisterPaymentRequest struct + BankAccountCode string + ClientPaidDate string + FinancialReceivableTitleID int + Message string + PaidAmount float64 + PaymentFormCode string + ReceiptDate string + TransactionID string + type RegisterPaymentResult struct + SynGwTransactionID string + type RegisterPersonRequest struct + AddressComplement string + AddressReference string + City string + Client bool + CodeCityID int + CodeCountry string + Email string + Name string + Neighborhood string + Number string + PostalCode string + Situation int + State string + Street string + StreetType string + TxID string + TypeTxID string + type RegisterPersonResult struct + type RegisterRenegotiationRequest struct + BillingInvoiceAntecipated bool + Discount float64 + FinancialCollectionTypeCode any + Fine float64 + Interest float64 + Observation string + Parcels []RenegotiationParcel + ReceivableIDs []int + type RegisterRenegotiationResult struct + Parcels []RenegotiationResultParcel + type RegisterUserTrafficRequest struct + Date string + Download int64 + TotalDownload int64 + TotalUpload int64 + Upload int64 + User string + type RegisterUserTrafficResult struct + Date string + Download int64 + TotalDownload int64 + TotalUpload int64 + Upload int64 + User string + type RemoveContractItem struct + ContractItem int + type RemoveContractServicesRequest struct + ContractNumber string + RemoveService []RemoveContractItem + type RenegotiationInfoRequest struct + Date string + ReceivableIDs []int + type RenegotiationInfoResult struct + Date string + Receivables []RenegotiationReceivable + TotalFine float64 + TotalInterest float64 + type RenegotiationParcel struct + Amount *float64 + ExpirationDate string + Number int + type RenegotiationReceivable struct + Fine float64 + ID int + Interest float64 + Title string + type RenegotiationResultParcel struct + Amount float64 + ExpirationDate string + ID int + Title string + type ResendSignatureRequest struct + AssignmentID int + DispatchType int + SignatureID int + type SaleOrderItem struct + ID string + Quantity int + UnitValue float64 + type SaleServicePhoneInfo struct + IsPortability bool + PhoneNumber string + PhoneNumberType string + type SaleServiceProduct struct + Amount float64 + Code string + PaymentFormCode string + PhoneGroupID string + PhoneNumberInformations []SaleServicePhoneInfo + Quantity int + type SimpleResponse struct + Messages []APIMessage + Success bool + type SolicitationAssignment struct + BeginningDate string + CompanyPlaceID int + Description string + FinalDate string + Priority int + Report AssignmentReport + Title string + type StartSaleRequest struct + ActivationFinancialCollectionTypeCode string + ActivationFirstParcelDate string + ActivationGroupInMonthlyFee bool + ActivationIncidentTypeCode string + ActivationInformation any + ActivationPaymentConditionCode string + ActivationPaymentFormCode string + CRMCampaignCode string + CRMPriceListCode string + ClientSaleInfo any + CompanyPlaceTxID string + Contacts []any + ContractCollectionDay string + ContractDateManagementCode string + ContractFinancialCollectionTypeCode string + ContractPaymentFormCode string + ContractType string + GainInformation any + IntegratorInformation any + Observations string + ResponsibleSellerTxID string + ServiceProducts []SaleServiceProduct + TeamCode string + ThirdSellerTxID string + TxID string + type StartSaleResult struct + ProtocolID int + type TitleAmount struct + Discount float64 + FinalValue float64 + Fine float64 + Interest float64 + Value float64 + type TitleBillet struct + Amount TitleAmount + Balance float64 + BankTitleNumber *string + ExpirationDate string + IssueDate string + ProcessingDate string + Title string + type TokenResponse struct + AccessToken string + ExpiresIn int + RefreshToken string + TokenType string + type TrafficResponse struct + Data RegisterUserTrafficResult + ElapsedTime float64 + Messages []APIMessage + Success bool + type UpdateAddressRequest struct + City string + Complement string + IBGECode string + ID int + Lat string + Lng string + Neighborhood string + Number string + PeopleAddressID int + PropertyType *string + PublicPlace string + Reference string + State string + ZipCode string + type UpdateAddressResult struct + Message string + PeopleAddressID int + type UpdateConnectionRequest struct + AuthenticationAccessPointID int + AuthenticationSplitterID int + Complement string + EquipmentPassword string + EquipmentSerialNumber string + EquipmentType int + EquipmentUser string + FiberMac string + ID int + IPType int + IsIPoE bool + Mac string + OltID int + Password string + Port int + PortOlt int + ShouldMacUpdate bool + SlotOlt int + TechnologyType int + UpdateConnectionParameter bool + User string + WifiName string + WifiPassword string + type UpdatePersonEmailRequest struct + Email string + EmailNfe string + type UpdatePersonPhoneRequest struct + CellPhone string + CellPhoneHasWhatsapp bool + Phone string + type UpdatePersonRequest struct + Email UpdatePersonEmailRequest + ID int + Phone UpdatePersonPhoneRequest + type UpdatePersonResult struct + Message string + PeopleAddressID int + type UseTypeItem struct + Label string + Value int + type VerifyViabilityRequest struct + Campaign ViabilityCampaign + Distance string + FullAddress ViabilityAddress + Lead ViabilityPerson + Seller ViabilityPerson + type ViabilityAddress struct + Address string + City string + Neighborhood string + Number string + PostalCode string + State string + type ViabilityCampaign struct + Description string + ID string + type ViabilityPerson struct + ID string + Name string + Phone string + TxID string + TxIDType string + type ViabilityResult struct + CTOs int + Ports int + Viability bool
Go to main page