Get Bill By Id

Get Bill By Id

Role-based access control

Required role customerBillStatusRead

REQUEST PATH HAS THE FOLLOWING PROPERTIES:

AttributeTypeDescription
idstringId of bill

Response object has the following properties:

AttributeTypeDescription
_idstringId of bill
valuePaidnumberPaid value of bill
barCodestringBar code
digitableLinestringDigitable line
externalIdstringYour id reference
valuenumberValue of bill
dueDatedateDue Date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ
status.idnumberId of status
status.statusTextstringText of status
customer.namestringCustomer name
customer.documentstringCustomer document(cpf/cnpj)
company._idstringId of company of billing
company.namestringName of company of billing
company.documentstringDocument(CNPJ) of company of billing
createDatedateCreate date, ISO String format YYYY-MM-DDTHH:mm:ss.sssZ

Response status code

statusDescription
200OK
500INTERNAL_SERVER_ERROR
403FORBIDDEN
404NOT_FOUND
Language
Authorization
Bearer
JWT
URL
Click Try It! to start a request and see the response here!