REFERÊNCIA DA API

Clientes

Tomadores e destinatários da sua empresa.

GET/customers#

Listar customers

Permissão necessária customers:read

Parâmetros

pagequery · integer

per_pagequery · integer

searchquery · string

tax_numberquery · string

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataarrayobrigatório

data[].company_namestring

data[].tax_numbernullable

data[].ienullable

data[].ie_indicatornullable

data[].imnullable

data[].contact_person_namestring

data[].contact_person_emailstring

O acervo importado pode conter string vazia quando não havia email válido.

data[].contact_person_mobilenullable

data[].addressnullable

data[].idintegerobrigatório

data[].revisionstringobrigatório

data[].customer_codestring

metaobjectobrigatório

meta.pageintegerobrigatório

meta.per_pageintegerobrigatório

meta.totalintegerobrigatório

meta.last_pageintegerobrigatório

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/customers' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

POST/customers#

Criar customers

Permissão necessária customers:write

Parâmetros

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 16 campos

company_namestringobrigatório

tax_numberstringobrigatório

CPF/CNPJ com dígitos verificadores; imutável após criação.

ienullable

ie_indicatorintegerobrigatório

Valores: 1, 2, 9

imnullable

contact_person_namestringobrigatório

contact_person_emailstringobrigatório

contact_person_mobilenullable

addressobject

address.streetstringobrigatório

address.numberstringobrigatório

address.complementnullable

address.districtstringobrigatório

address.zipstringobrigatório

address.city_codeintegerobrigatório

address.country_codeintegerobrigatório

Valores: 1058

Respostas HTTP

201

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.company_namestring

data.tax_numbernullable

data.ienullable

data.ie_indicatornullable

data.imnullable

data.contact_person_namestring

data.contact_person_emailstring

O acervo importado pode conter string vazia quando não havia email válido.

data.contact_person_mobilenullable

data.addressnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.customer_codestring

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/customers' \
  -X POST \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "company_name": "AQUI_VAI_O_VALOR",
  "tax_number": "AQUI_VAI_O_VALOR",
  "ie_indicator": 1,
  "contact_person_name": "AQUI_VAI_O_VALOR",
  "contact_person_email": "[email protected]"
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.

GET/customers/{id}#

Consultar customers

Permissão necessária customers:read

Parâmetros

idpath · integerobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.company_namestring

data.tax_numbernullable

data.ienullable

data.ie_indicatornullable

data.imnullable

data.contact_person_namestring

data.contact_person_emailstring

O acervo importado pode conter string vazia quando não havia email válido.

data.contact_person_mobilenullable

data.addressnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.customer_codestring

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/customers/{id}' \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

PATCH/customers/{id}#

Atualizar customers

Permissão necessária customers:write

Parâmetros

idpath · integerobrigatório

Idempotency-Keyheader · stringobrigatório

UUID obrigatório em POST/PATCH. Mesmo owner/ambiente/chave com operação ou conteúdo diferente retorna 409.

Corpo da requisição application/json · 17 campos

company_namestring

tax_numberstring

CPF/CNPJ com dígitos verificadores; imutável após criação.

ienullable

ie_indicatorinteger

Valores: 1, 2, 9

imnullable

contact_person_namestring

contact_person_emailstring

contact_person_mobilenullable

addressobject

address.streetstringobrigatório

address.numberstringobrigatório

address.complementnullable

address.districtstringobrigatório

address.zipstringobrigatório

address.city_codeintegerobrigatório

address.country_codeintegerobrigatório

Valores: 1058

revisionstringobrigatório

Respostas HTTP

200

Sucesso

Ver campos da resposta

dataobjectobrigatório

data.company_namestring

data.tax_numbernullable

data.ienullable

data.ie_indicatornullable

data.imnullable

data.contact_person_namestring

data.contact_person_emailstring

O acervo importado pode conter string vazia quando não havia email válido.

data.contact_person_mobilenullable

data.addressnullable

data.idintegerobrigatório

data.revisionstringobrigatório

data.customer_codestring

default

Erro seguro; 401/403/404/409/415/422/429/500/503. 429 inclui Retry-After.

Ver campos da resposta

errorobjectobrigatório

error.codestringobrigatório

error.messagestringobrigatório

errorsobject

curl 'https://api.nf3.app/api/v1/customers/{id}' \
  -X PATCH \
  -H 'Authorization: Bearer AQUI_VAI_A_CHAVE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: AQUI_VAI_O_UUID' \
  --data '{
  "revision": "AQUI_VAI_O_VALOR"
}'

Substitua os placeholders no seu servidor. Nenhuma requisição é executada aqui.

Exemplo de estrutura: substitua IDs, valores e UUIDs pelos dados conferidos da sua operação. O portal não executa este código.