Listagem de outros serviços para facilitar a utilização da API.
Envio de venda completa
URL: /api/nfe
METHOD: POST
Json de Exemplo:
{
"order_type": <>,
"order_number": <>,
"fiscal_operation": <>,
"price_list": <>,
"date_order": <>,
"date_sell": <>,
"date_billed": <>,
"contact_name": <>,
"customer": <>,
"payment_form": <>,
"seller": <>,
"customer_cpf_cnpj": <>,
"supplier": <>,
"supplier_label": <>,
"addition_type": <>,
"addition_percent": <>,
"addition_canceled": <>,
"shipping": <>,
"shipping_brand": <>,
"shipping_transporter": <>,
"shipping_quantity": <>,
"shipping_net_weight": <>,
"shipping_gross_weight": <>,
"shipping_species": <>,
"shipping_price": <>,
"shipping_numeration": <>,
"discount_percent": <>,
"discount_amount": <>,
"indPag": <>,
"ecf_printer": <>,
"ecf_number": <>,
"ccf_number": <>,
"invoice_model": <>,
"note_series": <>,
"emission_date": <>,
"nfe": <>,
"nfe_id": <>,
"nfe_date": <>,
"nfe_danfe": <>,
"nfe_key_dv": <>,
"nfe_key": <>,
"nfe_key_code": <>,
"nfe_nprot": <>,
"nfe_status_msg": <>,
"nfe_nrec": <>,
"nfe_xmotivo": <>,
"nfe_verified": <>,
"nfe_status": <>,
"return_code": <>,
"note_number": <>,
"environment_order": <>,
"resume": <>,
"delivery_time": <>,
"sales_order_ref": <>,
"sales_return_id": <>,
"delivered_order": <>,
"validity": <>,
"canceled": <>,
"inutilized": <>,
"addition_discount_order": <>,
"subtotal": <>,
"discount_type": <>,
"addition_amount": <>,
"other_expenses": <>,
"total": <>,
"change_total": <>,
"pdv_end_dth": <>,
"pdv_ini_dth": <>,
"internal_obs": <>,
"obs": <>,
"ecommerce_id": <>,
"external_sale_number": <>,
"sales_parcels": [{
"parcel": <>,
"payment_form": <>,
"price": <>,
"expiration": <>,
}],
"sales_items": [{
"item_name": <>,
"item_number": <>,
"item_add_info": <>,
"canceled": <>,
"qtd": <>,
"qtd_canceled": <>,
"price_cost": <>,
"grid": <>,
"line_feature": <>,
"column_feature": <>,
"service_id": <>,
"seller_id": <>,
"product_id": <>,
"price_sell": <>,
"item_type": <>,
"round_type": <>,
"total": <>,
"canceled_amount": <>,
"shipping_coupon_prorated": <>,
"expense_coupon_prorated": <>,
"addition_coupon_prorated": <>,
"addition_percent": <>,
"addition_amount": <>,
"discount_type": <>,
"discount_percent": <>,
"discount_coupon_prorated": <>,
"discount_amount": <>,
"price_taxable": <>,
"addition_type": <>,
"item_tax": [{
"fiscal_operation_id": <>,
"cfop": <>,
"cst": <>,
"icms_rate": <>,
"icms_free": <>,
"icms_basis": <>,
"icms_amount": <>,
"icms_canceled": <>,
"icms_addition": <>,
"icms_discount": <>,
"icms_rate_interstate": <>,
"icms_amount_part_orig": <>,
"icms_credit_amount": <>,
"icms_part_orig": <>,
"code_deson_icms": <>,
"icms_st": <>,
"icms_basis_st": <>,
"icms_totalizer": <>,
"icms_credit_rate": <>,
"icms_not_incident": <>,
"icms_part_dest": <>,
"icms_basis_uf_dest": <>,
"icms_rate_uf_dest": <>,
"icms_amount_part_dest": <>,
"icms_rate_fcp_uf_dest": <>,
"icms_amount_fcp_uf_dest": <>,
"iof_rate": <>,
"iof_amount": <>,
"code_cest": <>,
"other_taxes": <>,
"cofins_rate": <>,
"cofins_cst": <>,
"cofins_amount": <>,
"ibpt_amount": <>,
"ibpt_aliquot": <>,
"pis_amount": <>,
"pis_rate": <>,
"pis_cst": <>,
"mva_rate_st": <>,
"issqn_basis": <>,
"chargeability_iss": <>,
"issqn_canceled": <>,
"issqn_rate": <>,
"issqn_st": <>,
"issqn_free": <>,
"issqn_amount": <>,
"issqn_discount": <>,
"issqn_totalizer": <>,
"issqn_addition": <>,
"issqn_not_incident": <>,
"ipi_cst": <>,
"ipi_amount": <>,
"ipi_rate": <>,
"code_enq_ipi": <>,
"nfe_info": <>,
"ii_rate": <>,
"ii_amount": <>,
"csll_rate": <>,
"csll_amount": <>,
"irrf_rate": <>,
"irrf_amount": <>,
"inss_rate": <>,
"inss_amount": <>,
}]
}],
}
Fatura Venda
Este método executa a baixa de estoque, gera comissões, gera fluxo de caixa, baseado na venda.
URL: /api/bill_order
METHOD: POST
Json de Exemplo:
{
"sales_order_id": <>
}
Cancelar Venda
Este método executa o cancelamento de uma venda.
URL: /api/cancel_order
METHOD: POST
Json de Exemplo:
{
"sales_order_id": <>
}
Configurações
Busca todas as configurações, como consumidor final padrão, vendedor padrão, etc.
URL: /api/configuration/all
METHOD: GET
| Nome | Descrição | Formato | Tamanho | Valores Válidos |
|---|---|---|---|---|
| id | Identificador do registro | Inteiro | 11 dígito(s) | |
| key | Chave da configuração | Texto | 255 posições | |
| description | Descrição da configuração | Texto | 255 posições | |
| value | Valor da configuração | Texto | 255 posições |