3.1.GET Buscar as faturas de uma unidade V1

O objetivo deste método é permitir que o usuário busque as faturas da unidade, conforme unidade e período informados.

URL

Entrada

Neste serviço o usuário deve informar o id da unidade e o período início e fim das faturas.

• idUnidade

• startDate

• dueDate

Validações

Não se aplica. O sistema retorna conforme os dados informados.

Saída/Retorno

O sistema retorna os ids das faturas da unidade.

Code 200 OK

Response

“`json
[
“guid”,
“guid”,
“guid”,
“guid”
]
“`

3.2.GET Buscar os dados de uma fatura da unidade V1

O objetivo deste método é permitir que o usuário busque os dados de uma fatura.

URL

Entrada

Neste serviço o usuário deve informar o id da unidade e o id da fatura que deseja consultar.

• idUnidade

• billId

Validações

O sistema valida:

• Se a fatura existe para a unidade informada.

Saída/Retorno

O sistema retorna os dados da fatura informada.

Code 200 OK

Response

“`json
{
“BillId”: “guid”,//id da fatura
“ClientId”: “guid”,// id do cliente
“ClientName”: “string”,//nome do cliente
“BillDate”: “string”,//data do faturamento
“BillDueDate”: “string”,//vencimento da fatura
“BillTotal”: numerico, //total da fatura
“ContractNumber”: “string”,//numero do contrato do cliente
“ServiceContracts”: [/serviços da fatura
{
“ServiceId”: int,//id do serviço
“ServiceContractId”: “guid”,
“ServiceContractDescription”: “string”,
“Quantity”: numerico,//quantidade do serviço
“Price”: numerico, //preço do serviço
“UnityPrice”: 0.0000// preço unitário do serviço
},
{
“ServiceId”: int,
“ServiceContractId”: “guid”,
“ServiceContractDescription”: “string”,
“Quantity”: 0.0000,
“Price”: 0.0000,
“UnityPrice”: 0.0000
}
]
“`

—