Skip to main content

API — Impostos

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/taxes

List Tax Rules

Exemplo resposta (200):

[{
"id": 0,
"tenant_id": 0,
"name": "string",
"tax_class": "string",
"rate": "string",
"country": "string",
"is_active": true
}]

POST /api/taxes

Create Tax Rule

Corpo do pedido:

CampoTipoObrigatorioDescricao
namestringSimName
tax_classstringNaoTax Class
rateobjectSimRate
countrystringNaoCountry
is_activebooleanNaoIs Active

Exemplo pedido:

{
"name": "string",
"tax_class": "string",
"rate": null,
"country": "string",
"is_active": true
}

Exemplo resposta (201):

{
"id": 0,
"tenant_id": 0,
"name": "string",
"tax_class": "string",
"rate": "string",
"country": "string",
"is_active": true
}

Erros possiveis: 422 Validation Error


PUT /api/taxes/{tax_id}

Update Tax Rule

Parametros:

NomeTipoObrigatorioDescricao
tax_idintegerSim

Corpo do pedido:

CampoTipoObrigatorioDescricao
nameobjectNaoName
tax_classobjectNaoTax Class
rateobjectNaoRate
countryobjectNaoCountry
is_activeobjectNaoIs Active

Exemplo pedido:

{
"name": null,
"tax_class": null,
"rate": null,
"country": null,
"is_active": null
}

Exemplo resposta (200):

{
"id": 0,
"tenant_id": 0,
"name": "string",
"tax_class": "string",
"rate": "string",
"country": "string",
"is_active": true
}

Erros possiveis: 422 Validation Error


DELETE /api/taxes/{tax_id}

Delete Tax Rule

Parametros:

NomeTipoObrigatorioDescricao
tax_idintegerSim

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error


POST /api/taxes/calculate

Calculate Tax

Corpo do pedido:

CampoTipoObrigatorioDescricao
tax_classstringNaoTax Class
countrystringNaoCountry
amountobjectSimAmount

Exemplo pedido:

{
"tax_class": "string",
"country": "string",
"amount": null
}

Exemplo resposta (200):

{
"tax_class": "string",
"country": "string",
"rate": "string",
"amount": "string",
"tax": "string",
"total": "string"
}

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.