Method: AdvancedBilling::ProformaInvoicesController#read_proforma_invoice

Defined in:
lib/advanced_billing/controllers/proforma_invoices_controller.rb

#read_proforma_invoice(proforma_invoice_uid) ⇒ ProformaInvoice

Use this endpoint to read the details of an existing proforma invoice. ## Restrictions Proforma invoices are only available on Relationship Invoicing sites. proforma invoice

Parameters:

  • proforma_invoice_uid (String) —

    Required parameter: The uid of the

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/advanced_billing/controllers/proforma_invoices_controller.rb', line 93

def read_proforma_invoice(proforma_invoice_uid)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/proforma_invoices/{proforma_invoice_uid}.json',
                                 Server::PRODUCTION)
               .template_param(new_parameter(proforma_invoice_uid, key: 'proforma_invoice_uid')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('BasicAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ProformaInvoice.method(:from_hash))
                .local_error_template('404',
                                      'Not Found:\'{$response.body}\'',
                                      APIException))
    .execute
end