Sign in
pontos-venda-protected

Create Ponto Venda

Create a new point of sale (protected endpoint).

Performs multi-table transaction:

  • Creates PV record
  • Creates primary address
  • Creates main and financial emails
  • Creates associated Cliente record
  • Creates payment method
  • Subscribes to plan
  • Creates legal act record
  • Uploads document templates
  • Logs audit trail

Requires: Authentication Returns: Created PV object with all details

post/api/pontos-venda/

Headers

x-api-tokenstring nullable

Request body

Nomestring required

Point of sale name

NomeComercialstring nullable

Commercial name

DESIGANCAOstring required

Business name/Designation

Contactostring nullable

Contact phone

NIPCstring required

Tax ID for HQ

NIFstring nullable

Partner tax ID

MORADASEDEstring required

HQ address

CODPOSTSEDEstring nullable

HQ postal code

LOCALIDADESEDEstring nullable

HQ city

MORADAstring nullable

Contact address

CODPOSTstring nullable

Contact postal code

LOCALIDADEstring nullable

Contact city

EMAILstring required

Primary email address

EMAILFINANCEIROstring nullable

Financial email address

NOMESOCstring nullable

Partner/Shareholder name

CCstring nullable

ID card number

VALIDADECCstring nullable

ID card validity date

BANCOstring nullable

Bank name

IBANPRINCIPALstring nullable

Primary IBAN

SWIFTstring nullable

SWIFT code

TokenEasyDatastring nullable

EasyData API token

IDeasydatastring nullable

EasyData ID

PassAppstring nullable

App password

Seriestring nullable

Invoice series code

Scutsboolean nullable

Highway tolls enabled

CRMboolean nullable

CRM enabled

LogoURLstring nullable

Logo URL

plan_idinteger required

Subscription plan ID

metodo_pagamentostring nullable

Payment method

bancoboolean nullable

Is bank payment method

Response

Successful Response

Nomestring nullable

Point of sale name

NomeComercialstring nullable

Commercial name

DESIGANCAOstring nullable

Business name/Designation

Contactostring nullable

Contact phone

NIPCstring nullable

Tax ID for HQ

NIFstring nullable

Partner tax ID

MORADASEDEstring nullable

HQ address

CODPOSTSEDEstring nullable

HQ postal code

LOCALIDADESEDEstring nullable

HQ city

MORADAstring nullable

Contact address

CODPOSTstring nullable

Contact postal code

LOCALIDADEstring nullable

Contact city

EMAILstring nullable

Primary email address

EMAILFINANCEIROstring nullable

Financial email address

NOMESOCstring nullable

Partner/Shareholder name

CCstring nullable

ID card number

VALIDADECCstring nullable

ID card validity date

BANCOstring nullable

Bank name

IBANPRINCIPALstring nullable

Primary IBAN

SWIFTstring nullable

SWIFT code

TokenEasyDatastring nullable

EasyData API token

IDeasydatastring nullable

EasyData ID

PassAppstring nullable

App password

Seriestring nullable

Invoice series code

Scutsboolean nullable

Highway tolls enabled

CRMboolean nullable

CRM enabled

LogoURLstring nullable

Logo URL

IDinteger required

Point of sale ID

IDempresainteger nullable

Company ID

credit_balance_centsinteger

Credit balance in cents

last_billed_atstring date-time nullable

Last billing date

PASSEMAILstring nullable

Email password

IDezdatanumber nullable

EZData ID

Fotostring nullable

Photo URL

Changes

No recorded changes to this endpoint across all 1 revision of this API.